class MailSettingsForm in Simplenews 3.x

Configure simplenews newsletter settings.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\simplenews\Form\MailSettingsForm

1 string reference to 'MailSettingsForm'

simplenews.routing.yml in ./simplenews.routing.yml

simplenews.routing.yml

File

src/Form/MailSettingsForm.php, line 12

Namespace

Drupal\simplenews\Form

class MailSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('simplenews.settings');
    $form['simplenews_mail_backend']['simplenews_use_cron'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use cron to send newsletters'),
      '#default_value' => $config
        ->get('mail.use_cron'),
      '#description' => $this
        ->t('When checked cron will be used to send newsletters (recommended). Test newsletters and confirmation emails will be sent immediately. Leave unchecked for testing purposes.'),
    ];
    $form['simplenews_mail_backend']['simplenews_textalt'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Generate plain-text alternative'),
      '#default_value' => $config
        ->get('mail.textalt'),
      '#description' => $this
        ->t('Generate plain-text alternative for HTML mails (less recommended). If you are using the recommended Swift Mailer module then disable this option and allow that module to generate them. If you enable this option then you need to configure both "Email: HTML" and "Email: Plain" view modes.'),
    ];
    $throttle_val = [
      1,
      10,
      20,
      50,
      100,
      200,
      500,
      1000,
      2000,
      5000,
      10000,
      20000,
    ];
    $throttle = array_combine($throttle_val, $throttle_val);
    $throttle[SpoolStorageInterface::UNLIMITED] = $this
      ->t('Unlimited');
    if (function_exists('getrusage')) {
      $description_extra = '<br />' . $this
        ->t('Cron execution must not exceed the PHP maximum execution time of %max seconds. You can find the time taken to send emails in the <a href="/admin/reports/dblog">Recent log entries</a>.', [
        '%max' => ini_get('max_execution_time'),
      ]);
    }
    else {
      $description_extra = '<br />' . $this
        ->t('Cron execution must not exceed the PHP maximum execution time of %max seconds.', [
        '%max' => ini_get('max_execution_time'),
      ]);
    }
    $form['simplenews_mail_backend']['simplenews_throttle'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Cron throttle'),
      '#options' => $throttle,
      '#default_value' => $config
        ->get('mail.throttle'),
      '#description' => $this
        ->t('Sets the number of newsletters processed per cron run. Failures and skipped entries count towards the total.') . $description_extra,
    ];
    $form['simplenews_mail_backend']['simplenews_spool_expire'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Mail spool expiration'),
      '#options' => [
        0 => $this
          ->t('Immediate'),
        1 => \Drupal::translation()
          ->formatPlural(1, '1 day', '@count days'),
        7 => \Drupal::translation()
          ->formatPlural(1, '1 week', '@count weeks'),
        14 => \Drupal::translation()
          ->formatPlural(2, '1 week', '@count weeks'),
      ],
      '#default_value' => $config
        ->get('mail.spool_expire'),
      '#description' => $this
        ->t('Controls the duration that messages are retained in the spool after processing. Keeping messages in the spool can be useful for statistics or analysing errors.'),
    ];
    $form['simplenews_mail_backend']['simplenews_debug'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Log emails'),
      '#default_value' => $config
        ->get('mail.debug'),
      '#description' => $this
        ->t('When checked all outgoing simplenews emails are logged in the system log. A logged success does not guarantee delivery. The default PHP mail() function returns success without waiting to check if the mail can be delivered.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('simplenews.settings')
      ->set('mail.use_cron', $form_state
      ->getValue('simplenews_use_cron'))
      ->set('mail.textalt', $form_state
      ->getValue('simplenews_textalt'))
      ->set('mail.source_cache', $form_state
      ->getValue('simplenews_source_cache'))
      ->set('mail.throttle', $form_state
      ->getValue('simplenews_throttle'))
      ->set('mail.spool_expire', $form_state
      ->getValue('simplenews_spool_expire'))
      ->set('mail.debug', $form_state
      ->getValue('simplenews_debug'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	18
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	16
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.
MailSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
MailSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MailSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MailSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.
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.