RelationLinkManagerInterface.php

<?php

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);

}