You are here

Home » API reference » Reroute Email 2.x » SettingsForm.php

class SettingsForm in Reroute Email 2.x

Same name and namespace in other branches
  1. 8 src/Form/SettingsForm.php \Drupal\reroute_email\Form\SettingsForm

Implements a settings form for Reroute Email configuration.

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
reroute_email.routing.yml in ./reroute_email.routing.yml
reroute_email.routing.yml

File

src/Form/SettingsForm.php, line 16

Namespace

Drupal\reroute_email\Form
View source 
class SettingsForm extends ConfigFormBase {

  /**
   * An editable config.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $rerouteConfig;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The email validator.
   *
   * @var \Drupal\Component\Utility\EmailValidatorInterface
   */
  protected $emailValidator;

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

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('module_handler'), $container
      ->get('renderer'), $container
      ->get('email.validator'));
  }

  /**
   * Constructs a new object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   * @param \Drupal\Component\Utility\EmailValidatorInterface $email_validator
   *   The email validator.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $module_handler, RendererInterface $renderer, EmailValidatorInterface $email_validator) {
    parent::__construct($config_factory);
    $this->rerouteConfig = $this
      ->config('reroute_email.settings');
    $this->moduleHandler = $module_handler;
    $this->renderer = $renderer;
    $this->emailValidator = $email_validator;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form[REROUTE_EMAIL_ENABLE] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable rerouting'),
      '#default_value' => $this->rerouteConfig
        ->get(REROUTE_EMAIL_ENABLE),
      '#description' => $this
        ->t('Check this box if you want to enable email rerouting. Uncheck to disable rerouting.'),
    ];
    $default_address = $this->rerouteConfig
      ->get(REROUTE_EMAIL_ADDRESS);
    if (NULL === $default_address) {
      $default_address = $this
        ->config('system.site')
        ->get('mail');
    }
    $states = [
      'visible' => [
        ':input[name=' . REROUTE_EMAIL_ENABLE . ']' => [
          'checked' => TRUE,
        ],
      ],
    ];
    $form[REROUTE_EMAIL_ADDRESS] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Rerouting email addresses'),
      '#default_value' => $default_address,
      '#description' => $this
        ->t('Provide a space, comma, or semicolon-delimited list of email addresses.<br/>Every destination email address which is not on "Allowed email addresses" list will be rerouted to these addresses.<br/>If the field is empty and no value is provided, all outgoing emails would be aborted and the email would be recorded in the recent log entries (if enabled).'),
      '#element_validate' => [
        [
          $this,
          'validateFormEmails',
        ],
      ],
      '#states' => $states,
    ];
    $form[REROUTE_EMAIL_ALLOWLIST] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Allowed email addresses'),
      '#default_value' => $this->rerouteConfig
        ->get(REROUTE_EMAIL_ALLOWLIST),
      '#description' => $this
        ->t('Provide a space, comma, or semicolon-delimited list of email addresses to pass through. <br/>Every destination email address which is not on this list will be rerouted.<br/>If the field is empty and no value is provided, all outgoing emails would be rerouted.<br/>We can use wildcard email "*@example.com" to add all emails of the domain to our allowed list.'),
      '#element_validate' => [
        [
          $this,
          'validateFormEmails',
        ],
      ],
      '#states' => $states,
    ];
    $form[REROUTE_EMAIL_DESCRIPTION] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show rerouting description in mail body'),
      '#default_value' => $this->rerouteConfig
        ->get(REROUTE_EMAIL_ALLOWLIST),
      '#description' => $this
        ->t('Check this box if you want a message to be inserted into the email body when the mail is being rerouted. Otherwise, SMTP headers will be used to describe the rerouting. If sending rich-text email, leave this unchecked so that the body of the email will not be disturbed.'),
      '#states' => $states,
    ];
    $form[REROUTE_EMAIL_MESSAGE] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display a Drupal status message after rerouting'),
      '#default_value' => $this->rerouteConfig
        ->get(REROUTE_EMAIL_MESSAGE),
      '#description' => $this
        ->t('Check this box if you would like a Drupal status message to be displayed to users after submitting an email to let them know it was aborted to send or rerouted to a different email address.'),
      '#states' => $states,
    ];

    // Format a list of modules that implement hook_mail.
    $mail_modules = $this->moduleHandler
      ->getImplementations('mail');
    $all_modules = $this->moduleHandler
      ->getModuleList();
    foreach ($mail_modules as $key => $module) {
      $mail_modules[$key] = $this
        ->t("%module's module possible mail keys are `@machine_name`, `@machine_name_%`;", [
        '%module' => isset($all_modules[$module]->info['name']) ? $all_modules[$module]->info['name'] : $module,
        '@machine_name' => $module,
      ]);
    }
    $mail_modules = [
      '#theme' => 'item_list',
      '#items' => $mail_modules,
    ];
    $form['mailkeys'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced settings'),
      '#states' => $states,
      '#open' => $this->rerouteConfig
        ->get(REROUTE_EMAIL_MAILKEYS, '') !== '',
    ];
    $form['mailkeys'][REROUTE_EMAIL_MAILKEYS] = [
      '#title' => $this
        ->t('Filter by mail keys:'),
      '#type' => 'textarea',
      '#rows' => 3,
      '#default_value' => $this->rerouteConfig
        ->get(REROUTE_EMAIL_MAILKEYS, ''),
      '#description' => $this
        ->t('Provide a space, comma, semicolon, or newline-delimited list of message keys to be rerouted. Either module machine name or specific mail key can be used for that.<br/>Only matching messages will be rerouted. If left empty (as default), <strong>all emails will be selected for rerouting</strong>. Here is a list of modules that send emails:<br/>@modules_list Where `%` is one of a specific mail key provided by the module.', [
        '@modules_list' => $this->renderer
          ->render($mail_modules),
      ]),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * Validate multiple email addresses field.
   *
   * @param array $element
   *   A field array to validate.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function validateFormEmails(array $element, FormStateInterface $form_state) {

    // Allow only valid email addresses.
    $addresses = reroute_email_split_string($form_state
      ->getValue($element['#name']));
    foreach ($addresses as $address) {
      if (!$this->emailValidator
        ->isValid($address)) {
        $form_state
          ->setErrorByName($element['#name'], $this
          ->t('@address is not a valid email address.', [
          '@address' => $address,
        ]));
      }
    }

    // Save value in usable way to use as `to` param in drupal_mail.
    // String "email@example.com; ;; , ,," save just as "email@example.com".
    // This will be ignored if any validation errors occur.
    $form_state
      ->setValue($element['#name'], implode(',', $addresses));
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->rerouteConfig
      ->set(REROUTE_EMAIL_ENABLE, $form_state
      ->getValue(REROUTE_EMAIL_ENABLE))
      ->set(REROUTE_EMAIL_ADDRESS, $form_state
      ->getValue(REROUTE_EMAIL_ADDRESS))
      ->set(REROUTE_EMAIL_ALLOWLIST, $form_state
      ->getValue(REROUTE_EMAIL_ALLOWLIST))
      ->set(REROUTE_EMAIL_DESCRIPTION, $form_state
      ->getValue(REROUTE_EMAIL_DESCRIPTION))
      ->set(REROUTE_EMAIL_MESSAGE, $form_state
      ->getValue(REROUTE_EMAIL_MESSAGE))
      ->set(REROUTE_EMAIL_MAILKEYS, $form_state
      ->getValue(REROUTE_EMAIL_MAILKEYS))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
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.
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 72
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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.
SettingsForm::$emailValidator protected property The email validator.
SettingsForm::$moduleHandler protected property The module handler service.
SettingsForm::$renderer protected property The renderer.
SettingsForm::$rerouteConfig protected property An editable config.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::validateFormEmails public function Validate multiple email addresses field.
SettingsForm::__construct public function Constructs a new object. Overrides ConfigFormBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.