public function NewsletterForm::form in Simplenews 3.x

Same name and namespace in other branches

1. 8.2 src/Form/NewsletterForm.php \Drupal\simplenews\Form\NewsletterForm::form()
2. 8 src/Form/NewsletterForm.php \Drupal\simplenews\Form\NewsletterForm::form()

Overrides Drupal\Core\Entity\EntityForm::form().

Overrides EntityForm::form

File

src/Form/NewsletterForm.php, line 17

Class

NewsletterForm

Base form for category edit forms.

Namespace

Drupal\simplenews\Form

Code

public function form(array $form, FormStateInterface $form_state) {
  $form = parent::form($form, $form_state);
  $newsletter = $this->entity;
  $form['name'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Name'),
    '#maxlength' => 255,
    '#default_value' => $newsletter
      ->label(),
    '#description' => $this
      ->t("The newsletter name."),
    '#required' => TRUE,
  ];
  $form['id'] = [
    '#type' => 'machine_name',
    '#default_value' => $newsletter
      ->id(),
    '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
    '#machine_name' => [
      'exists' => [
        'Drupal\\simplenews\\Entity\\Newsletter',
        'load',
      ],
      'source' => [
        'name',
      ],
    ],
    '#disabled' => !$newsletter
      ->isNew(),
  ];
  $form['description'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Description'),
    '#default_value' => $newsletter->description,
    '#description' => $this
      ->t("A description of the newsletter."),
  ];
  $links = [
    ':mime_mail_url' => 'http://drupal.org/project/mimemail',
    ':html_url' => 'http://drupal.org/project/htmlmail',
  ];
  $description = $this
    ->t('Newsletter format. Install <a href=":mime_mail_url">Mime Mail</a> module or <a href=":html_url">HTML Mail</a> module to send newsletters in HTML format.', $links);
  $form['weight'] = [
    '#type' => 'hidden',
    '#value' => $newsletter->weight,
  ];
  $form['subscription'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Subscription settings'),
    '#collapsible' => FALSE,
  ];

  // Allowed recipient handlers.
  $options = \Drupal::service('plugin.manager.simplenews_recipient_handler')
    ->getOptions();
  $form['subscription']['allowed_handlers'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Allowed recipient handlers'),
    '#options' => $options,
    '#default_value' => $newsletter->allowed_handlers,
    '#description' => $this
      ->t('Restrict which recipient handlers are allowed when using this newsletter.  If none are selected, then all of them will be available.'),
    '#access' => count($options) > 1,
  ];

  // Subscribe at account registration time.
  $options = simplenews_new_account_options();
  $form['subscription']['new_account'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Subscribe new account'),
    '#options' => $options,
    '#default_value' => $newsletter->new_account,
    '#description' => $this
      ->t('None: This newsletter is not listed on the user registration page.<br />Default on: This newsletter is listed on the user registion page and is selected by default.<br />Default off: This newsletter is listed on the user registion page and is not selected by default.<br />Silent: A new user is automatically subscribed to this newsletter. The newsletter is not listed on the user registration page.'),
  ];

  // Type of (un)subsribe confirmation.
  $options = simplenews_access_options();
  $form['subscription']['access'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Access'),
    '#options' => $options,
    '#default_value' => $newsletter->access,
    '#description' => $this
      ->t("Default: Any user with 'Subscribe to newsletters' permission can subscribe and unsubscribe.<br />Hidden: Subscription is mandatory or controlled programmatically."),
  ];
  $form['email'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Email settings'),
    '#collapsible' => FALSE,
  ];

  // Hide format selection if there is nothing to choose.
  // The default format is plain text.
  $format_options = simplenews_format_options();
  if (count($format_options) > 1) {
    $form['email']['format'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Email format'),
      '#default_value' => $newsletter->format,
      '#options' => $format_options,
    ];
  }
  else {
    $form['email']['format'] = [
      '#type' => 'hidden',
      '#value' => key($format_options),
    ];
    $form['email']['format_text'] = [
      '#markup' => $this
        ->t('Newsletter emails will be sent in %format format.', [
        '%format' => $newsletter->format,
      ]),
    ];
  }

  // Type of hyperlinks.
  $form['email']['hyperlinks'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Hyperlink conversion'),
    '#description' => $this
      ->t('Determine how the conversion to text is performed.'),
    '#options' => [
      $this
        ->t('Append hyperlinks as a numbered reference list'),
      $this
        ->t('Display hyperlinks inline with the text'),
    ],
    '#default_value' => $newsletter->hyperlinks,
    '#states' => [
      'visible' => [
        ':input[name="format"]' => [
          'value' => 'plain',
        ],
      ],
    ],
  ];
  $form['email']['priority'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Email priority'),
    '#default_value' => $newsletter->priority,
    '#options' => simplenews_get_priority(),
  ];
  $form['email']['receipt'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Request receipt'),
    '#return_value' => 1,
    '#default_value' => $newsletter->receipt,
  ];

  // Email sender name.
  $form['simplenews_sender_information'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Sender information'),
    '#collapsible' => FALSE,
  ];
  $form['simplenews_sender_information']['from_name'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('From name'),
    '#size' => 60,
    '#maxlength' => 128,
    '#default_value' => $newsletter->from_name,
  ];

  // Email subject.
  $form['simplenews_subject'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Newsletter subject'),
    '#collapsible' => FALSE,
  ];
  $form['simplenews_subject']['subject'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Email subject'),
    '#size' => 60,
    '#maxlength' => 128,
    '#required' => TRUE,
    '#default_value' => $newsletter->subject,
  ];
  if (\Drupal::moduleHandler()
    ->moduleExists('token')) {
    $form['simplenews_subject']['token_browser'] = [
      '#theme' => 'token_tree_link',
      '#token_types' => [
        'simplenews-newsletter',
        'node',
        'simplenews-subscriber',
      ],
    ];
  }

  // Email from address.
  $form['simplenews_sender_information']['from_address'] = [
    '#type' => 'email',
    '#title' => $this
      ->t('From email address'),
    '#size' => 60,
    '#maxlength' => 128,
    '#required' => TRUE,
    '#default_value' => $newsletter->from_address,
  ];
  $form['actions'] = [
    '#type' => 'actions',
  ];
  $form['actions']['submit'] = [
    '#type' => 'submit',
    '#value' => $this
      ->t('Save'),
    '#weight' => 50,
  ];
  if ($newsletter->id) {
    $form['actions']['delete'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Delete'),
      '#weight' => 55,
    ];
  }
  return $form;
}