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

LinkManager

class LinkManager implements LinkManagerInterface (View source)

Properties

protected TypeLinkManagerInterface $typeLinkManager

The type link manager.
protected RelationLinkManagerInterface $relationLinkManager

The relation link manager.

Methods

__construct(TypeLinkManagerInterface $type_link_manager, RelationLinkManagerInterface $relation_link_manager)

Constructor.

string
getTypeUri($entity_type, $bundle, array $context = [])

Gets the URI that corresponds to a bundle.

array|bool
getTypeInternalIds(string $type_uri, array $context = [])

Get a bundle's Typed Data IDs based on a URI.

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.

$this
setLinkDomain(string $domain)

Sets the link domain used in constructing link URIs.

Details

at line 29
__construct(TypeLinkManagerInterface $type_link_manager, RelationLinkManagerInterface $relation_link_manager)

Constructor.

Parameters

TypeLinkManagerInterface $type_link_manager

Manager for handling bundle URIs.
RelationLinkManagerInterface $relation_link_manager

Manager for handling bundle URIs.

at line 37
string getTypeUri($entity_type, $bundle, array $context = [])

Gets the URI that corresponds to a bundle.

When using hypermedia formats, this URI can be used to indicate which bundle the data represents. Documentation about required and optional fields can also be provided at this URI.

Parameters

$entity_type

The bundle's entity type.
$bundle

The bundle name.
array $context

(optional) Optional serializer/normalizer context.

Return Value

string

The corresponding URI for the bundle.

at line 44
array|bool getTypeInternalIds(string $type_uri, array $context = [])

Get a bundle's Typed Data IDs based on a URI.

Parameters

string $type_uri

The type URI.
array $context

Context from the normalizer/serializer operation.

Return Value

array|bool

If the URI matches a bundle, returns an array containing entity_type and bundle. Otherwise, returns false.

at line 51
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 58
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'.

at line 65
$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