class NewsletterForm in Simplenews 3.x

Base form for category edit forms.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
    • class \Drupal\simplenews\Form\NewsletterForm

File

src/Form/NewsletterForm.php, line 12

Namespace

Drupal\simplenews\Form

class NewsletterForm extends EntityForm {

  /**
   * Overrides Drupal\Core\Entity\EntityForm::form().
   */
  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;
  }

  /**
   * Overrides Drupal\Core\Entity\EntityForm::save().
   */
  public function save(array $form, FormStateInterface $form_state) {
    $newsletter = $this->entity;
    $status = $newsletter
      ->save();
    $edit_link = \Drupal::linkGenerator()
      ->generate($this
      ->t('Edit'), $this->entity
      ->toUrl());
    if ($status == SAVED_UPDATED) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('Newsletter %label has been updated.', [
        '%label' => $newsletter
          ->label(),
      ]));
      \Drupal::logger('simplenews')
        ->notice('Newsletter %label has been updated.', [
        '%label' => $newsletter
          ->label(),
        'link' => $edit_link,
      ]);
    }
    else {
      $this
        ->messenger()
        ->addMessage($this
        ->t('Newsletter %label has been added.', [
        '%label' => $newsletter
          ->label(),
      ]));
      \Drupal::logger('simplenews')
        ->notice('Newsletter %label has been added.', [
        '%label' => $newsletter
          ->label(),
        'link' => $edit_link,
      ]);
    }
    $form_state
      ->setRedirect('simplenews.newsletter_list');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityForm::$entity	protected	property	The entity being used by this form.	11
EntityForm::$entityTypeManager	protected	property	The entity type manager.	3
EntityForm::$moduleHandler	protected	property	The module handler service.
EntityForm::$operation	protected	property	The name of the current operation.
EntityForm::actions	protected	function	Returns an array of supported actions for the current entity form.	35
EntityForm::actionsElement	protected	function	Returns the action form element for the current entity form.
EntityForm::afterBuild	public	function	Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity	public	function	Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity	3
EntityForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	13
EntityForm::copyFormValuesToEntity	protected	function	Copies top-level form values to entity properties.	9
EntityForm::getBaseFormId	public	function	Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId	6
EntityForm::getEntity	public	function	Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch	public	function	Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch	3
EntityForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId	12
EntityForm::getOperation	public	function	Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init	protected	function	Initialize the form state and the entity before the first form build.	3
EntityForm::prepareEntity	protected	function	Prepares the entity object before the form is built first.	3
EntityForm::prepareInvokeAll	protected	function	Invokes the specified prepare hook variant.
EntityForm::processForm	public	function	Process callback: assigns weights and hides extra fields.
EntityForm::setEntity	public	function	Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager	public	function	Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler	public	function	Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation	public	function	Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm	public	function	This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides FormInterface::submitForm	20
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	105
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.
NewsletterForm::form	public	function	Overrides Drupal\Core\Entity\EntityForm::form(). Overrides EntityForm::form
NewsletterForm::save	public	function	Overrides Drupal\Core\Entity\EntityForm::save(). Overrides EntityForm::save
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.