trait ResourceIdentifierTrait

Same name and namespace in other branches
  1. 9 core/modules/jsonapi/src/JsonApiResource/ResourceIdentifierTrait.php \Drupal\jsonapi\JsonApiResource\ResourceIdentifierTrait
  2. 10 core/modules/jsonapi/src/JsonApiResource/ResourceIdentifierTrait.php \Drupal\jsonapi\JsonApiResource\ResourceIdentifierTrait
  3. 11.x core/modules/jsonapi/src/JsonApiResource/ResourceIdentifierTrait.php \Drupal\jsonapi\JsonApiResource\ResourceIdentifierTrait

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

@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.

Hierarchy

See also

https://www.drupal.org/project/drupal/issues/3032787

jsonapi.api.php

\Drupal\jsonapi\JsonApiResource\ResourceIdentifierInterface

1 file declares its use of ResourceIdentifierTrait
EntityAccessDeniedHttpException.php in core/modules/jsonapi/src/Exception/EntityAccessDeniedHttpException.php

File

core/modules/jsonapi/src/JsonApiResource/ResourceIdentifierTrait.php, line 16

Namespace

Drupal\jsonapi\JsonApiResource
View source 
trait ResourceIdentifierTrait {
    
    /**
     * A ResourceIdentifier object.
     *
     * @var \Drupal\jsonapi\JsonApiResource\ResourceIdentifier
     */
    protected $resourceIdentifier;
    
    /**
     * The JSON:API resource type of the identified resource object.
     *
     * @var \Drupal\jsonapi\ResourceType\ResourceType
     */
    protected $resourceType;
    
    /**
     * {@inheritdoc}
     */
    public function getId() {
        return $this->resourceIdentifier
            ->getId();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTypeName() {
        return $this->resourceIdentifier
            ->getTypeName();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getResourceType() {
        if (!isset($this->resourceType)) {
            $this->resourceType = $this->resourceIdentifier
                ->getResourceType();
        }
        return $this->resourceType;
    }

}

Members

Title Modifiers Object type Summary
ResourceIdentifierTrait::$resourceIdentifier protected property A ResourceIdentifier object.
ResourceIdentifierTrait::$resourceType protected property The JSON:API resource type of the identified resource object.
ResourceIdentifierTrait::getId public function
ResourceIdentifierTrait::getResourceType public function
ResourceIdentifierTrait::getTypeName public function

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