class GroupActivityContext in Open Social 8.8

Provides a 'GroupActivityContext' activity context.

Plugin annotation

@ActivityContext(
  id = "group_activity_context",
  label = @Translation("Group 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\GroupActivityContext

File

modules/custom/activity_basics/src/Plugin/ActivityContext/GroupActivityContext.php, line 18

Namespace

Drupal\activity_basics\Plugin\ActivityContext

class GroupActivityContext 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'])) {
      $referenced_entity = $data['related_object']['0'];
      try {

        // TODO: Replace this with dependency injection.

        /** @var \Drupal\social_group\SocialGroupHelperService $group_helper */
        $group_helper = \Drupal::service('social_group.helper_service');
      } catch (PluginNotFoundException $e) {
        return $recipients;
      }
      if ($gid = $group_helper
        ->getGroupFromEntity($referenced_entity, FALSE)) {
        $recipients[] = [
          'target_type' => 'group',
          'target_id' => $gid,
        ];
      }
    }
    return $recipients;
  }

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

    // Special cases for comments.
    if ($entity
      ->getEntityTypeId() === 'comment') {

      // Returns the entity to which the comment is attached.
      $entity = $entity
        ->getCommentedEntity();
    }
    if (!isset($entity)) {
      return FALSE;
    }

    // Check if it's placed in a group (regardless off content type).
    if (GroupContent::loadByEntity($entity)) {
      return TRUE;
    }
    if ($entity
      ->getEntityTypeId() === 'post') {
      if (!$entity->field_recipient_group
        ->isEmpty()) {
        return TRUE;
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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	3
ActivityContextBase::getRecipientsFromPost	public	function	Returns recipients from post.
ActivityContextBase::__construct	public	function	ActivityContextBase constructor. Overrides PluginBase::__construct	3
GroupActivityContext::getRecipients	public	function	Returns a batched list of recipients for this context. Overrides ActivityContextBase::getRecipients
GroupActivityContext::isValidEntity	public	function	Determines if the entity is valid for this context. Overrides ActivityContextBase::isValidEntity
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.