TypeLinkManagerInterface.php in Drupal 9

Namespace

Drupal\hal\LinkManager

File

core/modules/hal/src/LinkManager/TypeLinkManagerInterface.php

<?php

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 = []);

}

Interfaces

Name	Description
TypeLinkManagerInterface