class UncacheableEntityAccessControlHandler in Entity API 8
Controls access based on the uncacheable entity permissions.
Note: this access control handler will cause pages to be cached per user.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
- class \Drupal\entity\EntityAccessControlHandlerBase
- class \Drupal\entity\UncacheableEntityAccessControlHandler
- class \Drupal\entity\EntityAccessControlHandlerBase
- class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
Expanded class hierarchy of UncacheableEntityAccessControlHandler
See also
\Drupal\entity\UncacheableEntityPermissionProvider
1 file declares its use of UncacheableEntityAccessControlHandler
File
- src/
UncacheableEntityAccessControlHandler.php, line 18
Namespace
Drupal\entityView source
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;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityAccessControlHandler:: |
protected | property | Stores calculated access check results. | |
EntityAccessControlHandler:: |
protected | property | Information about the entity type. | |
EntityAccessControlHandler:: |
protected | property | The entity type ID of the access control handler instance. | |
EntityAccessControlHandler:: |
protected | property | Allows to grant access to just the labels. | 5 |
EntityAccessControlHandler:: |
public | function |
Checks access to an operation on a given entity or entity translation. Overrides EntityAccessControlHandlerInterface:: |
1 |
EntityAccessControlHandler:: |
protected | function | Default field access as determined by this access control handler. | 4 |
EntityAccessControlHandler:: |
public | function |
Checks access to create an entity. Overrides EntityAccessControlHandlerInterface:: |
1 |
EntityAccessControlHandler:: |
public | function |
Checks access to an operation on a given entity field. Overrides EntityAccessControlHandlerInterface:: |
|
EntityAccessControlHandler:: |
protected | function | Tries to retrieve a previously cached access value from the static cache. | |
EntityAccessControlHandler:: |
protected | function | Loads the current account object, if it does not exist yet. | |
EntityAccessControlHandler:: |
protected | function | We grant access to the entity if both of these conditions are met: | |
EntityAccessControlHandler:: |
public | function |
Clears all cached access checks. Overrides EntityAccessControlHandlerInterface:: |
|
EntityAccessControlHandler:: |
protected | function | Statically caches whether the given user has access. | |
EntityAccessControlHandlerBase:: |
protected | function |
Performs access checks. Overrides EntityAccessControlHandler:: |
|
EntityAccessControlHandlerBase:: |
protected | function |
Performs create access checks. Overrides EntityAccessControlHandler:: |
|
EntityAccessControlHandlerBase:: |
protected | function | Checks the entity operation and bundle permissions. | |
EntityHandlerBase:: |
protected | property | The module handler to invoke hooks on. | 2 |
EntityHandlerBase:: |
protected | function | Gets the module handler. | 2 |
EntityHandlerBase:: |
public | function | Sets the module handler for this handler. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UncacheableEntityAccessControlHandler:: |
protected | function |
Checks the entity operation and bundle permissions, with owners. Overrides EntityAccessControlHandlerBase:: |
|
UncacheableEntityAccessControlHandler:: |
public | function |
Constructs an access control handler instance. Overrides EntityAccessControlHandler:: |