abstract class ActivityContextBase in Open Social 8.2

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

9 files declare their use of ActivityContextBase

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

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

FollowContentActivityContext.php in modules/social_features/social_follow_content/src/Plugin/ActivityContext/FollowContentActivityContext.php

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

MentionActivityContext.php in modules/social_features/social_mentions/src/Plugin/ActivityContext/MentionActivityContext.php

... See full list

File

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

Namespace

Drupal\activity_creator\Plugin

abstract class ActivityContextBase extends PluginBase implements ActivityContextInterface, ContainerFactoryPluginInterface {

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

  /**
   * Entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  private $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, QueryFactory $entity_query, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityQuery = $entity_query;
    $this->entityTypeManager = $entity_type_manager;
  }

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

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

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

  /**
   * Returns recipients from post.
   */
  public function getRecipientsFromPost(array $referenced_entity) {
    $recipients = [];
    $post = Post::load($referenced_entity['target_id']);
    $recipient_user = $post
      ->get('field_recipient_user')
      ->getValue();
    if (!empty($recipient_user)) {
      $recipients[] = [
        'target_type' => 'user',
        'target_id' => $recipient_user['0']['target_id'],
      ];
    }
    return $recipients;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActivityContextBase::$entityQuery	private	property	Entity query.
ActivityContextBase::$entityTypeManager	private	property	Entity type manager.
ActivityContextBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ActivityContextBase::getRecipients	public	function	Returns a batched list of recipients for this context. Overrides ActivityContextInterface::getRecipients	9
ActivityContextBase::getRecipientsFromPost	public	function	Returns recipients from post.
ActivityContextBase::isValidEntity	public	function	Determines if the entity is valid for this context. Overrides ActivityContextInterface::isValidEntity	7
ActivityContextBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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	3
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.