You are here

Home » API reference » Hierarchical Taxonomy Import 8 » TaxonomyImporterForm.php

class TaxonomyImporterForm in Hierarchical Taxonomy Import 8

Class TaxonomyImporterForm.

Hierarchy

Expanded class hierarchy of TaxonomyImporterForm

1 string reference to 'TaxonomyImporterForm'
hierarchical_taxonomy_importer.routing.yml in ./hierarchical_taxonomy_importer.routing.yml
hierarchical_taxonomy_importer.routing.yml

File

src/Form/TaxonomyImporterForm.php, line 15

Namespace

Drupal\hierarchical_taxonomy_importer\Form
View source 
class TaxonomyImporterForm extends FormBase {

  /**
   * Drupal\Core\Entity\EntityTypeManager definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityTypeManager;

  /**
   * Drupal\hierarchical_taxonomy_importer\services\ImporterService definition.
   *
   * @var \Drupal\hierarchical_taxonomy_importer\services\ImporterService
   */
  protected $hierarchicalTaxonomyImporter;

  /**
   * Constructs a new TaxonomyImporterForm object.
   */
  public function __construct(EntityTypeManager $entity_type_manager, ImporterService $hierarchical_taxonomy_importer_importer) {
    $this->entityTypeManager = $entity_type_manager;
    $this->hierarchicalTaxonomyImporter = $hierarchical_taxonomy_importer_importer;
  }

  /**
   *
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('hierarchical_taxonomy_importer.importer'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'taxonomy_importer_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $output = [
      [
        'Honda',
        '',
        '',
      ],
      [
        '',
        'Honda',
        '',
      ],
      [
        '',
        '',
        '100',
      ],
      [
        '',
        '',
        '200',
      ],
      [
        '',
        '',
        '300',
      ],
      [
        '',
        '',
        '400',
      ],
      [
        '',
        '',
        '500',
      ],
      [
        '',
        'Londa',
        '',
      ],
      [
        '',
        '',
        '600',
      ],
      [
        '',
        '',
        '700',
      ],
      [
        '',
        '',
        '800',
      ],
      [
        '',
        '',
        '900',
      ],
    ];

    // $this->hierarchicalTaxonomyImporter->import('new_test', $output);.
    $form['vocabulary'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Vocabularies'),
      '#description' => $this
        ->t('Select a vocabulary to import taxonomies terms from CSV file.'),
      '#options' => $this
        ->getVocabularies(),
      '#required' => TRUE,
      '#size' => 1,
    ];
    $form['csv_file'] = [
      '#type' => 'file',
      '#title' => $this
        ->t('CSV File'),
      '#description' => $this
        ->t('Upload a CSV file with taxonomy information.'),
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);

    // Getting file array.
    $files = $this
      ->getRequest()->files
      ->get('files', []);

    // Checking if file is uploaded.
    if (!empty($files['csv_file'])) {
      $file_upload = $files['csv_file'];
      if ($file_upload
        ->isValid()) {
        $form_state
          ->setValue('csv_file', $file_upload
          ->getRealPath());
        return;
      }
    }
    $form_state
      ->setErrorByName('csv_file', $this
      ->t('The file could not be uploaded.'));
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $csv_file_path = $form_state
      ->getValue('csv_file');
    if (($handle = fopen($csv_file_path, "r")) !== FALSE) {

      // taxonomy_' . time();
      $vid = $form_state
        ->getValue('vocabulary');
      $output = [];
      while (($data = fgetcsv($handle, 1000, ",")) !== FALSE) {
        $output[] = $data;
      }
      $result = $this->hierarchicalTaxonomyImporter
        ->import($vid, $output);
    }
    drupal_set_message(t('All terms have been imported successfully.'));
  }

  /**
   * This method returns the list of existing vocabularies.
   *
   * @return mixed
   *   List of existing Vocabularies in an associative array's form.
   */
  public function getVocabularies() {
    $output = [];

    // Loading existing vocabularies.
    $vocabularies = Vocabulary::loadMultiple();

    // If vocabularies are not empty then load them to an array one by one
    // Vocabulary ID would be used as offset and label as value of array on that
    // offset.
    if (!empty($vocabularies)) {

      // Traversal of vocabularies is taking place and preparing an options array.
      foreach ($vocabularies as $vocabulary) {
        $output[$vocabulary
          ->id()] = $vocabulary
          ->get('name');
      }
    }

    // Return the output back to the form.
    return $output;
  }

}

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::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.
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.
TaxonomyImporterForm::$entityTypeManager protected property Drupal\Core\Entity\EntityTypeManager definition.
TaxonomyImporterForm::$hierarchicalTaxonomyImporter protected property Drupal\hierarchical_taxonomy_importer\services\ImporterService definition.
TaxonomyImporterForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
TaxonomyImporterForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
TaxonomyImporterForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
TaxonomyImporterForm::getVocabularies public function This method returns the list of existing vocabularies.
TaxonomyImporterForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
TaxonomyImporterForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
TaxonomyImporterForm::__construct public function Constructs a new TaxonomyImporterForm object.
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.