8.2.x EntityTypeInterface.php public EntityTypeInterface::getLinkTemplates()
8.0.x EntityTypeInterface.php public EntityTypeInterface::getLinkTemplates()
8.1.x EntityTypeInterface.php public EntityTypeInterface::getLinkTemplates()
8.3.x EntityTypeInterface.php public EntityTypeInterface::getLinkTemplates()

Gets the link templates using the URI template syntax.

Links are an array of standard link relations to the URI template that should be used for them. Where possible, link relationships should use established IANA relationships rather than custom relationships.

Every entity type should, at minimum, define "canonical", which is the pattern for URIs to that entity. Even if the entity will have no HTML page exposed to users it should still have a canonical URI in order to be compatible with web services. Entities that will be user-editable via an HTML page must also define an "edit-form" relationship.

By default, the following placeholders are supported:

  • [entityType]: The entity type itself will also be a valid token for the ID of the entity. For instance, a placeholder of {node} used on the Node class.
  • [bundleEntityType]: The bundle machine name itself. For instance, a placeholder of {node_type} used on the Node class.

Specific entity types may also expand upon this list by overriding the Entity::urlRouteParameters() method.

http://www.iana.org/assignments/link-relations/link-relations.xml http://tools.ietf.org/html/rfc6570

Return value

array

1 method overrides EntityTypeInterface::getLinkTemplates()
EntityType::getLinkTemplates in core/lib/Drupal/Core/Entity/EntityType.php
Gets the link templates using the URI template syntax.

File

core/lib/Drupal/Core/Entity/EntityTypeInterface.php, line 428

Class

EntityTypeInterface
Provides an interface for an entity type and its metadata.

Namespace

Drupal\Core\Entity

Code

public function getLinkTemplates();