1. class
  2. Drupal
  3. \
  4. jsonapi
  5. \
  6. Exception
  7. \
  8. EntityAccessDeniedHttpException

EntityAccessDeniedHttpException

class EntityAccessDeniedHttpException extends CacheableAccessDeniedHttpException implements ResourceIdentifierInterface (View source)

internal  JSON:API maintains no PHP API. The API is the HTTP API. This class may change at any time and could break any dependencies on it.
 

Enhances the access denied exception with information about the entity.

Traits

DependencySerializationTrait

Provides dependency injection friendly methods for serialization.

ResourceIdentifierTrait

Used to associate an object like an exception to a particular resource.

CacheableDependencyTrait

Trait for \Drupal\Core\Cache\CacheableDependencyInterface.

Properties

protected string[] $cacheContexts

Cache contexts.

 from  CacheableDependencyTrait
protected string[] $cacheTags

Cache tags.

 from  CacheableDependencyTrait
protected int $cacheMaxAge

Cache max-age.

 from  CacheableDependencyTrait
protected array $_serviceIds

An array of service IDs keyed by property name used for serialization.

 from  DependencySerializationTrait
protected array $_entityStorages

An array of entity type IDs keyed by the property name of their storages.

 from  DependencySerializationTrait
protected ResourceIdentifier $resourceIdentifier

A ResourceIdentifier object.

 from  ResourceIdentifierTrait
protected ResourceType $resourceType

The JSON:API resource type of the identified resource object.

 from  ResourceIdentifierTrait
protected array $error

The error which caused the 403.

Methods

$this
setCacheability(CacheableDependencyInterface $cacheability)

Sets cacheability; useful for value object constructors.

from  CacheableDependencyTrait
getCacheTags()

{@inheritdoc}

from  CacheableDependencyTrait
getCacheContexts()

{@inheritdoc}

from  CacheableDependencyTrait
getCacheMaxAge()

{@inheritdoc}

from  CacheableDependencyTrait
__construct(EntityInterface|null $entity, AccessResultInterface $entity_access, string $pointer, $message = 'The current user is not allowed to GET the selected resource.', string $relationship_field = NULL, Exception $previous = NULL, $code = 0)

EntityAccessDeniedHttpException constructor.

__sleep()

{@inheritdoc}

from  DependencySerializationTrait
__wakeup()

{@inheritdoc}

from  DependencySerializationTrait
getId()

{@inheritdoc}

from  ResourceIdentifierTrait
getTypeName()

{@inheritdoc}

from  ResourceIdentifierTrait
getResourceType()

{@inheritdoc}

from  ResourceIdentifierTrait
array
getError()

Returns the error.

Details

in CacheableDependencyTrait at line 39
protected $this setCacheability(CacheableDependencyInterface $cacheability)

Sets cacheability; useful for value object constructors.

Parameters

CacheableDependencyInterface $cacheability

The cacheability to set.

Return Value

$this

in CacheableDependencyTrait at line 49
getCacheTags()

{@inheritdoc}

in CacheableDependencyTrait at line 56
getCacheContexts()

{@inheritdoc}

in CacheableDependencyTrait at line 63
getCacheMaxAge()

{@inheritdoc}

at line 61
__construct(EntityInterface|null $entity, AccessResultInterface $entity_access, string $pointer, $message = 'The current user is not allowed to GET the selected resource.', string $relationship_field = NULL, Exception $previous = NULL, $code = 0)

EntityAccessDeniedHttpException constructor.

Parameters

EntityInterface|null $entity

The entity, or NULL when an entity is being created.
AccessResultInterface $entity_access

The access result.
string $pointer

(optional) The pointer.
$message
string $relationship_field

(Optional) A relationship field name if access was denied because the user does not have permission to view an entity's relationship field.
Exception $previous
$code

in DependencySerializationTrait at line 32
__sleep()

{@inheritdoc}

in DependencySerializationTrait at line 67
__wakeup()

{@inheritdoc}

in ResourceIdentifierTrait at line 35
getId()

{@inheritdoc}

in ResourceIdentifierTrait at line 42
getTypeName()

{@inheritdoc}

in ResourceIdentifierTrait at line 49
getResourceType()

{@inheritdoc}

at line 84
array getError()

Returns the error.

Return Value

array

The error.