SubscriptionSettingsForm.php in Simplenews 3.x

Namespace

Drupal\simplenews\Form

File

src/Form/SubscriptionSettingsForm.php

<?php

namespace Drupal\simplenews\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Configure simplenews subscription settings.
 */
class SubscriptionSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('simplenews.settings');
    $form['subscription_verification'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Verification of anonymous users'),
      '#collapsible' => FALSE,
    ];
    $form['subscription_verification']['simplenews_verification'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Skip email verification (strongly discouraged)'),
      '#default_value' => $config
        ->get('subscription.skip_verification'),
      '#description' => $this
        ->t('Anonymous users are normally required to validate their email address prior to subscribing to a newsletter or changing their subscription details. Skipping this confirmation results in an immediate subscription of an email address to the newsletter without obtaining prior consent from the person who this email address belongs to. SECURITY NOTICE: With this setting enabled, any anonymous user can subscribe or unsubscribe any email address.'),
    ];
    $form['subscription_tidy'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Tidy unconfirmed subscriptions'),
      '#collapsible' => FALSE,
    ];
    $form['subscription_tidy']['simplenews_tidy_unconfirmed'] = [
      '#type' => 'number',
      '#title' => t('Days'),
      '#default_value' => empty($database['port']) ? '' : $database['port'],
      '#min' => 0,
      '#max' => 365,
      '#description' => $this
        ->t('Tidy unconfirmed subscriptions after a number of days (recommended), or zero to skip.'),
      '#default_value' => $config
        ->get('subscription.tidy_unconfirmed'),
    ];
    $form['subscription_mail'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Subscriber emails'),
      '#collapsible' => FALSE,
    ];
    if (\Drupal::moduleHandler()
      ->moduleExists('token')) {
      $form['subscription_mail']['token_help'] = [
        '#title' => $this
          ->t('Replacement patterns'),
        '#type' => 'fieldset',
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      ];
      $form['subscription_mail']['token_help']['browser'] = [
        '#theme' => 'token_tree_link',
        '#token_types' => [
          'simplenews-newsletter',
          'simplenews-subscriber',
        ],
      ];
    }
    $form['subscription_mail']['simplenews_confirm_combined_subject'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Subject text for combined confirmation mail'),
      '#default_value' => $config
        ->get('subscription.confirm_combined_subject'),
    ];
    $form['subscription_mail']['simplenews_confirm_combined_body'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Body text for combined confirmation mail'),
      '#default_value' => $config
        ->get('subscription.confirm_combined_body'),
      '#rows' => 5,
    ];
    $form['subscription_mail']['simplenews_confirm_combined_body_unchanged'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Body text for unchanged combined confirmation mail'),
      '#default_value' => $config
        ->get('subscription.confirm_combined_body_unchanged'),
      '#rows' => 5,
      '#description' => $this
        ->t('This body is used when there are no change requests which have no effect, e.g trying to subscribe when already being subscribed to a newsletter.'),
    ];
    $form['subscription_mail']['simplenews_validate_subject'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Subject text for validation mail'),
      '#default_value' => $config
        ->get('subscription.validate_subject'),
    ];
    $form['subscription_mail']['simplenews_validate_body'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Body text for validation mail'),
      '#default_value' => $config
        ->get('subscription.validate_body'),
      '#rows' => 5,
    ];
    $form['confirm_pages'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Confirmation pages'),
      '#collapsible' => FALSE,
    ];
    $form['confirm_pages']['simplenews_confirm_subscribe_page'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Subscribe confirmation'),
      '#description' => $this
        ->t('Drupal path or URL of the destination page where after the subscription is confirmed (e.g. /node/123). Leave empty to go to the front page.'),
      '#default_value' => $config
        ->get('subscription.confirm_subscribe_page'),
    ];
    $form['confirm_pages']['simplenews_confirm_unsubscribe_page'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Unsubscribe confirmation'),
      '#description' => $this
        ->t('Drupal path or URL of the destination page when the subscription removal is confirmed (e.g. /node/123). Leave empty to go to the front page.'),
      '#default_value' => $config
        ->get('subscription.confirm_unsubscribe_page'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('simplenews.settings')
      ->set('subscription.skip_verification', $form_state
      ->getValue('simplenews_verification'))
      ->set('subscription.tidy_unconfirmed', $form_state
      ->getValue('simplenews_tidy_unconfirmed'))
      ->set('subscription.confirm_combined_subject', $form_state
      ->getValue('simplenews_confirm_combined_subject'))
      ->set('subscription.confirm_combined_body', $form_state
      ->getValue('simplenews_confirm_combined_body'))
      ->set('subscription.confirm_combined_body_unchanged', $form_state
      ->getValue('simplenews_confirm_combined_body_unchanged'))
      ->set('subscription.validate_subject', $form_state
      ->getValue('simplenews_validate_subject'))
      ->set('subscription.validate_body', $form_state
      ->getValue('simplenews_validate_body'))
      ->set('subscription.confirm_subscribe_page', $form_state
      ->getValue('simplenews_confirm_subscribe_page'))
      ->set('subscription.confirm_unsubscribe_page', $form_state
      ->getValue('simplenews_confirm_unsubscribe_page'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Classes

Name	Description
SubscriptionSettingsForm	Configure simplenews subscription settings.