You are here

Home » API reference » Disable Messages 8 » DisableMessagesSettingsForm.php

class DisableMessagesSettingsForm in Disable Messages 8

Same name and namespace in other branches
  1. 2.x src/Form/DisableMessagesSettingsForm.php \Drupal\disable_messages\Form\DisableMessagesSettingsForm

Provides a form for administering disable messages.

Hierarchy

Expanded class hierarchy of DisableMessagesSettingsForm

1 string reference to 'DisableMessagesSettingsForm'
disable_messages.routing.yml in ./disable_messages.routing.yml
disable_messages.routing.yml

File

src/Form/DisableMessagesSettingsForm.php, line 12

Namespace

Drupal\disable_messages\Form
View source 
class DisableMessagesSettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Process and save the regular expressions in another variable.
    $patterns = explode("\n", $form_state
      ->getValue('disable_messages_ignore_patterns'));
    $regexps = [];
    $disable_messages_ignore_case = $this
      ->config('disable_messages.settings')
      ->get('disable_messages_ignore_case');
    $ignore_case = $disable_messages_ignore_case == '1' ? 'i' : '';
    foreach ($patterns as $pattern) {
      $pattern = preg_replace([
        '/^\\s*/',
        '/\\s*$/',
      ], '', $pattern);
      $pattern = '/^' . $pattern . '$/' . $ignore_case;
      $regexps[] = $pattern;
    }
    $this
      ->config('disable_messages.settings')
      ->set('disable_messages_enable', $form_state
      ->getValue('disable_messages_enable'))
      ->set('disable_messages_exclude_users', $form_state
      ->getValue('disable_messages_exclude_users'))
      ->set('disable_messages_filter_by_page', $form_state
      ->getValue('disable_messages_filter_by_page'))
      ->set('disable_messages_page_filter_paths', $form_state
      ->getValue('disable_messages_page_filter_paths'))
      ->set('disable_messages_ignore_patterns', $form_state
      ->getValue('disable_messages_ignore_patterns'))
      ->set('disable_messages_ignore_regex', $regexps)
      ->set('disable_messages_enable_debug', $form_state
      ->getValue('disable_messages_enable_debug'))
      ->set('disable_messages_ignore_case', $form_state
      ->getValue('disable_messages_ignore_case'))
      ->set('disable_messages_debug_visible_div', $form_state
      ->getValue('disable_messages_debug_visible_div'))
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = [];
    $form['disable_messages_enable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable filtering'),
      '#default_value' => $this
        ->config('disable_messages.settings')
        ->get('disable_messages_enable'),
      '#description' => $this
        ->t('Uncheck this checkbox to disable all message filtering. If you uncheck this, all messages will be shown to all users and no custom filtering rules will be applied.'),
    ];
    $form['disable_messages_ignore_patterns'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Messages to be disabled'),
      '#description' => $this
        ->t('Enter messages that should not be shown to end users. Regular expressions are supported. You do not have to include the opening and closing forward slashes for the regular expression. The system will automatically add /^ and $/ at the beginning and end of the pattern to ensure that the match is always a full match instead of a partial match. This will help prevent unexpected filtering of messages. So if you want to filter out a specific message ensure that you add the full message including any punctuation and additional HTML if any. Add one per line. See <a href="@PCRE" target="_blank"> PCRE </a> documentation for details on regular expressions.', [
        '@PCRE' => 'https://us3.php.net/manual/en/book.pcre.php',
      ]),
      '#default_value' => $this
        ->config('disable_messages.settings')
        ->get('disable_messages_ignore_patterns'),
    ];
    $form['disable_messages_ignore_case'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Ignore case'),
      '#default_value' => $this
        ->config('disable_messages.settings')
        ->get('disable_messages_ignore_case'),
      '#description' => $this
        ->t('Check this to ignore case while matching the patterns.'),
    ];
    $form['disable_messages_filter_options'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Page and user level filtering options'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $form['disable_messages_filter_options']['role_information'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Filtering by role'),
      '#markup' => $this
        ->t('By default, permission to view all message types are given for all roles. You can change this in <a href="@link" target="_blank">administer permissions</a> to limit the roles which can view a given message type.', [
        '@link' => Url::fromRoute('user.admin_permissions')
          ->toString(),
      ]),
    ];
    $options = [
      $this
        ->t('Apply filters on all pages.'),
      $this
        ->t('Apply filters on every page except the listed pages.'),
      $this
        ->t('Apply filters only on the listed pages.'),
    ];
    $description = $this
      ->t("Enter one page per line as Drupal paths. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %front is the front page.", [
      '%blog' => 'blog',
      '%blog-wildcard' => 'blog/*',
      '%front' => '<front>',
    ]);
    $form['disable_messages_filter_options']['disable_messages_filter_by_page'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Apply filters by page'),
      '#options' => $options,
      '#default_value' => $this
        ->config('disable_messages.settings')
        ->get('disable_messages_filter_by_page'),
    ];
    $form['disable_messages_filter_options']['disable_messages_page_filter_paths'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Pages'),
      '#default_value' => $this
        ->config('disable_messages.settings')
        ->get('disable_messages_page_filter_paths'),
      '#description' => $description,
    ];
    $form['disable_messages_filter_options']['disable_messages_exclude_users'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Users excluded from filtering'),
      '#size' => 40,
      '#default_value' => $this
        ->config('disable_messages.settings')
        ->get('disable_messages_exclude_users'),
      '#description' => $this
        ->t('Comma separated list of user ids to be excluded from any filtering. All messages will be shown to all the listed users irrespective of their permissons to view the corresponding type of message.'),
    ];
    $form['disable_messages_debug'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Debug options'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $form['disable_messages_debug']['disable_messages_enable_debug'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable debug mode'),
      '#default_value' => $this
        ->config('disable_messages.settings')
        ->get('disable_messages_enable_debug'),
      '#description' => $this
        ->t('Check this to enable debug information. The debug information will be shown in an explicitly hidden div sent to the page via $closure. You can use firebug or a similar tool like that to set the visibility of this div or just view source to see the debug information. Safe to use even on production sites.'),
    ];
    $form['disable_messages_debug']['disable_messages_debug_visible_div'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show debug div as visible'),
      '#default_value' => $this
        ->config('disable_messages.settings')
        ->get('disable_messages_debug_visible_div'),
      '#description' => $this
        ->t("Frustrated with having to view source everytime? Don't worry. Enable this to show the debug messages in a visible div. <strong>Remember to disable this on the production sites if you enable debug there :)</strong>."),
    ];
    $form['#submit'][] = 'disable_messages_settings_form_submit';
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    global $_disable_messages_error, $_disable_messages_error_no;
    $patterns = explode("\n", $form_state
      ->getValues()['disable_messages_ignore_patterns']);

    // Override drupal error handler to handle the preg error here.
    set_error_handler('_disable_messages_error_handler');
    foreach ($patterns as $pattern) {
      $pattern = preg_replace([
        '/^\\s*/',
        '/\\s*$/',
      ], '', $pattern);
      try {
        preg_match('/' . $pattern . '/', "This is a test string");
      } catch (\Exception $e) {
      }
      if ($_disable_messages_error) {
        $form_state
          ->setErrorByName('disable_messages_ignore_patterns', $this
          ->t('"@pattern" is not a valid regular expression. Preg error (@error_no) - @error', [
          '@pattern' => $pattern,
          '@error_no' => $_disable_messages_error_no,
          '@error' => $_disable_messages_error,
        ]));
        restore_error_handler();
        return;
      }
    }
  }

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

}

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
DisableMessagesSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
DisableMessagesSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
DisableMessagesSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DisableMessagesSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
DisableMessagesSettingsForm::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.