EntityAccessControlHandlerBase.php in Entity API 8

Namespace

Drupal\entity

File

src/EntityAccessControlHandlerBase.php

<?php

namespace Drupal\entity;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Entity\EntityAccessControlHandler as CoreEntityAccessControlHandler;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\user\EntityOwnerInterface;

/**
 * @internal
 */
class EntityAccessControlHandlerBase extends CoreEntityAccessControlHandler {

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
    $account = $this
      ->prepareUser($account);

    /** @var \Drupal\Core\Access\AccessResult $result */
    $result = parent::checkAccess($entity, $operation, $account);
    if ($result
      ->isNeutral()) {
      if ($entity instanceof EntityOwnerInterface) {
        $result = $this
          ->checkEntityOwnerPermissions($entity, $operation, $account);
      }
      else {
        $result = $this
          ->checkEntityPermissions($entity, $operation, $account);
      }
    }

    // Ensure that access is evaluated again when the entity changes.
    return $result
      ->addCacheableDependency($entity);
  }

  /**
   * Checks the entity operation and bundle permissions.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity for which to check access.
   * @param string $operation
   *   The entity operation. Usually one of 'view', 'view label', 'update',
   *   'duplicate' or 'delete'.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user for which to check access.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  protected function checkEntityPermissions(EntityInterface $entity, $operation, AccountInterface $account) {
    $permissions = [
      "{$operation} {$entity->getEntityTypeId()}",
      "{$operation} {$entity->bundle()} {$entity->getEntityTypeId()}",
    ];
    return AccessResult::allowedIfHasPermissions($account, $permissions, 'OR');
  }

  /**
   * Checks the entity operation and bundle permissions, with owners.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity for which to check access.
   * @param string $operation
   *   The entity operation. Usually one of 'view', 'view label', 'update',
   *   'duplicate' or 'delete'.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user for which to check access.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  protected function checkEntityOwnerPermissions(EntityInterface $entity, $operation, AccountInterface $account) {

    /** @var \Drupal\user\EntityOwnerInterface $entity */

    // The "any" permission grants access regardless of the entity owner.
    $any_result = AccessResult::allowedIfHasPermissions($account, [
      "{$operation} any {$entity->getEntityTypeId()}",
      "{$operation} any {$entity->bundle()} {$entity->getEntityTypeId()}",
    ], 'OR');
    if ($any_result
      ->isAllowed()) {
      return $any_result;
    }
    if ($account
      ->id() == $entity
      ->getOwnerId()) {
      $own_result = AccessResult::allowedIfHasPermissions($account, [
        "{$operation} own {$entity->getEntityTypeId()}",
        "{$operation} own {$entity->bundle()} {$entity->getEntityTypeId()}",
      ], 'OR');
    }
    else {
      $own_result = AccessResult::neutral()
        ->cachePerPermissions();
    }

    // The "own" permission is based on the current user's ID, so the result
    // must be cached per user.
    return $own_result
      ->cachePerUser();
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    $result = parent::checkCreateAccess($account, $context, $entity_bundle);
    if ($result
      ->isNeutral()) {
      $permissions = [
        $this->entityType
          ->getAdminPermission() ?: 'administer ' . $this->entityTypeId,
        'create ' . $this->entityTypeId,
      ];
      if ($entity_bundle) {
        $permissions[] = 'create ' . $entity_bundle . ' ' . $this->entityTypeId;
      }
      $result = AccessResult::allowedIfHasPermissions($account, $permissions, 'OR');
    }
    return $result;
  }

}

Classes

Name	Description
EntityAccessControlHandlerBase	@internal