UncacheableEntityAccessControlHandler.php in Entity API 8

Namespace

Drupal\entity

File

src/UncacheableEntityAccessControlHandler.php

<?php

namespace Drupal\entity;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityPublishedInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Session\AccountInterface;

/**
 * Controls access based on the uncacheable entity permissions.
 *
 * @see \Drupal\entity\UncacheableEntityPermissionProvider
 *
 * Note: this access control handler will cause pages to be cached per user.
 */
class UncacheableEntityAccessControlHandler extends EntityAccessControlHandlerBase {

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityTypeInterface $entity_type) {
    parent::__construct($entity_type);
    if (!$entity_type
      ->hasHandlerClass('permission_provider') || !is_a($entity_type
      ->getHandlerClass('permission_provider'), UncacheableEntityPermissionProvider::class, TRUE)) {
      throw new \Exception('\\Drupal\\entity\\UncacheableEntityAccessControlHandler requires the \\Drupal\\entity\\UncacheableEntityPermissionProvider permission provider.');
    }
  }

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

    /** @var \Drupal\user\EntityOwnerInterface $entity */
    if ($operation === 'view' && $entity instanceof EntityPublishedInterface && !$entity
      ->isPublished()) {
      if ($account
        ->id() != $entity
        ->getOwnerId()) {

        // There's no permission for viewing other user's unpublished entity.
        return AccessResult::neutral()
          ->cachePerUser();
      }
      $permissions = [
        "view own unpublished {$entity->getEntityTypeId()}",
      ];
      $result = AccessResult::allowedIfHasPermissions($account, $permissions)
        ->cachePerUser();
    }
    else {
      $result = parent::checkEntityOwnerPermissions($entity, $operation, $account);
    }
    return $result;
  }

}

Classes

Name	Description
UncacheableEntityAccessControlHandler	Controls access based on the uncacheable entity permissions.