class SocialEventAnEnrollSendEmail in Open Social 10.3.x

Send email to event enrollment users.

Plugin annotation

@Action(
  id = "social_event_an_enroll_send_email_action",
  label = @Translation("Email"),
  type = "event_enrollment",
  confirm = TRUE,
  confirm_form_route_name = "social_event_managers.vbo.confirm",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionBase implements ConfigurableInterface, ViewsBulkOperationsActionInterface uses ViewsBulkOperationsActionCompletedTrait
        • class \Drupal\social_user\Plugin\Action\SocialSendEmail implements ContainerFactoryPluginInterface, ViewsBulkOperationsPreconfigurationInterface
          • class \Drupal\social_event_managers\Plugin\Action\SocialEventManagersSendEmail
            • class \Drupal\social_event_an_enroll\Plugin\Action\SocialEventAnEnrollSendEmail

File

modules/social_features/social_event/modules/social_event_an_enroll/src/Plugin/Action/SocialEventAnEnrollSendEmail.php, line 28

Namespace

Drupal\social_event_an_enroll\Plugin\Action

class SocialEventAnEnrollSendEmail extends SocialEventManagersSendEmail {

  /**
   * The event enrollment.
   *
   * @var \Drupal\social_event\EventEnrollmentInterface
   */
  protected $entity;

  /**
   * The event an enroll manager.
   *
   * @var \Drupal\social_event_an_enroll\EventAnEnrollManager
   */
  protected $socialEventAnEnrollManager;

  /**
   * Constructs a SocialEventAnEnrollSendEmail 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\Utility\Token $token
   *   The token service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Egulias\EmailValidator\EmailValidator $email_validator
   *   The email validator.
   * @param \Drupal\Core\Queue\QueueFactory $queue_factory
   *   The queue factory.
   * @param bool $allow_text_format
   *   TRUE if the current user can use the "Mail HTML" text format.
   * @param \Drupal\social_event_an_enroll\EventAnEnrollManager $event_an_enroller
   *   The social event anonymous manager.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Token $token, EntityTypeManagerInterface $entity_type_manager, LoggerInterface $logger, LanguageManagerInterface $language_manager, EmailValidator $email_validator, QueueFactory $queue_factory, $allow_text_format, EventAnEnrollManager $event_an_enroller) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $token, $entity_type_manager, $logger, $language_manager, $email_validator, $queue_factory, $allow_text_format);
    $this->socialEventAnEnrollManager = $event_an_enroller;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('token'), $container
      ->get('entity_type.manager'), $container
      ->get('logger.factory')
      ->get('action'), $container
      ->get('language_manager'), $container
      ->get('email.validator'), $container
      ->get('queue'), $container
      ->get('current_user')
      ->hasPermission('use text format mail_html'), $container
      ->get('social_event_an_enroll.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $objects) {
    $guests = [];
    foreach ($objects as $key => $entity) {
      if ($this->socialEventAnEnrollManager
        ->isGuest($entity)) {
        $guests[$key] = [
          'email_address' => $entity->field_email->value,
          'display_name' => $this
            ->getDisplayName($entity),
        ];
      }
    }
    if (!empty($guests)) {

      // Create some chunks and then make queue items.
      $chunk_size = Settings::get('social_mail_chunk_size', 10);
      $chunks = array_chunk($guests, $chunk_size);
      foreach ($chunks as $chunk) {

        // Get the entity ID of the email that is send.
        $data['mail'] = $this->configuration['queue_storage_id'];

        // Add the list of user IDs.
        $data['user_mail_addresses'] = $chunk;

        // Put the $data in the queue item.

        /** @var \Drupal\Core\Queue\QueueInterface $queue */
        $queue = $this->queue
          ->get('user_email_queue');
        $queue
          ->createItem($data);
      }
    }

    // Before parent remove the guest from the objects list.
    // Otherwise they will be processed as users and it will break as there
    // is no user account.
    $objects = array_diff_key($objects, array_keys($guests));

    // Execute parent as we still need to check if there are users enrolled.
    return parent::executeMultiple($objects);
  }

  /**
   * Get the display name of the guest.
   *
   * @param \Drupal\social_event\EventEnrollmentInterface $entity
   *   The event enrolment to get the name from.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup|string
   *   The name of the guest enrolment.
   */
  public function getDisplayName(EventEnrollmentInterface $entity) {
    $display_name = $this->socialEventAnEnrollManager
      ->getGuestName($entity, FALSE);
    if (!$display_name) {
      $display_name = $this
        ->t('Guest');
    }
    return $display_name;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
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	2
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.
SocialEventAnEnrollSendEmail::$entity	protected	property	The event enrollment.
SocialEventAnEnrollSendEmail::$socialEventAnEnrollManager	protected	property	The event an enroll manager.
SocialEventAnEnrollSendEmail::create	public static	function	Creates an instance of the plugin. Overrides SocialSendEmail::create
SocialEventAnEnrollSendEmail::executeMultiple	public	function	Execute action on multiple entities. Overrides SocialEventManagersSendEmail::executeMultiple
SocialEventAnEnrollSendEmail::getDisplayName	public	function	Get the display name of the guest.
SocialEventAnEnrollSendEmail::__construct	public	function	Constructs a SocialEventAnEnrollSendEmail object. Overrides SocialEventManagersSendEmail::__construct
SocialEventManagersSendEmail::$entityTypeManager	protected	property	The entity type manager.
SocialEventManagersSendEmail::access	public	function	Checks object access. Overrides SocialSendEmail::access
SocialEventManagersSendEmail::buildConfigurationForm	public	function	Configuration form builder. Overrides SocialSendEmail::buildConfigurationForm
SocialEventManagersSendEmail::buildPreConfigurationForm	public	function	Build preconfigure action form elements. Overrides SocialSendEmail::buildPreConfigurationForm
SocialSendEmail::$allowTextFormat	protected	property	TRUE if the current user can use the "Mail HTML" text format.
SocialSendEmail::$emailValidator	protected	property	The email validator.
SocialSendEmail::$languageManager	protected	property	The language manager.
SocialSendEmail::$logger	protected	property	A logger instance.
SocialSendEmail::$queue	protected	property	The queue factory.
SocialSendEmail::$storage	protected	property	The user storage.
SocialSendEmail::$token	protected	property	The token service.
SocialSendEmail::createQueueItem	public	function	Create Queue Item.	1
SocialSendEmail::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute	1
SocialSendEmail::getEmail	public	function	Returns the email address of this account.
SocialSendEmail::setContext	public	function	Set action context. Overrides ViewsBulkOperationsActionBase::setContext
SocialSendEmail::submitConfigurationForm	public	function	Default configuration form submit handler. Overrides ViewsBulkOperationsActionBase::submitConfigurationForm
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.
ViewsBulkOperationsActionBase::$configuration	protected	property	Configuration array. Overrides PluginBase::$configuration
ViewsBulkOperationsActionBase::$context	protected	property	Action context.
ViewsBulkOperationsActionBase::$view	protected	property	The processed view.
ViewsBulkOperationsActionBase::customAccess	public static	function	Default custom access callback.
ViewsBulkOperationsActionBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ViewsBulkOperationsActionBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ViewsBulkOperationsActionBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ViewsBulkOperationsActionBase::setView	public	function	Set view object. Overrides ViewsBulkOperationsActionInterface::setView
ViewsBulkOperationsActionBase::validateConfigurationForm	public	function	Default configuration form validator.
ViewsBulkOperationsActionCompletedTrait::finished	public static	function	Batch finished callback.	1
ViewsBulkOperationsActionCompletedTrait::message	public static	function	Set message function wrapper.	1
ViewsBulkOperationsActionCompletedTrait::translate	public static	function	Translation function wrapper.	1