class ReindexConfirm

Same name in other branches
  1. 9 core/modules/search/src/Form/ReindexConfirm.php \Drupal\search\Form\ReindexConfirm
  2. 8.9.x core/modules/search/src/Form/ReindexConfirm.php \Drupal\search\Form\ReindexConfirm
  3. 11.x core/modules/search/src/Form/ReindexConfirm.php \Drupal\search\Form\ReindexConfirm

Provides the search reindex confirmation form.

@internal

Hierarchy

Expanded class hierarchy of ReindexConfirm

1 string reference to 'ReindexConfirm'
search.routing.yml in core/modules/search/search.routing.yml
core/modules/search/search.routing.yml

File

core/modules/search/src/Form/ReindexConfirm.php, line 14

Namespace

Drupal\search\Form
View source
class ReindexConfirm extends ConfirmFormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'search_reindex_confirm';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Are you sure you want to re-index the site?');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->t("This will re-index content in the search indexes of all active search pages. Searching will continue to work, but new content won't be indexed until all existing content has been re-indexed. This action cannot be undone.");
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Re-index site');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelText() {
        return $this->t('Cancel');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return new Url('entity.search_page.collection');
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        if ($form['confirm']) {
            // Ask each active search page to mark itself for re-index.
            $search_page_repository = \Drupal::service('search.search_page_repository');
            foreach ($search_page_repository->getIndexableSearchPages() as $entity) {
                $entity->getPlugin()
                    ->markForReindex();
            }
            $this->messenger()
                ->addStatus($this->t('All search indexes will be rebuilt.'));
            $form_state->setRedirectUrl($this->getCancelUrl());
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfirmFormBase::buildForm public function Form constructor. Overrides FormInterface::buildForm 26
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 111
FormBase::currentUser protected function Gets the current user. 2
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.
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 57
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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.
ReindexConfirm::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormBase::getCancelText
ReindexConfirm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ReindexConfirm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
ReindexConfirm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
ReindexConfirm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ReindexConfirm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ReindexConfirm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.