interface TypeLinkManagerInterface

Same name in this branch
  1. 8.9.x core/modules/rest/src/LinkManager/TypeLinkManagerInterface.php \Drupal\rest\LinkManager\TypeLinkManagerInterface
Same name and namespace in other branches
  1. 9 core/modules/hal/src/LinkManager/TypeLinkManagerInterface.php \Drupal\hal\LinkManager\TypeLinkManagerInterface

Hierarchy

Expanded class hierarchy of TypeLinkManagerInterface

All classes that implement 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
View source 
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

Title Modifiers Object type Summary 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. 1
TypeLinkManagerInterface::getTypeUri public function Gets the URI that corresponds to a bundle. 1

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