www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Http/LinkRelationTypeInterface.php

   1 <?php
   2
   3 namespace Drupal\Core\Http;
   4
   5 /**
   6  * Defines a single link relation type.
   7  *
   8  * An example of a link relation type is 'canonical'. It represents a canonical,
   9  * definite representation of a resource.
  10  *
  11  * @see \Drupal\Core\Http\LinkRelationTypeManager
  12  * @see https://tools.ietf.org/html/rfc5988#page-6
  13  */
  14 interface LinkRelationTypeInterface {
  15
  16   /**
  17    * Indicates whether this link relation type is of the 'registered' kind.
  18    *
  19    * @return bool
  20    *
  21    * @see https://tools.ietf.org/html/rfc5988#section-4.1
  22    */
  23   public function isRegistered();
  24
  25   /**
  26    * Indicates whether this link relation type is of the 'extension' kind.
  27    *
  28    * @return bool
  29    *
  30    * @see https://tools.ietf.org/html/rfc5988#section-4.2
  31    */
  32   public function isExtension();
  33
  34   /**
  35    * Returns the registered link relation type name.
  36    *
  37    * Only available for link relation types of the KIND_REGISTERED kind.
  38    *
  39    * @return string|null
  40    *   The name of the registered relation type.
  41    *
  42    * @see https://tools.ietf.org/html/rfc5988#section-4.1
  43    */
  44   public function getRegisteredName();
  45
  46   /**
  47    * Returns the extension link relation type URI.
  48    *
  49    * Only available for link relation types of the KIND_EXTENSION kind.
  50    *
  51    * @return string
  52    *   The URI of the extension relation type.
  53    *
  54    * @see https://tools.ietf.org/html/rfc5988#section-4.2
  55    */
  56   public function getExtensionUri();
  57
  58   /**
  59    * Returns the link relation type description.
  60    *
  61    * @return string
  62    *   The link relation type description.
  63    *
  64    * @see https://tools.ietf.org/html/rfc5988#section-6.2.1
  65    */
  66   public function getDescription();
  67
  68   /**
  69    * Returns the URL pointing to the reference of the link relation type.
  70    *
  71    * @return string
  72    *   The URL pointing to the reference.
  73    *
  74    * @see https://tools.ietf.org/html/rfc5988#section-6.2.1
  75    */
  76   public function getReference();
  77
  78   /**
  79    * Returns some extra notes/comments about this link relation type.
  80    *
  81    * @return string
  82    *   The notes about the link relation.
  83    *
  84    * @see https://tools.ietf.org/html/rfc5988#section-6.2.1
  85    */
  86   public function getNotes();
  87
  88 }