You are here

class MailingListExportForm in Mailing List 8

Mailing list export.

Hierarchy

Expanded class hierarchy of MailingListExportForm

1 string reference to 'MailingListExportForm'
mailing_list.routing.yml in ./mailing_list.routing.yml
mailing_list.routing.yml

File

src/Form/MailingListExportForm.php, line 16

Namespace

Drupal\mailing_list\Form
View source
class MailingListExportForm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The mailing list to work with.
   *
   * @var \Drupal\mailing_list\MailingListInterface
   */
  protected $mailingList;

  /**
   * The current export result.
   *
   * @var array
   */
  protected $result = [];

  /**
   * Constructs a MailingListExportForm object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translation service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, TranslationInterface $string_translation) {
    $this->entityTypeManager = $entity_type_manager;
    $this->stringTranslation = $string_translation;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, MailingListInterface $mailing_list = NULL) {
    $this->mailingList = $mailing_list;
    $form['#title'] = $this
      ->t('Export subscriptions from %label mailing list', [
      '%label' => $mailing_list
        ->label(),
    ]);
    $form['status'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Filter by status'),
      '#options' => [
        '' => $this
          ->t('- any -'),
        'active' => $this
          ->t('Active'),
        'inactive' => $this
          ->t('Inactive'),
      ],
      '#default_value' => $form_state
        ->getValue('status', ''),
    ];
    if (!empty($this->result)) {
      $form['result'] = [
        '#type' => 'textarea',
        '#title' => $this
          ->t('Result'),
        '#rows' => 10,
        '#resizable' => 'vertical',
        '#value' => implode("\n", $this->result),
      ];
    }
    $form['actions']['apply'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Export'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $emails = [];
    $storage = $this->entityTypeManager
      ->getStorage('mailing_list_subscription');
    $query = $storage
      ->getQuery()
      ->condition('mailing_list', $this->mailingList
      ->id());

    // Filter by status.
    if ($status = $form_state
      ->getValue('status')) {
      $query
        ->condition('status', $status === 'active' ? SubscriptionInterface::ACTIVE : SubscriptionInterface::INACTIVE);
    }

    /** @var \Drupal\mailing_list\SubscriptionInterface $subscription */
    foreach ($storage
      ->loadMultiple($query
      ->execute()) as $subscription) {
      $emails[] = $subscription
        ->getEmail();
    }
    drupal_set_message(empty($emails) ? $this
      ->t('No subscriptions found.') : $this
      ->formatPlural(count($emails), 'Found 1 subscription.', 'Found @count subscriptions', [
      '@count' => count($emails),
    ]));
    $this->result = $emails;
    $form_state
      ->setRebuild(TRUE);
  }

}

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::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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
MailingListExportForm::$entityTypeManager protected property The entity type manager.
MailingListExportForm::$mailingList protected property The mailing list to work with.
MailingListExportForm::$result protected property The current export result.
MailingListExportForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
MailingListExportForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
MailingListExportForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MailingListExportForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
MailingListExportForm::__construct public function Constructs a MailingListExportForm object.
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.
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.