abstract class ActivityContextBase in Open Social 10.3.x

Base class for Activity context plugin plugins.

Hierarchy

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

18 files declare their use of ActivityContextBase

ApprovedRequestJoinGroupActivityContext.php in modules/social_features/social_group/modules/social_group_request/src/Plugin/ActivityContext/ApprovedRequestJoinGroupActivityContext.php

CommunityActivityContext.php in modules/custom/activity_basics/src/Plugin/ActivityContext/CommunityActivityContext.php

ContentInMyGroupActivityContext.php in modules/custom/activity_basics/src/Plugin/ActivityContext/ContentInMyGroupActivityContext.php

ContentReportActivityContext.php in modules/social_features/social_content_report/src/Plugin/ActivityContext/ContentReportActivityContext.php

EventInviteActivityContext.php in modules/social_features/social_event/modules/social_event_invite/src/Plugin/ActivityContext/EventInviteActivityContext.php

... See full list

File

modules/custom/activity_creator/src/Plugin/ActivityContextBase.php, line 16

Namespace

Drupal\activity_creator\Plugin

abstract class ActivityContextBase extends PluginBase implements ActivityContextInterface, ContainerFactoryPluginInterface {

  /**
   * The entity query.
   *
   * @var \Drupal\Core\Entity\Query\Sql\QueryFactory
   */
  private $entityQuery;

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

  /**
   * The activity factory service.
   *
   * @var \Drupal\activity_creator\ActivityFactory
   */
  protected $activityFactory;

  /**
   * ActivityContextBase 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.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, QueryFactory $entity_query, EntityTypeManagerInterface $entity_type_manager, ActivityFactory $activity_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityQuery = $entity_query;
    $this->entityTypeManager = $entity_type_manager;
    $this->activityFactory = $activity_factory;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getRecipients(array $data, $last_uid, $limit) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function isValidEntity(EntityInterface $entity) {
    return TRUE;
  }

  /**
   * Returns recipients from post.
   *
   * @param array $referenced_entity
   *   The referenced entity.
   *
   * @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 getRecipientsFromPost(array $referenced_entity) {
    $recipients = [];
    $post = $this->entityTypeManager
      ->getStorage('post')
      ->load($referenced_entity['target_id']);
    if ($post !== NULL && !$post->field_recipient_user
      ->isEmpty()) {
      $recipients[] = [
        'target_type' => 'user',
        'target_id' => $post->field_recipient_user->target_id,
      ];
    }
    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::getRecipients	public	function	Returns a batched list of recipients for this context. Overrides ActivityContextInterface::getRecipients	18
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
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.