class OverviewFilterForm in MongoDB 8.2

Provides the MongoDB Watchdog overview filter form.

D8 has no session API, so use of $_SESSION is required, so ignore warnings.

Plugin annotation

@SuppressWarnings("PHPMD.Superglobals");

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\mongodb_watchdog\Form\OverviewFilterForm

Expanded class hierarchy of OverviewFilterForm

1 file declares its use of OverviewFilterForm

OverviewController.php in modules/mongodb_watchdog/src/Controller/OverviewController.php

File

modules/mongodb_watchdog/src/Form/OverviewFilterForm.php, line 20

Namespace

Drupal\mongodb_watchdog\Form

View source

class OverviewFilterForm extends FormBase {
  const SESSION_KEY = 'mongodb_watchdog_overview_filter';

  /**
   * The MongoDB logger service, to load events.
   *
   * @var \Drupal\mongodb_watchdog\Logger
   */
  protected $watchdog;

  /**
   * MongodbWatchdogFilterForm constructor.
   *
   * @param \Drupal\mongodb_watchdog\Logger $watchdog
   *   The MongoDB logger service, to load events.
   */
  public function __construct(Logger $watchdog) {
    $this->watchdog = $watchdog;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $formState) : array {
    $filters = $this
      ->getFilters();
    $form['filters'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Filter log messages'),
      '#open' => TRUE,
    ];
    $sessionFilter = $_SESSION[static::SESSION_KEY] ?? [];
    foreach ($filters as $key => $filter) {
      $form['filters']['status'][$key] = [
        '#title' => $filter['title'],
        '#type' => 'select',
        '#multiple' => TRUE,
        '#size' => 8,
        '#options' => $filter['options'],
      ];
      if (!empty($sessionFilter[$key])) {
        $form['filters']['status'][$key]['#default_value'] = $sessionFilter[$key];
      }
    }
    $form['filters']['actions'] = [
      '#type' => 'actions',
      '#attributes' => [
        'class' => [
          'container-inline',
        ],
      ],
    ];
    $form['filters']['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Filter'),
    ];
    if (!empty($sessionFilter)) {
      $form['filters']['actions']['reset'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Reset'),
        '#limit_validation_errors' => [],
        '#submit' => [
          '::resetForm',
        ],
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : self {

    /** @var \Drupal\mongodb_watchdog\Logger $watchdog */
    $watchdog = $container
      ->get(Logger::SERVICE_LOGGER);
    return new static($watchdog);
  }

  /**
   * Creates a list of database log administration filters that can be applied.
   *
   * @return array
   *   Associative array of filters. The top-level keys are used as the form
   *   element names for the filters, and the values are arrays with the
   *   following elements:
   *   - title: Title of the filter.
   *   - where: The filter condition.
   *   - options: Array of options for the select list for the filter.
   */
  public function getFilters() : array {
    $filters = [];
    foreach ($this->watchdog
      ->templateTypes() as $type) {

      // @codingStandardsIgnoreStart
      $types[$type] = $this
        ->t($type);

      // @codingStandardsIgnoreEnd
    }
    if (!empty($types)) {
      $filters['type'] = [
        'title' => $this
          ->t('Type'),
        'where' => "w.type = ?",
        'options' => $types,
      ];
    }
    $filters['severity'] = [
      'title' => $this
        ->t('Severity'),
      'where' => 'w.severity = ?',
      'options' => RfcLogLevel::getLevels(),
    ];
    return $filters;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'mongodb-watchdog__filter-form';
  }

  /**
   * {@inheritdoc}
   *
   * Parameter $form is needed by FormInterface, so ignore warning.
   *
   * @SuppressWarnings("PMD.UnusedFormalParameter")
   */
  public function submitForm(array &$form, FormStateInterface $formState) : void {
    $filters = array_keys($this
      ->getFilters());
    foreach ($filters as $name) {
      if ($formState
        ->hasValue($name)) {
        $_SESSION[static::SESSION_KEY][$name] = $formState
          ->getValue($name);
      }
    }
  }

  /**
   * Resets the filter form.
   */
  public function resetForm() : void {
    $_SESSION[static::SESSION_KEY] = [];
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $formState) : void {
    if ($formState
      ->isValueEmpty('type') && $formState
      ->isValueEmpty('severity')) {
      $formState
        ->setErrorByName('type', $this
        ->t('You must select something to filter by.'));
    }
  }

}

Members

Name	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.
OverviewFilterForm::$watchdog	protected	property	The MongoDB logger service, to load events.
OverviewFilterForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
OverviewFilterForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
OverviewFilterForm::getFilters	public	function	Creates a list of database log administration filters that can be applied.
OverviewFilterForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
OverviewFilterForm::resetForm	public	function	Resets the filter form.
OverviewFilterForm::SESSION_KEY		constant
OverviewFilterForm::submitForm	public	function	Parameter $form is needed by FormInterface, so ignore warning. Overrides FormInterface::submitForm
OverviewFilterForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
OverviewFilterForm::__construct	public	function	MongodbWatchdogFilterForm constructor.
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.
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.

You are here

class OverviewFilterForm in MongoDB 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation