You are here

class EntityTestAccessControlHandler in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/system/tests/modules/entity_test/src/EntityTestAccessControlHandler.php \Drupal\entity_test\EntityTestAccessControlHandler
  2. 9 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');
        }
      }
      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');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::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.
EntityAccessControlHandler::__construct public function Constructs an access control handler instance. 6
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.
EntityTestAccessControlHandler::$viewLabelOperation protected property Allows to grant access to just the labels. Overrides EntityAccessControlHandler::$viewLabelOperation
EntityTestAccessControlHandler::checkAccess protected function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
EntityTestAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.