function EntityTestAccessControlHandler::checkAccess

Same name and namespace in other branches
  1. 8.9.x core/modules/system/tests/modules/entity_test/src/EntityTestAccessControlHandler.php \Drupal\entity_test\EntityTestAccessControlHandler::checkAccess()
  2. 10 core/modules/system/tests/modules/entity_test/src/EntityTestAccessControlHandler.php \Drupal\entity_test\EntityTestAccessControlHandler::checkAccess()
  3. 11.x core/modules/system/tests/modules/entity_test/src/EntityTestAccessControlHandler.php \Drupal\entity_test\EntityTestAccessControlHandler::checkAccess()

Performs access checks.

This method is supposed to be overwritten by extending classes that do their own custom access checking.

Parameters

\Drupal\Core\Entity\EntityInterface $entity: The entity for which to check access.

string $operation: The entity operation. Usually one of 'view', 'view label', 'update' or 'delete'.

\Drupal\Core\Session\AccountInterface $account: The user for which to check access.

Return value

\Drupal\Core\Access\AccessResultInterface The access result.

Overrides EntityAccessControlHandler::checkAccess

File

core/modules/system/tests/modules/entity_test/src/EntityTestAccessControlHandler.php, line 36

Class

EntityTestAccessControlHandler
Defines the access control handler for the test entity type.

Namespace

Drupal\entity_test

Code

protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
    
    /** @var \Drupal\entity_test\Entity\EntityTest $entity */
    // Always forbid access to entities with the label 'forbid_access', used for
    // \Drupal\system\Tests\Entity\EntityAccessControlHandlerTest::testDefaultEntityAccess().
    if ($entity->label() == 'forbid_access') {
        return AccessResult::forbidden();
    }
    if ($operation === 'view label' && $entity instanceof EntityTestLabel) {
        // Viewing the label of the 'entity_test_label' entity type is allowed.
        return AccessResult::allowed();
    }
    elseif (in_array($operation, [
        'view',
        'view label',
    ])) {
        if (!$entity->isDefaultTranslation()) {
            if ($entity instanceof EntityPublishedInterface && !$entity->isPublished()) {
                return AccessResult::allowedIfHasPermission($account, 'view unpublished test entity translations');
            }
            else {
                return AccessResult::allowedIfHasPermission($account, 'view test entity translations');
            }
        }
        if ($entity instanceof EntityPublishedInterface && !$entity->isPublished()) {
            return AccessResult::neutral('Unpublished entity');
        }
        return AccessResult::allowedIfHasPermission($account, 'view test entity');
    }
    elseif (in_array($operation, [
        'update',
        'delete',
    ])) {
        $access = AccessResult::allowedIfHasPermission($account, 'administer entity_test content');
        if (!$access->isAllowed() && $operation === 'update' && $account->hasPermission('edit own entity_test content')) {
            $access = $access->orIf(AccessResult::allowedIf($entity->getOwnerId() === $account->id()))
                ->cachePerUser()
                ->addCacheableDependency($entity);
        }
        return $access;
    }
    // No opinion.
    return AccessResult::neutral();
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.