class ActivityAccessControlHandler in Open Social 10.3.x

Access controller for the Activity entity.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\activity_creator\ActivityAccessControlHandler implements EntityHandlerInterface

See also

\Drupal\activity_creator\Entity\Activity.

File

modules/custom/activity_creator/src/ActivityAccessControlHandler.php, line 21

Namespace

Drupal\activity_creator

class ActivityAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {

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

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager'));
  }

  /**
   * PostAccessControlHandler constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type interface.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entityTypeManager) {
    parent::__construct($entity_type);
    $this->entityTypeManager = $entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {

    /** @var \Drupal\activity_creator\ActivityInterface $entity */
    switch ($operation) {
      case 'view':
        $recipient = $entity
          ->getRecipient();
        if ($recipient === NULL) {

          // This is simple, the message is not specific for group / user.
          // So we should check, does the user have permission to view entity?
          return $this
            ->returnAccessRelatedObject($entity, $operation, $account);
        }
        $recipient_type = $recipient['0']['target_type'];
        if ($recipient_type === 'user') {
          $recipient_id = $recipient['0']['target_id'];

          // If it is personalised, lets check recipient id vs account id.
          if ($this
            ->checkIfPersonalNotification($entity) === TRUE) {
            return AccessResult::allowedIf($account
              ->id() === $recipient_id);
          }

          // Lets fallback to the related object access permission.
          return $this
            ->returnAccessRelatedObject($entity, $operation, $account);
        }
        return AccessResult::allowedIfHasPermission($account, 'view all published activity entities');
      case 'update':
        return AccessResult::allowedIfHasPermission($account, 'edit activity entities');
      case 'delete':
        return AccessResult::allowedIfHasPermission($account, 'delete activity entities');
    }

    // Unknown operation, no opinion.
    return AccessResult::neutral();
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    return AccessResult::allowedIfHasPermission($account, 'add activity entities');
  }

  /**
   * Return access control from the related entity.
   */
  protected function returnAccessRelatedObject(EntityInterface $entity, $operation, $account) {
    $related_object = $entity
      ->get('field_activity_entity')
      ->getValue();
    if (!empty($related_object)) {
      $ref_entity_type = $related_object['0']['target_type'];
      $ref_entity_id = $related_object['0']['target_id'];
      try {

        /** @var \Drupal\Core\Entity\EntityInterface $ref_entity */
        $ref_entity = $this->entityTypeManager
          ->getStorage($ref_entity_type)
          ->load($ref_entity_id);
      } catch (InvalidPluginDefinitionException|PluginNotFoundException $e) {
        return AccessResult::neutral(sprintf('No opinion on access due to: %s', $e
          ->getMessage()));
      }
      return AccessResult::allowedIf($ref_entity
        ->access($operation, $account));
    }
    return AccessResult::neutral('No opinion on access due to: no related object found');
  }

  /**
   * Check if this is a personal notification.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   Entity object.
   *
   * @return bool
   *   Returns TRUE if entity is personal notification, FALSE if it isn't.
   */
  protected function checkIfPersonalNotification(EntityInterface $entity) {
    $recipient = $entity
      ->getRecipient();
    $value = FALSE;
    if (!empty($recipient) && $recipient['0']['target_type'] === 'user') {

      // This could be personalised, but first lets check the destinations.
      $destinations = $entity
        ->getDestinations();
      $is_notification = in_array('notifications', $destinations, TRUE);

      // It is only personal if the only destination is notifications.
      if ($is_notification === TRUE && count($destinations) <= 1) {
        $value = TRUE;
      }
    }
    return $value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActivityAccessControlHandler::$entityTypeManager	protected	property	The entity type manager.
ActivityAccessControlHandler::checkAccess	protected	function	Performs access checks. Overrides EntityAccessControlHandler::checkAccess
ActivityAccessControlHandler::checkCreateAccess	protected	function	Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
ActivityAccessControlHandler::checkIfPersonalNotification	protected	function	Check if this is a personal notification.
ActivityAccessControlHandler::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
ActivityAccessControlHandler::returnAccessRelatedObject	protected	function	Return access control from the related entity.
ActivityAccessControlHandler::__construct	public	function	PostAccessControlHandler constructor. Overrides EntityAccessControlHandler::__construct
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityAccessControlHandler::$accessCache	protected	property	Stores calculated access check results.
EntityAccessControlHandler::$entityType	protected	property	Information about the entity type.
EntityAccessControlHandler::$entityTypeId	protected	property	The entity type ID of the access control handler instance.
EntityAccessControlHandler::$viewLabelOperation	protected	property	Allows to grant access to just the labels.	5
EntityAccessControlHandler::access	public	function	Checks access to an operation on a given entity or entity translation. Overrides EntityAccessControlHandlerInterface::access	1
EntityAccessControlHandler::checkFieldAccess	protected	function	Default field access as determined by this access control handler.	4
EntityAccessControlHandler::createAccess	public	function	Checks access to create an entity. Overrides EntityAccessControlHandlerInterface::createAccess	1
EntityAccessControlHandler::fieldAccess	public	function	Checks access to an operation on a given entity field. Overrides EntityAccessControlHandlerInterface::fieldAccess
EntityAccessControlHandler::getCache	protected	function	Tries to retrieve a previously cached access value from the static cache.
EntityAccessControlHandler::prepareUser	protected	function	Loads the current account object, if it does not exist yet.
EntityAccessControlHandler::processAccessHookResults	protected	function	We grant access to the entity if both of these conditions are met:
EntityAccessControlHandler::resetCache	public	function	Clears all cached access checks. Overrides EntityAccessControlHandlerInterface::resetCache
EntityAccessControlHandler::setCache	protected	function	Statically caches whether the given user has access.
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	5
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	5
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.