public function MailSettingsForm::buildForm in Simplenews 8.2

Same name and namespace in other branches

1. 8 src/Form/MailSettingsForm.php \Drupal\simplenews\Form\MailSettingsForm::buildForm()
2. 3.x src/Form/MailSettingsForm.php \Drupal\simplenews\Form\MailSettingsForm::buildForm()

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/MailSettingsForm.php, line 31

Class

MailSettingsForm

Configure simplenews newsletter settings.

Namespace

Drupal\simplenews\Form

Code

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.'),
  ];
  $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);
}