1. interface
  2. Drupal
  3. \
  4. hal
  5. \
  6. LinkManager
  7. \
  8. RelationLinkManagerInterface

RelationLinkManagerInterface

interface RelationLinkManagerInterface implements ConfigurableLinkManagerInterface (View source)

Methods

$this
setLinkDomain(string $domain)

Sets the link domain used in constructing link URIs.

from  ConfigurableLinkManagerInterface
string
getRelationUri(string $entity_type, string $bundle, string $field_name, array $context = [])

Gets the URI that corresponds to a field.

array
getRelationInternalIds(string $relation_uri)

Translates a REST URI into internal IDs.

Details

in ConfigurableLinkManagerInterface at line 18
$this setLinkDomain(string $domain)

Sets the link domain used in constructing link URIs.

Parameters

string $domain

The link domain to use for constructing link URIs.

Return Value

$this

at line 26
string getRelationUri(string $entity_type, string $bundle, string $field_name, array $context = [])

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.

at line 37
array getRelationInternalIds(string $relation_uri)

Translates a REST URI into internal IDs.

Parameters

string $relation_uri

Relation URI (or IANA link relation type) to transform into internal IDs.

Return Value

array

Array with keys 'entity_type_id', 'bundle' and 'field_name'.