class PrivateMessageActivityContext in Open Social 10.1.x

Provides a 'PrivateMessageActivityContext' activity context.

Plugin annotation

@ActivityContext(
  id = "private_message_activity_context",
  label = @Translation("Private message activity context"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\activity_creator\Plugin\ActivityContextBase implements ActivityContextInterface, ContainerFactoryPluginInterface
    • class \Drupal\social_private_message\Plugin\ActivityContext\PrivateMessageActivityContext

File

modules/social_features/social_private_message/src/Plugin/ActivityContext/PrivateMessageActivityContext.php, line 24

Namespace

Drupal\social_private_message\Plugin\ActivityContext

class PrivateMessageActivityContext extends ActivityContextBase {

  /**
   * The private message service.
   *
   * @var \Drupal\private_message\Service\PrivateMessageServiceInterface
   */
  protected $privateMessageService;

  /**
   * PrivateMessageActivityContext constructor.
   *
   * @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 entity query.
   * @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\private_message\Service\PrivateMessageServiceInterface $private_message_service
   *   The private message service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, QueryFactory $entity_query, EntityTypeManagerInterface $entity_type_manager, ActivityFactory $activity_factory, PrivateMessageServiceInterface $private_message_service) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_query, $entity_type_manager, $activity_factory);
    $this->privateMessageService = $private_message_service;
  }

  /**
   * {@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('private_message.service'));
  }

  /**
   * {@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_object = $data['related_object'][0];
      if ($related_object['target_type'] === 'private_message') {
        $related_object = $data['related_object'][0];
        if ($related_object['target_type'] === 'private_message') {
          $private_message = $this->entityTypeManager
            ->getStorage('private_message')
            ->load($related_object['target_id']);

          // Must be a Private Message.
          if ($private_message instanceof PrivateMessageInterface) {

            // Get the thread of this message.
            $thread = $this->privateMessageService
              ->getThreadFromMessage($private_message);
            if ($thread instanceof PrivateMessageThreadInterface) {

              // Get all members of this thread.

              /** @var \Drupal\private_message\Entity\PrivateMessageThreadInterface $members */
              $members = $thread
                ->getMembers();

              // Loop over all PMT participants.
              foreach ($members as $member) {
                if ($member instanceof UserInterface) {

                  // Filter out the author of this message.
                  if ($member
                    ->id() == $data['actor']) {
                    continue;
                  }

                  // Continue if member have permission to view private message.
                  if (!$member
                    ->hasPermission('use private messaging system')) {
                    continue;
                  }

                  // Create the recipients array.
                  $recipients[] = [
                    'target_type' => 'user',
                    'target_id' => $member
                      ->id(),
                  ];
                }
              }
            }
          }
        }
      }
    }
    return $recipients;
  }

  /**
   * {@inheritdoc}
   */
  public function isValidEntity(EntityInterface $entity) {
    return $entity
      ->getEntityTypeId() === 'private_message';
  }

}

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::getRecipientsFromPost	public	function	Returns recipients from post.
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.
PrivateMessageActivityContext::$privateMessageService	protected	property	The private message service.
PrivateMessageActivityContext::create	public static	function	Creates an instance of the plugin. Overrides ActivityContextBase::create
PrivateMessageActivityContext::getRecipients	public	function	Returns a batched list of recipients for this context. Overrides ActivityContextBase::getRecipients
PrivateMessageActivityContext::isValidEntity	public	function	Determines if the entity is valid for this context. Overrides ActivityContextBase::isValidEntity
PrivateMessageActivityContext::__construct	public	function	PrivateMessageActivityContext constructor. Overrides ActivityContextBase::__construct