class MailingListExportForm in Mailing List 8
Mailing list export.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\mailing_list\Form\MailingListExportForm
Expanded class hierarchy of MailingListExportForm
1 string reference to 'MailingListExportForm'
File
- src/
Form/ MailingListExportForm.php, line 16
Namespace
Drupal\mailing_list\FormView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MailingListExportForm:: |
protected | property | The entity type manager. | |
MailingListExportForm:: |
protected | property | The mailing list to work with. | |
MailingListExportForm:: |
protected | property | The current export result. | |
MailingListExportForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
MailingListExportForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
MailingListExportForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
MailingListExportForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
MailingListExportForm:: |
public | function | Constructs a MailingListExportForm object. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |