You are here

Home » API reference » Taxonomy Entity Index 8 » TaxonomyEntityIndexAdminReindexForm.php

class TaxonomyEntityIndexAdminReindexForm in Taxonomy Entity Index 8

Provides the reindex form.

Hierarchy

Expanded class hierarchy of TaxonomyEntityIndexAdminReindexForm

1 string reference to 'TaxonomyEntityIndexAdminReindexForm'
taxonomy_entity_index.routing.yml in ./taxonomy_entity_index.routing.yml
taxonomy_entity_index.routing.yml

File

src/Form/TaxonomyEntityIndexAdminReindexForm.php, line 14

Namespace

Drupal\taxonomy_entity_index\Form
View source 
class TaxonomyEntityIndexAdminReindexForm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Creates a TaxonomyEntityIndexAdminReindexForm form.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity manager service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, ConfigFactoryInterface $config_factory) {
    $this->entityTypeManager = $entity_type_manager;
    $this->configFactory = $config_factory;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $entity_types = $this->entityTypeManager
      ->getDefinitions();
    $entity_types_to_index = $this->configFactory
      ->get('taxonomy_entity_index.settings')
      ->get('types');
    foreach ($entity_types as $entity_type_id => $entity_type) {
      if (!is_null($entity_type
        ->getBaseTable()) && $entity_type
        ->entityClassImplements('\\Drupal\\Core\\Entity\\ContentEntityInterface') && in_array($entity_type_id, $entity_types_to_index)) {
        $options[$entity_type_id] = $entity_type
          ->getLabel() . " <em>({$entity_type_id})</em>";
      }
    }
    asort($options);
    $form['description'] = [
      '#markup' => $this
        ->t('<p>Use this form to reindex all terms for the selected entity types.</p>'),
    ];
    $form['types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Entity types'),
      '#options' => $options,
      '#description' => $this
        ->t('Re-index all terms for the selected entity types.'),
      '#required' => TRUE,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Rebuild index'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $types = array_filter($form_state
      ->getValue([
      'types',
    ]));

    // Add an operation for each entity type.
    foreach ($types as $type) {
      $operations[] = [
        'taxonomy_entity_index_reindex_entity_type',
        [
          $type,
        ],
      ];
    }

    // Set a batch operation for each selected entity type.
    $batch = [
      'operations' => $operations,
      'finished' => 'taxonomy_entity_index_reindex_finished',
    ];

    // Execute the batch.
    batch_set($batch);
  }

}

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::$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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
TaxonomyEntityIndexAdminReindexForm::$configFactory protected property The config factory. Overrides FormBase::$configFactory
TaxonomyEntityIndexAdminReindexForm::$entityTypeManager protected property The entity type manager.
TaxonomyEntityIndexAdminReindexForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
TaxonomyEntityIndexAdminReindexForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
TaxonomyEntityIndexAdminReindexForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
TaxonomyEntityIndexAdminReindexForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
TaxonomyEntityIndexAdminReindexForm::__construct public function Creates a TaxonomyEntityIndexAdminReindexForm form.
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.