class LoggerFilterForm in MongoDB 8

Provides the MongoDB logging filter form.

Hierarchy

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

Expanded class hierarchy of LoggerFilterForm

File

src/Form/LoggerFilterForm.php, line 18: Contains \Drupal\mongodb\Form\DblogFilterForm.

Namespace

Drupal\mongodb\Form

View source

class LoggerFilterForm extends FormBase {

  /**
   * @var \Drupal\mongodb\Logger\Logger
   */
  protected $logger;

  /**
   * Constructs a new LoggerFilterForm.
   *
   * @param \Drupal\mongodb\Logger\Logger $logger
   *   The logger service..
   */
  public function __construct(Logger $logger) {
    $this->logger = $logger;
  }

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

    /** @var \Drupal\mongodb\Logger\Logger $logger */
    $logger = $container
      ->get('mongo.logger');
    return new static($logger);
  }

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

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, array &$form_state) {
    if (empty($form_state['values']['type']) && empty($form_state['values']['severity'])) {
      $this
        ->setFormError('type', $form_state, $this
        ->t('You must select something to filter by.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, array &$form_state) {
    $filters = $this
      ->getFilters();
    foreach ($filters as $name => $filter) {
      if (isset($form_state['values'][$name])) {
        $_SESSION['mongodb_watchdog_overview_filter'][$name] = $form_state['values'][$name];
      }
    }
  }

  /**
   * Gets all available filter types.
   *
   * @return array
   *   An array of message type names.
   */
  function getMessageTypes() {

    // As of version 1.0.1, the PHP driver doesn't expose the 'distinct' command.
    $collection = $this->logger
      ->templatesCollection();
    $result = $collection->db
      ->command(array(
      'distinct' => $collection
        ->getName(),
      'key' => 'type',
    ));
    return $result['values'];
  }

  /*
   * List mongodb_watchdog administration filters that can be applied.
   *
   * @return array
   *   A form array
   */
  function getFilters() {
    $filters = array();
    foreach ($this
      ->getMessageTypes() as $type) {
      $types[$type] = $type;
    }
    if (!empty($types)) {
      $filters['type'] = array(
        'title' => t('Type'),
        'options' => $types,
      );
    }
    $filters['severity'] = array(
      'title' => t('Severity'),
      'options' => watchdog_severity_levels(),
    );
    return $filters;
  }

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

  /**
   * Resets the filter form.
   */
  public function resetForm(array &$form, array &$form_state) {
    $_SESSION['mongodb_watchdog_overview_filter'] = array();
  }

}

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.
LoggerFilterForm::$logger	protected	property
LoggerFilterForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
LoggerFilterForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
LoggerFilterForm::getFilters		function
LoggerFilterForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
LoggerFilterForm::getMessageTypes		function	Gets all available filter types.
LoggerFilterForm::resetForm	public	function	Resets the filter form.
LoggerFilterForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
LoggerFilterForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
LoggerFilterForm::__construct	public	function	Constructs a new LoggerFilterForm.
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.
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 LoggerFilterForm in MongoDB 8

Hierarchy

File

Namespace

Members

API Navigation