interface RelationLinkManagerInterface in Drupal 9

Hierarchy

• interface \Drupal\hal\LinkManager\ConfigurableLinkManagerInterface
  • interface \Drupal\hal\LinkManager\RelationLinkManagerInterface

File

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

Namespace

Drupal\hal\LinkManager

interface RelationLinkManagerInterface extends ConfigurableLinkManagerInterface {

  /**
   * 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.
   *
   * @param string $entity_type
   *   The bundle's entity type.
   * @param string $bundle
   *   The bundle name.
   * @param string $field_name
   *   The field name.
   * @param array $context
   *   (optional) Optional serializer/normalizer context.
   *
   * @return string
   *   The corresponding URI (or IANA link relation type) for the field.
   */
  public function getRelationUri($entity_type, $bundle, $field_name, $context = []);

  /**
   * Translates a REST URI into internal IDs.
   *
   * @param string $relation_uri
   *   Relation URI (or IANA link relation type) to transform into internal IDs.
   *
   * @return array
   *   Array with keys 'entity_type_id', 'bundle' and 'field_name'.
   */
  public function getRelationInternalIds($relation_uri);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableLinkManagerInterface::setLinkDomain	public	function	Sets the link domain used in constructing link URIs.	1
RelationLinkManagerInterface::getRelationInternalIds	public	function	Translates a REST URI into internal IDs.	2
RelationLinkManagerInterface::getRelationUri	public	function	Gets the URI that corresponds to a field.	2