class EventRequestActivityContext in Open Social 10.0.x
Same name and namespace in other branches
- 8.9 modules/custom/activity_basics/src/Plugin/ActivityContext/EventRequestActivityContext.php \Drupal\activity_basics\Plugin\ActivityContext\EventRequestActivityContext
- 10.3.x modules/custom/activity_basics/src/Plugin/ActivityContext/EventRequestActivityContext.php \Drupal\activity_basics\Plugin\ActivityContext\EventRequestActivityContext
- 10.1.x modules/custom/activity_basics/src/Plugin/ActivityContext/EventRequestActivityContext.php \Drupal\activity_basics\Plugin\ActivityContext\EventRequestActivityContext
- 10.2.x modules/custom/activity_basics/src/Plugin/ActivityContext/EventRequestActivityContext.php \Drupal\activity_basics\Plugin\ActivityContext\EventRequestActivityContext
Provides a 'EventRequestActivityContext' activity context.
Plugin annotation
@ActivityContext(
id = "event_request_activity_context",
label = @Translation("Event request activity context"),
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\activity_creator\Plugin\ActivityContextBase implements ActivityContextInterface, ContainerFactoryPluginInterface
- class \Drupal\activity_basics\Plugin\ActivityContext\EventRequestActivityContext
- class \Drupal\activity_creator\Plugin\ActivityContextBase implements ActivityContextInterface, ContainerFactoryPluginInterface
Expanded class hierarchy of EventRequestActivityContext
File
- modules/
custom/ activity_basics/ src/ Plugin/ ActivityContext/ EventRequestActivityContext.php, line 21
Namespace
Drupal\activity_basics\Plugin\ActivityContextView source
class EventRequestActivityContext extends ActivityContextBase {
/**
* The module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* Constructs a EventRequestActivityContext 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\Query\Sql\QueryFactory $entity_query
* The query factory.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\activity_creator\ActivityFactory $activity_factory
* The activity factory service.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, QueryFactory $entity_query, EntityTypeManagerInterface $entity_type_manager, ActivityFactory $activity_factory, ModuleHandlerInterface $module_handler) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_query, $entity_type_manager, $activity_factory);
$this->moduleHandler = $module_handler;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity.query.sql'), $container
->get('entity_type.manager'), $container
->get('activity_creator.activity_factory'), $container
->get('module_handler'));
}
/**
* {@inheritdoc}
*/
public function getRecipients(array $data, $last_uid, $limit) {
$recipients = [];
// We only know the context if there is a related object.
if (isset($data['related_object']) && !empty($data['related_object'])) {
$related_entity = $this->activityFactory
->getActivityRelatedEntity($data);
if ($data['related_object'][0]['target_type'] === 'event_enrollment') {
// Get the enrollment id.
$enrollment_id = $data['related_object'][0]['target_id'];
/** @var \Drupal\social_event\EventEnrollmentInterface $event_enrollment */
$event_enrollment = $this->entityTypeManager
->getStorage('event_enrollment')
->load($enrollment_id);
if ($event_enrollment instanceof EventEnrollmentInterface) {
// Send out the notification if the user is pending.
if (!$event_enrollment
->get('field_enrollment_status')
->isEmpty() && $event_enrollment
->get('field_enrollment_status')->value === '0' && !$event_enrollment
->get('field_request_or_invite_status')
->isEmpty() && (int) $event_enrollment
->get('field_request_or_invite_status')->value === EventEnrollmentInterface::REQUEST_PENDING) {
$recipients = $this
->getRecipientOrganizerFromEntity($related_entity, $data);
}
// Send out a notification if the request is approved.
if (!$event_enrollment
->get('field_enrollment_status')
->isEmpty() && $event_enrollment
->get('field_enrollment_status')->value === '1' && !$event_enrollment
->get('field_request_or_invite_status')
->isEmpty() && (int) $event_enrollment
->get('field_request_or_invite_status')->value === EventEnrollmentInterface::REQUEST_APPROVED) {
$recipients = $this
->getEventEnrollmentOwner($event_enrollment, $data);
}
}
}
}
// Remove the actor (user performing action) from recipients list.
if (!empty($data['actor'])) {
$key = array_search($data['actor'], array_column($recipients, 'target_id'), FALSE);
if ($key !== FALSE) {
unset($recipients[$key]);
}
}
return $recipients;
}
/**
* Returns Organizer recipient from Events.
*
* @param array $related_entity
* The related entity.
* @param array $data
* The data.
*
* @return array
* An associative array of recipients, containing the following key-value
* pairs:
* - target_type: The entity type ID.
* - target_id: The entity ID.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
public function getRecipientOrganizerFromEntity(array $related_entity, array $data) {
$recipients = [];
// Don't return recipients if user enrolls to own Event.
$original_related_object = $data['related_object'][0];
if (isset($original_related_object['target_type']) && $original_related_object['target_type'] === 'event_enrollment' && $related_entity !== NULL) {
$storage = $this->entityTypeManager
->getStorage($related_entity['target_type']);
$event = $storage
->load($related_entity['target_id']);
if ($event === NULL) {
return $recipients;
}
$recipients[] = [
'target_type' => 'user',
'target_id' => $event
->getOwnerId(),
];
}
// If there are any others we should add. Make them also part of the
// recipients array.
$this->moduleHandler
->alter('activity_recipient_organizer', $recipients, $event, $original_related_object);
return $recipients;
}
/**
* Returns event enrollment owner.
*
* @param \Drupal\social_event\EventEnrollmentInterface $event_enrollment
* Event enrollment object.
* @param array $data
* The data.
*
* @return array
* An associative array of recipients, containing the following key-value
* pairs:
* - target_type: The entity type ID.
* - target_id: The entity ID.
*/
public function getEventEnrollmentOwner(EventEnrollmentInterface $event_enrollment, array $data) {
$recipients[] = [
'target_type' => 'user',
'target_id' => $event_enrollment
->get('field_account')
->getValue()[0]['target_id'],
];
return $recipients;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ActivityContextBase:: |
protected | property | The activity factory service. | |
ActivityContextBase:: |
private | property | The entity query. | |
ActivityContextBase:: |
protected | property | The entity type manager. | |
ActivityContextBase:: |
public | function | Returns recipients from post. | |
ActivityContextBase:: |
public | function |
Determines if the entity is valid for this context. Overrides ActivityContextInterface:: |
11 |
EventRequestActivityContext:: |
protected | property | The module handler. | |
EventRequestActivityContext:: |
public static | function |
Creates an instance of the plugin. Overrides ActivityContextBase:: |
|
EventRequestActivityContext:: |
public | function | Returns event enrollment owner. | |
EventRequestActivityContext:: |
public | function | Returns Organizer recipient from Events. | |
EventRequestActivityContext:: |
public | function |
Returns a batched list of recipients for this context. Overrides ActivityContextBase:: |
|
EventRequestActivityContext:: |
public | function |
Constructs a EventRequestActivityContext object. Overrides ActivityContextBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. |