class SubscriptionBlock in Mailing List 8

Mailing list subscription blocks.

Plugin annotation


@Block(
  id = "mailing_list_subscription_block",
  admin_label = @Translation("Mailing list subscription"),
  category = @Translation("Mailing list")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\mailing_list\Plugin\Block\SubscriptionBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of SubscriptionBlock

File

src/Plugin/Block/SubscriptionBlock.php, line 25

Namespace

Drupal\mailing_list\Plugin\Block

View source

class SubscriptionBlock extends BlockBase implements ContainerFactoryPluginInterface {

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

  /**
   * The form builder.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * The mailing list manager.
   *
   * @var \Drupal\mailing_list\MailingListManagerInterface
   */
  protected $mailingListManager;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * Constructs a SubscriptionBlock object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\FormBuilderInterface $form_builder
   *   The form builder object.
   * @param \Drupal\mailing_list\MailingListManagerInterface $mailing_list_manager
   *   The mailing list manager.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, FormBuilderInterface $form_builder, MailingListManagerInterface $mailing_list_manager, AccountInterface $current_user) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->formBuilder = $form_builder;
    $this->mailingListManager = $mailing_list_manager;
    $this->currentUser = $current_user;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('form_builder'), $container
      ->get('mailing_list.manager'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'list' => '',
      'message' => '',
      'form_id' => '',
      'manage_link' => TRUE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {

    // No list, no access opinion.
    if (empty($this->configuration['list'])) {
      return AccessResult::neutral();
    }

    // Users must be able to subscribe to all configured mailing lists.
    return AccessResult::allowedIfHasPermission($account, 'subscribe to ' . $this->configuration['list'] . ' mailing list');
  }

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

    // Mailing list for this subscription block.
    $options = [];
    foreach ($this->entityTypeManager
      ->getStorage('mailing_list')
      ->loadMultiple() as $list) {
      $options[$list
        ->id()] = $list
        ->label();
    }
    if (count($options) > 1) {
      asort($options, SORT_STRING);
    }
    $form['manage_link'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show manage subscriptions link'),
      '#default_value' => $this->configuration['manage_link'],
    ];
    $form['list'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Mailing list'),
      '#options' => $options,
      '#required' => TRUE,
      '#default_value' => $this->configuration['list'] ?: key($options),
    ];

    // Block message.
    $form['message'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Block message'),
      '#size' => 60,
      '#maxlength' => 255,
      '#description' => $this
        ->t('Message to the user. Leave empty for display the mailing list configured help. Enter @none for no message at all.', [
        '@none' => '<none>',
      ]),
      '#default_value' => $this->configuration['message'],
    ];

    // Subscription form ID.
    $form['form_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Form ID'),
      '#field_prefix' => 'mailing_list_subscription_&lt;LIST-ID&gt;_',
      '#field_suffix' => '_block_form',
      '#size' => 16,
      '#maxlength' => 32,
      '#description' => $this
        ->t('Customize the subscription form ID.'),
      '#default_value' => $this->configuration['form_id'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockValidate($form, FormStateInterface $form_state) {
    if (!preg_match('/^[a-z0-9_]*$/', $form_state
      ->getValue('form_id'))) {
      $form_state
        ->setErrorByName('form_id', $this
        ->t('A unique machine-readable name containing letters, numbers, and underscores.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['list'] = $form_state
      ->getValue('list');
    $this->configuration['message'] = $form_state
      ->getValue('message');
    $this->configuration['form_id'] = $form_state
      ->getValue('form_id');
    $this->configuration['manage_link'] = $form_state
      ->getValue('manage_link');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {

    /** @var \Drupal\mailing_list\Form\SubscriptionForm $form_object */
    $form_object = $this->entityTypeManager
      ->getFormObject('mailing_list_subscription', 'block');

    // Add message.
    $form_object
      ->setMessage($this->configuration['message']);

    // Alter form ID.
    $form_object
      ->setCustomId($this->configuration['form_id']);

    // Set a new subscription entity as the entity form.

    /** @var \Drupal\mailing_list\SubscriptionInterface $entity */
    $entity = $this->entityTypeManager
      ->getStorage('mailing_list_subscription')
      ->create([
      'mailing_list' => $this->configuration['list'],
      'email' => $this->currentUser
        ->getEmail(),
    ]);
    $form_object
      ->setEntity($entity);

    // Add the form destination.
    $form_object
      ->setFormDestination($entity
      ->getList()
      ->getFormDestination());

    // Alter the default form submit button.
    $form = $this->formBuilder
      ->getForm($form_object);
    if ($form['actions']['submit']['#value'] == $this
      ->t('Save')
      ->render()) {
      $form['actions']['submit']['#value'] = $this
        ->t('Subscribe');
    }

    // Remove admin fields groups.
    unset($form['advanced']);
    unset($form['subscription_authoring']);
    unset($form['subscription_status']);

    // Block title is taken from the form title.
    if (isset($this->configuration['label']) && ($block_title = trim($this->configuration['label']))) {
      $form['#title'] = $block_title;
    }

    // Add manage subscription link.
    if ($this->configuration['manage_link']) {
      $manage_url = Url::fromRoute('entity.mailing_list_subscription.manage');
      if ($manage_url
        ->access()) {
        $form['manage_link'] = [
          '#type' => 'link',
          '#title' => $this
            ->t('Manage your subscriptions'),
          '#url' => $manage_url,
        ];
      }
    }
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE		constant	Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration	protected	property	The transliteration service.
BlockPluginTrait::access	public	function
BlockPluginTrait::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::buildConfigurationForm	public	function	Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements.	2
BlockPluginTrait::calculateDependencies	public	function
BlockPluginTrait::getConfiguration	public	function		1
BlockPluginTrait::getMachineNameSuggestion	public	function		1
BlockPluginTrait::getPreviewFallbackString	public	function		3
BlockPluginTrait::label	public	function
BlockPluginTrait::setConfiguration	public	function
BlockPluginTrait::setConfigurationValue	public	function
BlockPluginTrait::setTransliteration	public	function	Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm	public	function	Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration	protected	function	Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm	public	function	Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().	1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass	public	function
PluginWithFormsTrait::hasFormClass	public	function
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.
SubscriptionBlock::$currentUser	protected	property	The current user.
SubscriptionBlock::$entityTypeManager	protected	property	The entity type manager.
SubscriptionBlock::$formBuilder	protected	property	The form builder.
SubscriptionBlock::$mailingListManager	protected	property	The mailing list manager.
SubscriptionBlock::blockAccess	protected	function	Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
SubscriptionBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
SubscriptionBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
SubscriptionBlock::blockValidate	public	function	Overrides BlockPluginTrait::blockValidate
SubscriptionBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
SubscriptionBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SubscriptionBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
SubscriptionBlock::__construct	public	function	Constructs a SubscriptionBlock object. Overrides BlockPluginTrait::__construct
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class SubscriptionBlock in Mailing List 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation