You are here

Home » API reference » Organigrams 8.2 » OrganigramsImportD7Form.php

class OrganigramsImportD7Form in Organigrams 8.2

Same name and namespace in other branches
  1. 8 src/Form/OrganigramsImportD7Form.php \Drupal\organigrams\Form\OrganigramsImportD7Form

Provides the settings form for this module.

Hierarchy

Expanded class hierarchy of OrganigramsImportD7Form

1 string reference to 'OrganigramsImportD7Form'
organigrams.routing.yml in ./organigrams.routing.yml
organigrams.routing.yml

File

src/Form/OrganigramsImportD7Form.php, line 15

Namespace

Drupal\organigrams\Form
View source 
class OrganigramsImportD7Form extends FormBase {

  /**
   * Returns a unique string identifying the form.
   *
   * @return string
   *   The unique string identifying the form.
   */
  public function getFormId() {
    return 'organigrams_import_drupal7_form';
  }

  /**
   * Form constructor.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The form structure.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Node templates in JSON.
    $form['organigrams_d7_json'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Drupal 7 organigram JSON'),
      '#description' => '',
      '#required' => TRUE,
      '#rows' => 20,
    ];

    // Group submit handlers in an actions element with a key of "actions".
    $form['actions'] = [
      '#type' => 'actions',
    ];

    // Add a submit button that handles the submission of the form.
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * Validate the JSON.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $organigram = json_decode($form_state
      ->getValue('organigrams_d7_json'));
    if (empty($organigram->organigram)) {
      $form_state
        ->setErrorByName('organigrams_d7_json', $this
        ->t('No organigram found in the JSON.'));
    }
    else {
      $vocabularies = taxonomy_vocabulary_get_names();
      if (isset($vocabularies[$organigram->organigram->machine_name])) {
        $form_state
          ->setErrorByName('organigrams_d7_json', $this
          ->t('An organigram with the machine name "@machine_name" already exists. Change the machine name or remove the existing one to import this organigram.', [
          '@machine_name' => $organigram->organigram->machine_name,
        ]));
      }
    }
  }

  /**
   * Form submission handler.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $organigram = json_decode($form_state
      ->getValue('organigrams_d7_json'));
    $vocabulary = Vocabulary::create([
      'vid' => $organigram->organigram->machine_name,
      'description' => $organigram->organigram->description,
      'name' => $organigram->organigram->name,
    ]);

    // Add a third party setting to indicate this vocabulary is an organigram.
    $vocabulary
      ->setThirdPartySetting('organigrams', 'is_organigram', TRUE);
    $vocabulary
      ->save();
    organigrams_create_term_fields($vocabulary
      ->id());
    if (!empty($organigram->items)) {

      // Create a mapping array for the term ID's.
      $iid_mapping = [];

      // Iterate through the organigram items.
      foreach ($organigram->items as $item) {
        $term_array = [
          'name' => $item->name,
          'vid' => $vocabulary
            ->id(),
          'parent' => $item->parent,
          'weight' => $item->weight,
        ];

        // Convert the old parent to the new parent if possible.
        if (isset($iid_mapping[$item->parent])) {
          $term_array['parent'] = $iid_mapping[$item->parent];
        }
        $ignore_keys = [
          'iid',
          'oid',
          'rdf_mapping',
          'organigrams_machine_name',
          'depth',
        ];
        foreach ($item as $key => $value) {
          if (in_array($key, $ignore_keys)) {
            continue;
          }

          // Change the value of the position to s if it's l or r.
          if ($key == 'position' && in_array($value, [
            'l',
            'r',
          ])) {
            $value = 's';
          }
          $term_array['field_o_' . $key] = $value;
        }

        // Create the term.
        $term = Term::create($term_array);

        // Save the term.
        $term
          ->save();

        // Create mapping for the new term ID to be used as parent.
        $iid_mapping[$item->iid] = $term
          ->id();
      }
    }
    $organigram_link = Link::fromTextAndUrl($organigram->organigram->name, Url::fromUserInput('/admin/structure/taxonomy/manage/' . $organigram->organigram->machine_name . '/overview'));

    // Show message.
    $this
      ->messenger()
      ->addMessage($this
      ->t('Organigram "@name" imported.', [
      '@name' => $organigram_link
        ->toString(),
    ]));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OrganigramsImportD7Form::buildForm public function Form constructor. Overrides FormInterface::buildForm
OrganigramsImportD7Form::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
OrganigramsImportD7Form::submitForm public function Form submission handler. Overrides FormInterface::submitForm
OrganigramsImportD7Form::validateForm public function Validate the JSON. Overrides FormBase::validateForm
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.