final class JsonapiHypermediaLinkProvider in JSON:API Hypermedia 8

Defines a JsonapiHypermediaProvider annotation.

JSON:API Hypermedia plugin implementations need to define a plugin definition array through annotation. These definition arrays may be altered through hook_jsonapi_hypermedia_provider_info_alter().

Plugin Namespace: \Plugin\jsonapi_hypermedia\LinkProvider

Each plugin definition includes the following keys:

link_relation_type: The link relation type of the link that will be provided by the plugin.
link_key: The key of the link object that will be provided by the plugin. This can be omitted if the key should be the same as the link relation type name or if the plugin class provides its own implementation of \Drupal\jsonapi_hypermedia\LinkProviderInterface::getLinkKey().
link_context: The context or contexts in which a link provider should be executed. The context indicates a type of object JSON:API document, like an error top-level object, a resource object of a particular type, or a named relationship object.
default_configuration: An array of configuration values that can be used to parameterize the link provider plugin's behavior.

A valid

link_context;

value is an array, with one of the following keys:

top_level_object: the context for the link to be provided is a top-level links object.
resource_object: the context for the link to be provided is a resource object's links object.
relationship_object: the context for the link to be provided is a relationship object's links object.

Each context object key has an allowed value, which further limits the locations in which the plugin can provide a link.

top_level_object: true|string TRUE if the link applies to every top-level links object or a type of top-level object. Possible types are:
- entrypoint
- success
- error
- individual
- collection
- relationship

resource_object: true|string TRUE if the link applies to every resource object or a resource type name if the link only applies to a specific type of resource object.

relationship_object: true|array TRUE if the link applies to every relationship object or a two-tuple of a resource type name and relationship field name. These links will also appear on the top-level links object of relationship responses (e.g. /node/article/{id}/relationships/uid).

Examples:


@JsonapiHypermediaLinkProvider(
  link_relation_type = "item",
  link_context = {
    "top_level_object" = "collection",
  }
)

@JsonapiHypermediaLinkProvider(
  link_relation_type = "publish",
  link_context = {
    "resource_object" = "node--page",
  }
)

@JsonapiHypermediaLinkProvider(
  link_key = "image",
  link_relation_type = "enclosure",
  link_context = {
    "relationship_object" = {
      "node--article", "uid",
    }
  },
  default_configuration = {
    "image_style" = "thumbnail",
  }
)

@example ../../examples/Plugin/jsonapi_hypermedia/LinkProvider/AuthenticationLinkProvider.php @example ../../examples/Plugin/jsonapi_hypermedia/LinkProvider/EntityPublishedInterfaceLinkProvider.php @example ../../examples/Plugin/jsonapi_hypermedia/LinkProvider/MutableResourceTypeLinkProvider.php

Hierarchy

class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\jsonapi_hypermedia\Annotation\JsonapiHypermediaLinkProvider

Expanded class hierarchy of JsonapiHypermediaLinkProvider

File

src/Annotation/JsonapiHypermediaLinkProvider.php, line 106

Namespace

Drupal\jsonapi_hypermedia\Annotation

View source

final class JsonapiHypermediaLinkProvider extends Plugin {

  /**
   * The link relation type of the provided link.
   *
   * @var string
   */
  public $link_relation_type;

  /**
   * The link object key for the provided link.
   *
   * This will be the links object member name for the link returned by the
   * annotated plugin.
   *
   * @var string
   */
  public $link_key;

  /**
   * The context or contexts in which a link provider should be executed.
   *
   * @var array
   */
  public $link_context;

  /**
   * The default configuration for the plugin instance.
   *
   * @var array
   */
  public $default_configuration;

}

Members

Name	Modifiers	Type	Description	Overrides
JsonapiHypermediaLinkProvider::$default_configuration	public	property	The default configuration for the plugin instance.
JsonapiHypermediaLinkProvider::$link_context	public	property	The context or contexts in which a link provider should be executed.
JsonapiHypermediaLinkProvider::$link_key	public	property	The link object key for the provided link.
JsonapiHypermediaLinkProvider::$link_relation_type	public	property	The link relation type of the provided link.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2

You are here

final class JsonapiHypermediaLinkProvider in JSON:API Hypermedia 8

Hierarchy

See also

File

Namespace

Members

API Navigation