class SubscriberValidateForm in Simplenews 3.x

Do a mass subscription for a list of email addresses.

Hierarchy

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

1 string reference to 'SubscriberValidateForm'

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

simplenews.routing.yml

File

src/Form/SubscriberValidateForm.php, line 17

Namespace

Drupal\simplenews\Form

class SubscriberValidateForm extends FormBase {

  /**
   * The mail manager.
   *
   * @var \Drupal\Core\Mail\MailManagerInterface
   */
  protected $mailManager;

  /**
   * The mailer service.
   *
   * @var \Drupal\simplenews\Mail\MailerInterface
   */
  protected $mailer;

  /**
   * Constructs a new SubscriberMassSubscribeForm.
   *
   * @param \Drupal\Core\Mail\MailManagerInterface $mail_manager
   *   The mail manager.
   * @param \Drupal\simplenews\Mail\MailerInterface $mailer
   *   The mailer service.
   */
  public function __construct(MailManagerInterface $mail_manager, MailerInterface $mailer) {
    $this->mailManager = $mail_manager;
    $this->mailer = $mailer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.mail'), $container
      ->get('simplenews.mailer'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $user = $this
      ->currentUser();
    if ($user
      ->isAuthenticated()) {
      return new RedirectResponse(Url::fromRoute('simplenews.newsletter_subscriptions_user', [
        'user' => $user
          ->id(),
      ])
        ->toString());
    }
    $form['explain'] = [
      '#prefix' => '<p>',
      '#markup' => $this
        ->t('Request an email with a link to manage your subscriptions.'),
      '#suffix' => '</p>',
    ];
    $form['mail'] = [
      '#type' => 'email',
      '#title' => $this
        ->t('Email'),
      '#description' => $this
        ->t('Subscribed email address'),
      '#required' => TRUE,
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $mail = trim($form_state
      ->getValue('mail'));
    if (($subscriber = Subscriber::loadByMail($mail)) && $subscriber
      ->getStatus()) {
      $params['from'] = $this->mailer
        ->getFrom();
      $params['context']['simplenews_subscriber'] = $subscriber;
      $this->mailManager
        ->mail('simplenews', 'validate', $subscriber
        ->getMail(), $subscriber
        ->getLangcode(), $params, $params['from']['address']);
    }
    $this
      ->messenger()
      ->addStatus($this
      ->t('If %mail is subscribed, an email will be sent with a link to manage your subscriptions.', [
      '%mail' => $mail,
    ]));
    $form_state
      ->setRedirect('<front>');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::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::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.
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.
SubscriberValidateForm::$mailer	protected	property	The mailer service.
SubscriberValidateForm::$mailManager	protected	property	The mail manager.
SubscriberValidateForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
SubscriberValidateForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
SubscriberValidateForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SubscriberValidateForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
SubscriberValidateForm::__construct	public	function	Constructs a new SubscriberMassSubscribeForm.