You are here

Home » API reference » Simplenews 8 » SubscriberExportForm.php

class SubscriberExportForm in Simplenews 8

Same name and namespace in other branches
  1. 8.2 src/Form/SubscriberExportForm.php \Drupal\simplenews\Form\SubscriberExportForm
  2. 3.x src/Form/SubscriberExportForm.php \Drupal\simplenews\Form\SubscriberExportForm

Do a mass subscription for a list of email addresses.

Hierarchy

Expanded class hierarchy of SubscriberExportForm

1 string reference to 'SubscriberExportForm'
simplenews.routing.yml in ./simplenews.routing.yml
simplenews.routing.yml

File

src/Form/SubscriberExportForm.php, line 12

Namespace

Drupal\simplenews\Form
View source 
class SubscriberExportForm extends FormBase {

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

  /**
   * Implement getEmails($states, $subscribed, $newsletters)
   */
  function getEmails($states, $subscribed, $newsletters) {

    // Build conditions for active state, subscribed state and newsletter selection.
    if (isset($states['active'])) {
      $condition_active[] = SubscriberInterface::ACTIVE;
    }
    if (isset($states['inactive'])) {
      $condition_active[] = SubscriberInterface::INACTIVE;
    }
    if (isset($subscribed['subscribed'])) {
      $condition_subscribed[] = SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED;
    }
    if (isset($subscribed['unsubscribed'])) {
      $condition_subscribed[] = SIMPLENEWS_SUBSCRIPTION_STATUS_UNSUBSCRIBED;
    }
    if (isset($subscribed['unconfirmed'])) {
      $condition_subscribed[] = SIMPLENEWS_SUBSCRIPTION_STATUS_UNCONFIRMED;
    }

    // Get emails from the database.
    $query = \Drupal::entityQuery('simplenews_subscriber')
      ->condition('status', $condition_active, 'IN')
      ->condition('subscriptions.status', $condition_subscribed, 'IN')
      ->condition('subscriptions.target_id', (array) $newsletters, 'IN');
    $subscriber_ids = $query
      ->execute();
    $mails = array();
    foreach ($subscriber_ids as $id) {
      $subscriber = simplenews_subscriber_load($id);
      $mails[] = $subscriber
        ->getMail();
    }

    // Return comma separated array of emails or empty text.
    if ($mails) {
      return implode(", ", $mails);
    }
    return t('No addresses were found.');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Get sensible default values for the form elements in this form.
    $default['states'] = isset($_GET['states']) ? $_GET['states'] : array(
      'active' => 'active',
    );
    $default['subscribed'] = isset($_GET['subscribed']) ? $_GET['subscribed'] : array(
      'subscribed' => 'subscribed',
    );
    $default['newsletters'] = isset($_GET['newsletters']) ? $_GET['newsletters'] : array();
    $form['states'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Status'),
      '#options' => array(
        'active' => t('Active users'),
        'inactive' => t('Inactive users'),
      ),
      '#default_value' => $default['states'],
      '#description' => t('Subscriptions matching the selected states will be exported.'),
      '#required' => TRUE,
    );
    $form['subscribed'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Subscribed'),
      '#options' => array(
        'subscribed' => t('Subscribed to the newsletter'),
        'unconfirmed' => t('Unconfirmed to the newsletter'),
        'unsubscribed' => t('Unsubscribed from the newsletter'),
      ),
      '#default_value' => $default['subscribed'],
      '#description' => t('Subscriptions matching the selected subscription states will be exported.'),
      '#required' => TRUE,
    );
    $options = simplenews_newsletter_list();
    $form['newsletters'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Newsletter'),
      '#options' => $options,
      '#default_value' => $default['newsletters'],
      '#description' => t('Subscriptions matching the selected newsletters will be exported.'),
      '#required' => TRUE,
    );

    // Get export results and display them in a text area. Only get the results
    // if the form is build after redirect, not after submit.
    $input = $form_state
      ->getUserInput();
    if (isset($_GET['states']) && empty($input)) {
      $form['emails'] = array(
        '#type' => 'textarea',
        '#title' => t('Export results'),
        '#cols' => 60,
        '#rows' => 5,
        '#value' => $this
          ->getEmails($_GET['states'], $_GET['subscribed'], $_GET['newsletters']),
      );
    }
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Export'),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_values = $form_state
      ->getValues();

    // Get data for query string and redirect back to the current page.
    $options['query']['states'] = array_filter($form_values['states']);
    $options['query']['subscribed'] = array_filter($form_values['subscribed']);
    $options['query']['newsletters'] = array_keys(array_filter($form_values['newsletters']));
    $form_state
      ->setRedirect('simplenews.subscriber_export', array(), $options);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
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. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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. Overrides UrlGeneratorTrait::redirect
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.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
SubscriberExportForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SubscriberExportForm::getEmails function Implement getEmails($states, $subscribed, $newsletters)
SubscriberExportForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SubscriberExportForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SubscriberExportForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.