class OwnerActivityContext in Open Social 10.0.x

Provides a 'OwnerActivityContext' activity context.

Plugin annotation

@ActivityContext(
  id = "owner_activity_context",
  label = @Translation("Owner 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\OwnerActivityContext

File

modules/custom/activity_basics/src/Plugin/ActivityContext/OwnerActivityContext.php, line 15

Namespace

Drupal\activity_basics\Plugin\ActivityContext

class OwnerActivityContext extends ActivityContextBase {

  /**
   * {@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);
      $allowed_entity_types = [
        'node',
        'post',
        'comment',
      ];
      if (in_array($related_entity['target_type'], $allowed_entity_types)) {
        $recipients += $this
          ->getRecipientOwnerFromEntity($related_entity, $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 owner recipient from entity.
   *
   * @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.
   */
  public function getRecipientOwnerFromEntity(array $related_entity, array $data) {
    $recipients = [];
    $entity_storage = $this->entityTypeManager
      ->getStorage($related_entity['target_type']);
    $entity = $entity_storage
      ->load($related_entity['target_id']);

    // It could happen that a notification has been queued but the content
    // has since been deleted. In that case we can find no additional
    // recipients.
    if (!$entity) {
      return $recipients;
    }

    // Don't return recipients if user comments on own content.
    $original_related_object = $data['related_object'][0];
    if (isset($original_related_object['target_type']) && $original_related_object['target_type'] === 'comment') {
      $storage = $this->entityTypeManager
        ->getStorage($original_related_object['target_type']);
      $original_related_entity = $storage
        ->load($original_related_object['target_id']);
      if (!empty($original_related_entity) && $original_related_entity
        ->getOwnerId() === $entity
        ->getOwnerId()) {
        return $recipients;
      }
    }
    if (isset($original_related_object['target_type']) && $original_related_object['target_type'] === 'event_enrollment') {
      $storage = $this->entityTypeManager
        ->getStorage($original_related_object['target_type']);
      $original_related_entity = $storage
        ->load($original_related_object['target_id']);

      // In the case where a user is added by an event manager we'll need to
      // check on the enrollment status. If the user is not really enrolled we
      // should skip sending the notification.
      if ($original_related_entity
        ->get('field_enrollment_status')->value === '0') {
        return $recipients;
      }
      if (!empty($original_related_entity) && $original_related_entity
        ->getAccount() !== NULL) {
        $recipients[] = [
          'target_type' => 'user',
          'target_id' => $original_related_entity
            ->getAccount(),
        ];
        return $recipients;
      }
    }
    $recipients[] = [
      'target_type' => 'user',
      'target_id' => $entity
        ->getOwnerId(),
    ];
    return $recipients;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActivityContextBase::$activityFactory	protected	property	The activity factory service.
ActivityContextBase::$entityQuery	private	property	The entity query.
ActivityContextBase::$entityTypeManager	protected	property	The entity type manager.
ActivityContextBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	7
ActivityContextBase::getRecipientsFromPost	public	function	Returns recipients from post.
ActivityContextBase::isValidEntity	public	function	Determines if the entity is valid for this context. Overrides ActivityContextInterface::isValidEntity	11
ActivityContextBase::__construct	public	function	ActivityContextBase constructor. Overrides PluginBase::__construct	7
OwnerActivityContext::getRecipientOwnerFromEntity	public	function	Returns owner recipient from entity.
OwnerActivityContext::getRecipients	public	function	Returns a batched list of recipients for this context. Overrides ActivityContextBase::getRecipients
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	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.