class DblogFilterForm

Same name in other branches
  1. 9 core/modules/dblog/src/Form/DblogFilterForm.php \Drupal\dblog\Form\DblogFilterForm
  2. 10 core/modules/dblog/src/Form/DblogFilterForm.php \Drupal\dblog\Form\DblogFilterForm
  3. 11.x core/modules/dblog/src/Form/DblogFilterForm.php \Drupal\dblog\Form\DblogFilterForm

Provides the database logging filter form.

@internal

Hierarchy

Expanded class hierarchy of DblogFilterForm

File

core/modules/dblog/src/Form/DblogFilterForm.php, line 13

Namespace

Drupal\dblog\Form
View source
class DblogFilterForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'dblog_filter_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $filters = dblog_filters();
        $form['filters'] = [
            '#type' => 'details',
            '#title' => $this->t('Filter log messages'),
            '#open' => TRUE,
        ];
        foreach ($filters as $key => $filter) {
            $form['filters']['status'][$key] = [
                '#title' => $filter['title'],
                '#type' => 'select',
                '#multiple' => TRUE,
                '#size' => 8,
                '#options' => $filter['options'],
            ];
            if (!empty($_SESSION['dblog_overview_filter'][$key])) {
                $form['filters']['status'][$key]['#default_value'] = $_SESSION['dblog_overview_filter'][$key];
            }
        }
        $form['filters']['actions'] = [
            '#type' => 'actions',
            '#attributes' => [
                'class' => [
                    'container-inline',
                ],
            ],
        ];
        $form['filters']['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Filter'),
        ];
        if (!empty($_SESSION['dblog_overview_filter'])) {
            $form['filters']['actions']['reset'] = [
                '#type' => 'submit',
                '#value' => $this->t('Reset'),
                '#limit_validation_errors' => [],
                '#submit' => [
                    '::resetForm',
                ],
            ];
        }
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        if ($form_state->isValueEmpty('type') && $form_state->isValueEmpty('severity')) {
            $form_state->setErrorByName('type', $this->t('You must select something to filter by.'));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $filters = dblog_filters();
        foreach ($filters as $name => $filter) {
            if ($form_state->hasValue($name)) {
                $_SESSION['dblog_overview_filter'][$name] = $form_state->getValue($name);
            }
        }
    }
    
    /**
     * Resets the filter form.
     *
     * @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 resetForm(array &$form, FormStateInterface $form_state) {
        $_SESSION['dblog_overview_filter'] = [];
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DblogFilterForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
DblogFilterForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DblogFilterForm::resetForm public function Resets the filter form.
DblogFilterForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DblogFilterForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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. 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 105
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
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.
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.

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