interface ResourceIdentifierInterface in JSON:API 8.2

An interface for identifying a related resource.

Implement this interface when an object is a stand-in for an Entity object. For example, \Drupal\jsonapi\Exception\EntityAccessDeniedHttpException implements this interface because it often replaces an entity in a JSON:API Data object.

@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

• interface \Drupal\jsonapi\JsonApiResource\ResourceIdentifierInterface

See also

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

jsonapi.api.php

3 files declare their use of ResourceIdentifierInterface

EntityAccessDeniedHttpException.php in src/Exception/EntityAccessDeniedHttpException.php

EntityReferenceFieldNormalizer.php in src/Normalizer/EntityReferenceFieldNormalizer.php

IncludeResolver.php in src/IncludeResolver.php

File

src/JsonApiResource/ResourceIdentifierInterface.php, line 19

Namespace

Drupal\jsonapi\JsonApiResource

interface ResourceIdentifierInterface {

  /**
   * Gets the resource identifier's ID.
   *
   * @return string
   *   A resource ID.
   */
  public function getId();

  /**
   * Gets the resource identifier's JSON:API resource type name.
   *
   * @return string
   *   The JSON:API resource type name.
   */
  public function getTypeName();

  /**
   * Gets the resource identifier's JSON:API resource type.
   *
   * @return \Drupal\jsonapi\ResourceType\ResourceType
   *   The JSON:API resource type.
   */
  public function getResourceType();

}

Members

Name	Modifiers	Type	Description	Overrides
ResourceIdentifierInterface::getId	public	function	Gets the resource identifier's ID.	1
ResourceIdentifierInterface::getResourceType	public	function	Gets the resource identifier's JSON:API resource type.	1
ResourceIdentifierInterface::getTypeName	public	function	Gets the resource identifier's JSON:API resource type name.	1