class EntityTestAccessControlHandler

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

Defines the access control handler for the test entity type.

Hierarchy

Expanded class hierarchy of EntityTestAccessControlHandler

See also

\Drupal\entity_test\Entity\EntityTest

\Drupal\entity_test\Entity\EntityTestBaseFieldDisplay

\Drupal\entity_test\Entity\EntityTestCache

\Drupal\entity_test\Entity\EntityTestMul

\Drupal\entity_test\Entity\EntityTestMulRev

\Drupal\entity_test\Entity\EntityTestRev

\Drupal\entity_test\Entity\EntityTestWithBundle

\Drupal\entity_test\Entity\EntityTestStringId

File

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

Namespace

Drupal\entity_test
View source
class EntityTestAccessControlHandler extends EntityAccessControlHandler {
  
  /**
   * Allows to grant access to just the labels.
   *
   * @var bool
   */
  protected $viewLabelOperation = TRUE;
  
  /**
   * {@inheritdoc}
   */
  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();
  }
  
  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    return AccessResult::allowedIfHasPermissions($account, [
      'administer entity_test content',
      'administer entity_test_with_bundle content',
      'create ' . $entity_bundle . ' entity_test_with_bundle entities',
    ], 'OR');
  }

}

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