interface TypeLinkManagerInterface in Drupal 8

Hierarchy

• interface \Drupal\hal\LinkManager\ConfigurableLinkManagerInterface
  • interface \Drupal\hal\LinkManager\TypeLinkManagerInterface

1 file declares its use of TypeLinkManagerInterface

TypeLinkManagerInterface.php in core/modules/rest/src/LinkManager/TypeLinkManagerInterface.php

File

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

Namespace

Drupal\hal\LinkManager

interface TypeLinkManagerInterface extends ConfigurableLinkManagerInterface {

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

  /**
   * Get a bundle's Typed Data IDs based on a URI.
   *
   * @param string $type_uri
   *   The type URI.
   * @param array $context
   *   Context from the normalizer/serializer operation.
   *
   * @return array|bool
   *   If the URI matches a bundle, returns an array containing entity_type and
   *   bundle. Otherwise, returns false.
   */
  public function getTypeInternalIds($type_uri, $context = []);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableLinkManagerInterface::setLinkDomain	public	function	Sets the link domain used in constructing link URIs.
TypeLinkManagerInterface::getTypeInternalIds	public	function	Get a bundle's Typed Data IDs based on a URI.
TypeLinkManagerInterface::getTypeUri	public	function	Gets the URI that corresponds to a bundle.