You are here

Home » API reference » Purge 8.3 » LoggingConfigForm.php

class LoggingConfigForm in Purge 8.3

Configure logging behavior.

Hierarchy

Expanded class hierarchy of LoggingConfigForm

1 file declares its use of LoggingConfigForm
LoggingConfigFormTest.php in modules/purge_ui/tests/src/Functional/Form/LoggingConfigFormTest.php
1 string reference to 'LoggingConfigForm'
purge_ui.routing.yml in modules/purge_ui/purge_ui.routing.yml
modules/purge_ui/purge_ui.routing.yml

File

modules/purge_ui/src/Form/LoggingConfigForm.php, line 16

Namespace

Drupal\purge_ui\Form
View source 
class LoggingConfigForm extends FormBase {
  use CloseDialogTrait;

  /**
   * The 'purge.logger' service.
   *
   * @var \Drupal\purge\Logger\LoggerServiceInterface
   */
  protected $purgeLogger;

  /**
   * Construct a LoggingConfigForm object.
   *
   * @param \Drupal\purge\Logger\LoggerServiceInterface $purge_logger
   *   Logging services for the purge module and its submodules.
   */
  public final function __construct(LoggerServiceInterface $purge_logger) {
    $this->purgeLogger = $purge_logger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('purge.logger'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'purge_ui.logging_config_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
    $form['msg'] = [
      '#prefix' => '<p>',
      '#suffix' => '</p>',
      '#markup' => $this
        ->t("Purge and modules that integrate with it bundle all log messages into a single channel named <i><code>purge</code></i>.  This configuration form allows you to select what substreams and at which levels are allowed to log."),
    ];

    // Define the table header.
    $form['table'] = [
      '#type' => 'table',
      '#header' => [
        'id' => $this
          ->t('Id'),
      ],
    ];
    foreach (RfcLogLevel::getLevels() as $level => $label) {
      $form['table']['#header']["{$level}"] = $label;
    }

    // Populate the rows and define checkboxes for each severity.
    foreach ($this->purgeLogger
      ->getChannels() as $channel) {
      $form['table'][$channel['id']] = [];
      $form['table'][$channel['id']]['id'] = [
        '#markup' => $channel['id'],
      ];
      foreach (RfcLogLevel::getLevels() as $level => $label) {
        $form['table'][$channel['id']][$level] = [
          '#type' => 'checkbox',
          '#default_value' => in_array($level, $channel['grants']),
        ];
      }
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t("Save"),
      '#weight' => -10,
      '#button_type' => 'primary',
      '#ajax' => [
        'callback' => '::setChannels',
      ],
    ];
    $form['actions']['cancel'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Cancel'),
      '#button_type' => 'danger',
      '#ajax' => [
        'callback' => '::closeDialog',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function setChannels(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $response
      ->addCommand(new CloseModalDialogCommand());
    if (self::submitForm($form, $form_state)) {
      $response
        ->addCommand(new ReloadConfigFormCommand('edit-logging'));
    }
    return $response;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $has_resulted_in_changes = FALSE;
    if (is_array($values = $form_state
      ->getValue('table'))) {
      foreach ($values as $id => $checkboxes) {
        if ($this->purgeLogger
          ->hasChannel($id)) {
          $grants = [];
          foreach ($checkboxes as $severity => $checked) {
            if ($checked === "1") {
              $grants[] = $severity;
            }
          }
          $this->purgeLogger
            ->setChannel($id, $grants);
          if (!$has_resulted_in_changes) {
            $has_resulted_in_changes = TRUE;
          }
        }
      }
    }
    return $has_resulted_in_changes;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CloseDialogTrait::closeDialog public function Respond a CloseModalDialogCommand to close the modal dialog.
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
LoggingConfigForm::$purgeLogger protected property The 'purge.logger' service.
LoggingConfigForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
LoggingConfigForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
LoggingConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LoggingConfigForm::setChannels public function
LoggingConfigForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
LoggingConfigForm::__construct final public function Construct a LoggingConfigForm object.
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.