You are here

class SocialEventManagersSendEmail in Open Social 10.0.x

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_event/modules/social_event_managers/src/Plugin/Action/SocialEventManagersSendEmail.php \Drupal\social_event_managers\Plugin\Action\SocialEventManagersSendEmail
  2. 8.5 modules/social_features/social_event/modules/social_event_managers/src/Plugin/Action/SocialEventManagersSendEmail.php \Drupal\social_event_managers\Plugin\Action\SocialEventManagersSendEmail
  3. 8.6 modules/social_features/social_event/modules/social_event_managers/src/Plugin/Action/SocialEventManagersSendEmail.php \Drupal\social_event_managers\Plugin\Action\SocialEventManagersSendEmail
  4. 8.7 modules/social_features/social_event/modules/social_event_managers/src/Plugin/Action/SocialEventManagersSendEmail.php \Drupal\social_event_managers\Plugin\Action\SocialEventManagersSendEmail
  5. 8.8 modules/social_features/social_event/modules/social_event_managers/src/Plugin/Action/SocialEventManagersSendEmail.php \Drupal\social_event_managers\Plugin\Action\SocialEventManagersSendEmail
  6. 10.3.x modules/social_features/social_event/modules/social_event_managers/src/Plugin/Action/SocialEventManagersSendEmail.php \Drupal\social_event_managers\Plugin\Action\SocialEventManagersSendEmail
  7. 10.1.x modules/social_features/social_event/modules/social_event_managers/src/Plugin/Action/SocialEventManagersSendEmail.php \Drupal\social_event_managers\Plugin\Action\SocialEventManagersSendEmail
  8. 10.2.x modules/social_features/social_event/modules/social_event_managers/src/Plugin/Action/SocialEventManagersSendEmail.php \Drupal\social_event_managers\Plugin\Action\SocialEventManagersSendEmail

Send email to event enrollment users.

Plugin annotation


@Action(
  id = "social_event_managers_send_email_action",
  label = @Translation("Send email to event enrollment users"),
  type = "event_enrollment",
  view_id = "event_manage_enrollments",
  display_id = "page_manage_enrollments",
  confirm = TRUE,
  confirm_form_route_name = "social_event_managers.vbo.confirm",
)

Hierarchy

Expanded class hierarchy of SocialEventManagersSendEmail

1 file declares its use of SocialEventManagersSendEmail
SocialEventAnEnrollSendEmail.php in modules/social_features/social_event/modules/social_event_an_enroll/src/Plugin/Action/SocialEventAnEnrollSendEmail.php

File

modules/social_features/social_event/modules/social_event_managers/src/Plugin/Action/SocialEventManagersSendEmail.php, line 32

Namespace

Drupal\social_event_managers\Plugin\Action
View source
class SocialEventManagersSendEmail extends SocialSendEmail {

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

  /**
   * {@inheritdoc}
   */
  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) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $token, $entity_type_manager, $logger, $language_manager, $email_validator, $queue_factory, $allow_text_format);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $objects) {
    $users = [];
    $chunks = array_chunk($objects, 15);

    // Process the event enrollment chunks. These need to be converted to users.
    foreach ($chunks as $chunk) {
      $entities = [];

      /** @var \Drupal\social_event\Entity\EventEnrollment $enrollment */
      foreach ($chunk as $enrollment) {

        // Get the user from the even enrollment.

        /** @var \Drupal\user\Entity\User $user */
        $user = User::load($enrollment
          ->getAccount());
        $entities[] = $this
          ->execute($user);
      }
      $users += $this->entityTypeManager
        ->getStorage('user')
        ->loadMultiple($entities);
    }
    return parent::executeMultiple($users);
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    $access = AccessResult::allowedIf($object instanceof EventEnrollmentInterface);
    if ($object instanceof EventEnrollmentInterface) {

      // All users with the following access permission should be allowed.
      $access = AccessResult::allowedIfHasPermission($account, 'manage everything enrollments');
      $event_id = $object
        ->getFieldValue('field_event', 'target_id');
      $node = $this->entityTypeManager
        ->getStorage('node')
        ->load($event_id);

      // Also Event organizers can do this.
      if ($node instanceof NodeInterface && social_event_manager_or_organizer($node)) {
        $access = AccessResult::allowedIf($object instanceof EventEnrollmentInterface);
      }
    }
    return $return_as_object ? $access : $access
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  public function buildPreConfigurationForm(array $form, array $values, FormStateInterface $form_state) {
    return $form;
  }

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

    // Add title to the form as well.
    if ($form['#title'] !== NULL) {
      $selected_count = $this->context['selected_count'];
      $subtitle = $this
        ->formatPlural($selected_count, 'Configure the email you want to send to the one enrollee you have selected.', 'Configure the email you want to send to the @count enrollees you have selected.');
      $form['subtitle'] = [
        '#type' => 'html_tag',
        '#tag' => 'div',
        '#attributes' => [
          'class' => [
            'placeholder',
          ],
        ],
        '#value' => $subtitle,
      ];
    }
    return parent::buildConfigurationForm($form, $form_state);
  }

}

Members

Namesort descending 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.
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
SocialEventManagersSendEmail::executeMultiple public function Execute action on multiple entities. Overrides SocialSendEmail::executeMultiple 1
SocialEventManagersSendEmail::__construct public function Constructs a SocialSendEmail object. Overrides SocialSendEmail::__construct 1
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 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