class PathFilterForm

Same name and namespace in other branches
  1. 9 core/modules/path/src/Form/PathFilterForm.php \Drupal\path\Form\PathFilterForm
  2. 8.9.x core/modules/path/src/Form/PathFilterForm.php \Drupal\path\Form\PathFilterForm
  3. 10 core/modules/path/src/Form/PathFilterForm.php \Drupal\path\Form\PathFilterForm

Provides the path admin overview filter form.

@internal

Hierarchy

Expanded class hierarchy of PathFilterForm

1 file declares its use of PathFilterForm
PathAliasListBuilder.php in core/modules/path/src/PathAliasListBuilder.php

File

core/modules/path/src/Form/PathFilterForm.php, line 13

Namespace

Drupal\path\Form
View source 
class PathFilterForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'path_admin_filter_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, $keys = NULL) {
        $form['#attributes'] = [
            'class' => [
                'search-form',
            ],
        ];
        $form['basic'] = [
            '#type' => 'details',
            '#title' => $this->t('Filter aliases'),
            '#open' => TRUE,
            '#attributes' => [
                'class' => [
                    'container-inline',
                ],
            ],
        ];
        $form['basic']['filter'] = [
            '#type' => 'search',
            '#title' => $this->t('Path alias'),
            '#title_display' => 'invisible',
            '#default_value' => $keys,
            '#maxlength' => 128,
            '#size' => 25,
        ];
        $form['basic']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Filter'),
        ];
        if ($keys) {
            $form['basic']['reset'] = [
                '#type' => 'submit',
                '#value' => $this->t('Reset'),
                '#submit' => [
                    '::resetForm',
                ],
            ];
        }
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $form_state->setRedirect('entity.path_alias.collection', [], [
            'query' => [
                'search' => trim($form_state->getValue('filter')),
            ],
        ]);
    }
    
    /**
     * Resets the filter selections.
     */
    public function resetForm(array &$form, FormStateInterface $form_state) {
        $form_state->setRedirect('entity.path_alias.collection');
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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. 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. 2
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 109
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.
PathFilterForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
PathFilterForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PathFilterForm::resetForm public function Resets the filter selections.
PathFilterForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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.
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.