You are here

Home » API reference » Logging and alerts 8 » EmaillogConfigForm.php

class EmaillogConfigForm in Logging and alerts 8

Same name and namespace in other branches
  1. 2.0.x emaillog/src/Form/EmaillogConfigForm.php \Drupal\emaillog\Form\EmaillogConfigForm

Provides a setting UI for emaillog.

Hierarchy

Expanded class hierarchy of EmaillogConfigForm

1 string reference to 'EmaillogConfigForm'
emaillog.routing.yml in emaillog/emaillog.routing.yml
emaillog/emaillog.routing.yml

File

emaillog/src/Form/EmaillogConfigForm.php, line 15

Namespace

Drupal\emaillog\Form
View source 
class EmaillogConfigForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function getEditableConfigNames() {
    return [
      'emaillog.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
    $severity_levels = RfcLogLevel::getLevels();
    $form['emaillog'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Email addresses for each severity level'),
      '#description' => $this
        ->t('Enter an email address for each severity level. For example, you may want to get emergency and critical levels to your pager or mobile phone, while notice level messages can go to a regular email. If you leave the email address blank for a severity level, no email messages will be sent for that severity level.'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    ];
    foreach ($severity_levels as $severity => $level) {
      $key = 'emaillog_' . $severity;
      $form['emaillog'][$key] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Email address for severity %description', [
          '%description' => Unicode::ucfirst($level
            ->render()),
        ]),
        '#default_value' => $this
          ->config('emaillog.settings')
          ->get($key),
        '#description' => $this
          ->t('The email address to send log entries of severity %description to.', [
          '%description' => Unicode::ucfirst($level
            ->render()),
        ]),
      ];
    }
    $form['debug_info'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Additional debug info'),
      '#description' => $this
        ->t('Additional debug information that should be attached to email alerts. Note that this information could be altered by other modules using <em>hook_emaillog_debug_info_alter(&$debug_info)</em>'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#tree' => TRUE,
    ];
    $debug_info_settings = $this
      ->config('emaillog.settings')
      ->get('emaillog_debug_info');
    $status = [];
    foreach (_emaillog_get_debug_info_callbacks() as $debug_info_key => $debug_info_callback) {
      $options[$debug_info_key] = '';
      $form['debug_info']['variable'][$debug_info_key] = [
        '#type' => 'item',
        '#markup' => $debug_info_callback,
      ];
      foreach (array_keys($severity_levels) as $level_id) {

        // Builds arrays for checked boxes for each role.
        if (!empty($debug_info_settings[$level_id][$debug_info_key])) {
          $status[$level_id][] = $debug_info_key;
        }
      }
    }
    foreach ($severity_levels as $level_id => $description) {
      $form['debug_info'][$level_id] = [
        '#title' => $description,
        '#type' => 'checkboxes',
        '#options' => $options,
        '#default_value' => isset($status[$level_id]) ? $status[$level_id] : [],
      ];
    }
    $form['debug_info']['emaillog_backtrace_replace_args'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Replace debug_backtrace() argument values with types'),
      '#description' => $this
        ->t('By default <em>debug_backtrace()</em> will return full variable information in the stack traces that it produces. Variable information can take quite a bit of resources, both while collecting and adding to the alert email, therefore here by default all variable values are replaced with their types only. Warning - unchecking this option could cause your site to crash when it tries to send an alert email with too big stack trace!'),
      '#default_value' => $this
        ->config('emaillog.settings')
        ->get('emaillog_backtrace_replace_args'),
      '#weight' => 1,
    ];
    $form['limits'] = [
      '#type' => 'fieldset',
      '#title' => t('Email sending limits'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $form['limits']['emaillog_max_similar_emails'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Maximum number of allowed consecutive similar email alerts'),
      '#description' => $this
        ->t('Upper limit of email alerts sent consecutively with the same or very similar message. Leave empty for no limit.'),
      '#default_value' => $this
        ->config('emaillog.settings')
        ->get('emaillog_max_similar_emails'),
    ];
    $form['limits']['emaillog_max_consecutive_timespan'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Email alerts should be considered "consecutive" if sent within'),
      '#field_suffix' => $this
        ->t('minutes from each other'),
      '#description' => $this
        ->t('Longest possible period between two email alerts being sent to still be considered consecutive. Leave empty for no limit.'),
      '#default_value' => $this
        ->config('emaillog.settings')
        ->get('emaillog_max_consecutive_timespan'),
    ];
    $form['limits']['emaillog_max_similarity_level'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Maximum allowed similarity level between consecutive email alerts'),
      '#description' => '<p>' . $this
        ->t('Highest similarity level above which new email alerts will not be sent anymore if "Maximum number of allowed consecutive similar email alerts" has been reached and email alerts are considered "consecutive" (time period between each previous and next one is smaller than defined above). Possible values range from 0 to 1, where 1 stands for two identical emails.') . '</p>' . '<p>' . $this
        ->t('For example setting "Maximum number of allowed consecutive similar email alerts" to 5, "Email alerts should be considered consecutive if sent within" to 5 minutes and "Similarity level" to 0.9 would mean that only 5 email alerts would be sent within 5 minutes if Watchdog entries are similar in at least 90%.') . '</p>' . '<p>' . $this
        ->t("(Note that similarity level is calculated using PHP's <a href='@similar_text_url'>similar_text()</a> function, with all its complexity and implications.)", [
        '@similar_text_url' => Url::fromUri('http://php.net/similar_text')
          ->getUri(),
      ]) . '</p>',
      '#default_value' => $this
        ->config('emaillog.settings')
        ->get('emaillog_max_similarity_level'),
    ];
    $form['legacy'] = [
      '#type' => 'fieldset',
      '#title' => t('Legacy settings'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $form['legacy']['emaillog_legacy_subject'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use legacy email subject'),
      '#description' => $this
        ->t('Older versions of this module were using email subject "%subject", while currently it is being set to beginning of Watchdog message. This option allows to switch back to previous version of email subject.', [
        '%subject' => $this
          ->t('[@site_name] @severity_desc: Alert from your web site'),
      ]),
      '#default_value' => $this
        ->config('emaillog.settings')
        ->get('emaillog_legacy_subject'),
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => 'Save Configuration',
    ];
    $form['#theme'] = 'emaillog_admin_settings';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $userInputValues = $form_state
      ->getUserInput();
    if ($userInputValues['emaillog_max_similar_emails'] && !$userInputValues['emaillog_max_similarity_level']) {
      $form_state
        ->setErrorByName('emaillog_max_similarity_level', $this
        ->t('You need to provide value for %field1 field when specifying %field2.', [
        '%field1' => 'Maximum allowed similarity level between consecutive email alerts',
        '%field2' => 'Maximum number of allowed consecutive similar emails',
      ]));
    }
    if ($userInputValues['emaillog_max_similarity_level'] && !$userInputValues['emaillog_max_similar_emails']) {
      $form_state
        ->setErrorByName('emaillog_max_similar_emails', $this
        ->t('You need to provide value for %field1 field when specifying %field2.', [
        '%field1' => 'Maximum number of allowed consecutive similar emails',
        '%field2' => 'Maximum allowed similarity level between consecutive email alerts',
      ]));
    }
    if ($userInputValues['emaillog_max_consecutive_timespan'] && !$userInputValues['emaillog_max_similar_emails']) {
      $form_state
        ->setErrorByName('emaillog_max_similar_emails', $this
        ->t('You need to provide value for %field1 field when specifying %field2.', [
        '%field1' => 'Maximum number of allowed consecutive similar emails',
        '%field2' => 'Email alerts should be considered "consecutive" if sent within',
      ]));
    }
    if ($userInputValues['emaillog_max_consecutive_timespan'] && !$userInputValues['emaillog_max_similarity_level']) {
      $form_state
        ->setErrorByName('emaillog_max_similarity_level', $this
        ->t('You need to provide value for %field1 field when specifying %field2.', [
        '%field1' => 'Maximum allowed similarity level between consecutive email alerts',
        '%field2' => 'Email alerts should be considered "consecutive" if sent within',
      ]));
    }
    if ($userInputValues['emaillog_max_similarity_level']) {
      if (!is_numeric($userInputValues['emaillog_max_similarity_level'])) {
        $form_state
          ->setErrorByName('emaillog_max_similarity_level', $this
          ->t('Value of %field cannot contain any non-numeric characters.', [
          '%field' => 'Maximum allowed similarity level between consecutive email alerts',
        ]));
      }
      if ($userInputValues['emaillog_max_similarity_level'] < 0 || $userInputValues['emaillog_max_similarity_level'] > 1) {
        $form_state
          ->setErrorByName('emaillog_max_similarity_level', $this
          ->t('Value of %field needs to be in [0-1] range.', [
          '%field' => 'Maximum allowed similarity level between consecutive email alerts',
        ]));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $userInputValues = $form_state
      ->getUserInput();
    $config = $this
      ->config('emaillog.settings');
    $severity_levels = RfcLogLevel::getLevels();
    $debug_info = [];
    foreach (array_keys($severity_levels) as $level_id) {
      foreach (array_keys(_emaillog_get_debug_info_callbacks()) as $variable_id) {
        if (!empty($userInputValues['debug_info'][$level_id][$variable_id])) {
          $debug_info[$level_id][$variable_id] = 1;
        }
      }
    }
    foreach (array_keys($severity_levels) as $level_id) {
      $config
        ->set('emaillog_' . $level_id, $userInputValues['emaillog_' . $level_id]);
    }
    $config
      ->set('emaillog_backtrace_replace_args', $userInputValues['debug_info']['emaillog_backtrace_replace_args']);
    $config
      ->set('emaillog_debug_info', $debug_info);
    $config
      ->set('emaillog_max_similar_emails', $userInputValues['emaillog_max_similar_emails']);
    $config
      ->set('emaillog_max_consecutive_timespan', $userInputValues['emaillog_max_consecutive_timespan']);
    $config
      ->set('emaillog_max_similarity_level', $userInputValues['emaillog_max_similarity_level']);
    $config
      ->set('emaillog_legacy_subject', $userInputValues['emaillog_legacy_subject']);
    $config
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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
EmaillogConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
EmaillogConfigForm::getEditableConfigNames public function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
EmaillogConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EmaillogConfigForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
EmaillogConfigForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
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.
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.