class SubscriberMassUnsubscribeForm 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\SubscriberMassUnsubscribeForm

1 string reference to 'SubscriberMassUnsubscribeForm'

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

simplenews.routing.yml

File

src/Form/SubscriberMassUnsubscribeForm.php, line 15

Namespace

Drupal\simplenews\Form

class SubscriberMassUnsubscribeForm extends FormBase {

  /**
   * The subscription manager.
   *
   * @var \Drupal\simplenews\Subscription\SubscriptionManagerInterface
   */
  protected $subscriptionManager;

  /**
   * The email validator.
   *
   * @var \Drupal\Component\Utility\EmailValidatorInterface
   */
  protected $emailValidator;

  /**
   * Constructs a new SubscriberMassUnsubscribeForm.
   *
   * @param \Drupal\simplenews\Subscription\SubscriptionManagerInterface $subscription_manager
   *   The subscription manager.
   * @param \Drupal\Component\Utility\EmailValidatorInterface $email_validator
   *   The email validator.
   */
  public function __construct(SubscriptionManagerInterface $subscription_manager, EmailValidatorInterface $email_validator) {
    $this->subscriptionManager = $subscription_manager;
    $this->emailValidator = $email_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('simplenews.subscription_manager'), $container
      ->get('email.validator'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['emails'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Email addresses'),
      '#cols' => 60,
      '#rows' => 5,
      '#description' => $this
        ->t('Email addresses must be separated by comma, space or newline.'),
    ];
    $form['newsletters'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Unsubscribe from'),
      '#options' => simplenews_newsletter_list(),
      '#required' => TRUE,
    ];
    foreach (simplenews_newsletter_get_all() as $id => $newsletter) {
      $form['newsletters'][$id]['#description'] = Html::escape($newsletter->description);
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Unsubscribe'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $removed = [];
    $invalid = [];
    $checked_lists = array_keys(array_filter($form_state
      ->getValue('newsletters')));
    $emails = preg_split("/[\\s,]+/", $form_state
      ->getValue('emails'));
    foreach ($emails as $email) {
      $email = trim($email);
      if ($this->emailValidator
        ->isValid($email)) {
        foreach ($checked_lists as $newsletter_id) {
          $this->subscriptionManager
            ->unsubscribe($email, $newsletter_id, FALSE, 'mass unsubscribe');
          $removed[] = $email;
        }
      }
      else {
        $invalid[] = $email;
      }
    }
    if ($removed) {
      $removed = implode(", ", $removed);
      $this
        ->messenger()
        ->addMessage($this
        ->t('The following addresses were unsubscribed: %removed.', [
        '%removed' => $removed,
      ]));
      $newsletters = simplenews_newsletter_get_all();
      $list_names = [];
      foreach ($checked_lists as $newsletter_id) {
        $list_names[] = $newsletters[$newsletter_id]
          ->label();
      }
      $this
        ->messenger()
        ->addMessage($this
        ->t('The addresses were unsubscribed from the following newsletters: %newsletters.', [
        '%newsletters' => implode(', ', $list_names),
      ]));
    }
    else {
      $this
        ->messenger()
        ->addMessage($this
        ->t('No addresses were removed.'));
    }
    if ($invalid) {
      $invalid = implode(", ", $invalid);
      $this
        ->messenger()
        ->addError($this
        ->t('The following addresses were invalid: %invalid.', [
        '%invalid' => $invalid,
      ]));
    }

    // Return to the parent page.
    $form_state
      ->setRedirect('entity.simplenews_subscriber.collection');
  }

}

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.
SubscriberMassUnsubscribeForm::$emailValidator	protected	property	The email validator.
SubscriberMassUnsubscribeForm::$subscriptionManager	protected	property	The subscription manager.
SubscriberMassUnsubscribeForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
SubscriberMassUnsubscribeForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
SubscriberMassUnsubscribeForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SubscriberMassUnsubscribeForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
SubscriberMassUnsubscribeForm::__construct	public	function	Constructs a new SubscriberMassUnsubscribeForm.