interface LinkRelationTypeInterface in Drupal 8

Defines a single link relation type.

An example of a link relation type is 'canonical'. It represents a canonical, definite representation of a resource.

Hierarchy

• interface \Drupal\Core\Http\LinkRelationTypeInterface

See also

\Drupal\Core\Http\LinkRelationTypeManager

https://tools.ietf.org/html/rfc5988#page-6

File

core/lib/Drupal/Core/Http/LinkRelationTypeInterface.php, line 14

Namespace

Drupal\Core\Http

interface LinkRelationTypeInterface {

  /**
   * Indicates whether this link relation type is of the 'registered' kind.
   *
   * @return bool
   *
   * @see https://tools.ietf.org/html/rfc5988#section-4.1
   */
  public function isRegistered();

  /**
   * Indicates whether this link relation type is of the 'extension' kind.
   *
   * @return bool
   *
   * @see https://tools.ietf.org/html/rfc5988#section-4.2
   */
  public function isExtension();

  /**
   * Returns the registered link relation type name.
   *
   * Only available for link relation types of the KIND_REGISTERED kind.
   *
   * @return string|null
   *   The name of the registered relation type.
   *
   * @see https://tools.ietf.org/html/rfc5988#section-4.1
   */
  public function getRegisteredName();

  /**
   * Returns the extension link relation type URI.
   *
   * Only available for link relation types of the KIND_EXTENSION kind.
   *
   * @return string
   *   The URI of the extension relation type.
   *
   * @see https://tools.ietf.org/html/rfc5988#section-4.2
   */
  public function getExtensionUri();

  /**
   * Returns the link relation type description.
   *
   * @return string
   *   The link relation type description.
   *
   * @see https://tools.ietf.org/html/rfc5988#section-6.2.1
   */
  public function getDescription();

  /**
   * Returns the URL pointing to the reference of the link relation type.
   *
   * @return string
   *   The URL pointing to the reference.
   *
   * @see https://tools.ietf.org/html/rfc5988#section-6.2.1
   */
  public function getReference();

  /**
   * Returns some extra notes/comments about this link relation type.
   *
   * @return string
   *   The notes about the link relation.
   *
   * @see https://tools.ietf.org/html/rfc5988#section-6.2.1
   */
  public function getNotes();

}

Members

Name	Modifiers	Type	Description	Overrides
LinkRelationTypeInterface::getDescription	public	function	Returns the link relation type description.	1
LinkRelationTypeInterface::getExtensionUri	public	function	Returns the extension link relation type URI.	1
LinkRelationTypeInterface::getNotes	public	function	Returns some extra notes/comments about this link relation type.	1
LinkRelationTypeInterface::getReference	public	function	Returns the URL pointing to the reference of the link relation type.	1
LinkRelationTypeInterface::getRegisteredName	public	function	Returns the registered link relation type name.	1
LinkRelationTypeInterface::isExtension	public	function	Indicates whether this link relation type is of the 'extension' kind.	1
LinkRelationTypeInterface::isRegistered	public	function	Indicates whether this link relation type is of the 'registered' kind.	1