function RelationLinkManagerInterface::getRelationUri

Same name in other branches
  1. 8.9.x core/modules/hal/src/LinkManager/RelationLinkManagerInterface.php \Drupal\hal\LinkManager\RelationLinkManagerInterface::getRelationUri()

Gets the URI that corresponds to a field.

When using hypermedia formats, this URI can be used to indicate which field the data represents. Documentation about this field can also be provided at this URI.

Parameters

string $entity_type: The bundle's entity type.

string $bundle: The bundle name.

string $field_name: The field name.

array $context: (optional) Optional serializer/normalizer context.

Return value

string The corresponding URI (or IANA link relation type) for the field.

1 method overrides RelationLinkManagerInterface::getRelationUri()
RelationLinkManager::getRelationUri in core/modules/hal/src/LinkManager/RelationLinkManager.php
Gets the URI that corresponds to a field.

File

core/modules/hal/src/LinkManager/RelationLinkManagerInterface.php, line 26

Class

RelationLinkManagerInterface

Namespace

Drupal\hal\LinkManager

Code

public function getRelationUri($entity_type, $bundle, $field_name, $context = []);

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