You are here

Home » API reference » Message Subscribe 8 » MessageSubscribeAdminSettings.php

class MessageSubscribeAdminSettings in Message Subscribe 8

Settings form for Message Subscribe.

Hierarchy

Expanded class hierarchy of MessageSubscribeAdminSettings

1 file declares its use of MessageSubscribeAdminSettings
MessageSubscribeAdminSettingsTest.php in tests/src/Kernel/Form/MessageSubscribeAdminSettingsTest.php
1 string reference to 'MessageSubscribeAdminSettings'
message_subscribe.routing.yml in ./message_subscribe.routing.yml
message_subscribe.routing.yml

File

src/Form/MessageSubscribeAdminSettings.php, line 11

Namespace

Drupal\message_subscribe\Form
View source 
class MessageSubscribeAdminSettings extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('message_subscribe.settings');
    foreach ([
      'use_queue',
      'notify_own_actions',
      'flag_prefix',
      'debug_mode',
    ] as $variable) {
      $config
        ->set($variable, $form_state
        ->getValue($variable));
    }
    $config
      ->set('default_notifiers', array_values($form_state
      ->getValue('default_notifiers')));
    $config
      ->save();
  }

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

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

    /** @var \Drupal\Core\Plugin\DefaultPluginManager $message_notifiers */
    $message_notifiers = \Drupal::service('plugin.message_notify.notifier.manager');
    $options = array_map(function ($definition) {
      return $definition['title'];
    }, $message_notifiers
      ->getDefinitions());
    $config = $this
      ->config('message_subscribe.settings');
    $form['default_notifiers'] = [
      '#type' => 'select',
      '#title' => t('Default message notifiers'),
      '#description' => t('Which message notifiers will be added to every subscription.'),
      '#default_value' => $config
        ->get('default_notifiers'),
      '#multiple' => TRUE,
      '#options' => $options,
      '#required' => FALSE,
    ];
    $form['notify_own_actions'] = [
      '#type' => 'checkbox',
      '#title' => t('Notify author of their own submissions'),
      '#description' => t('Determines if the user that caused the message notification receive a message about their actions. e.g. If I add a comment to a node, should I get an email saying I added a comment to a node?'),
      '#default_value' => $config
        ->get('notify_own_actions'),
    ];
    $form['flag_prefix'] = [
      '#type' => 'textfield',
      '#title' => t('Flag prefix'),
      '#description' => t('The prefix that will be used to identify subscription flags. This can be used if you already have flags defined with another prefix e.g. "follow".'),
      '#default_value' => $config
        ->get('flag_prefix'),
      '#required' => FALSE,
    ];
    $form['use_queue'] = [
      '#type' => 'checkbox',
      '#title' => t('Use queue'),
      '#description' => t('Use the queue to process the Messages.'),
      '#default_value' => $config
        ->get('use_queue'),
    ];
    $form['debug_mode'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable debugging mode'),
      '#description' => $this
        ->t('Enables verbose logging of subscription activities for debugging purposes. <strong>This should not be enabled in a production environment.</strong>'),
      '#default_value' => $config
        ->get('debug_mode'),
    ];
    return parent::buildForm($form, $form_state);
  }

}

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