[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  namespace Psr\Link;
   4  
   5  /**
   6   * A link provider object.
   7   */
   8  interface LinkProviderInterface
   9  {
  10      /**
  11       * Returns an iterable of LinkInterface objects.
  12       *
  13       * The iterable may be an array or any PHP \Traversable object. If no links
  14       * are available, an empty array or \Traversable MUST be returned.
  15       *
  16       * @return LinkInterface[]|\Traversable
  17       */
  18      public function getLinks();
  19  
  20      /**
  21       * Returns an iterable of LinkInterface objects that have a specific relationship.
  22       *
  23       * The iterable may be an array or any PHP \Traversable object. If no links
  24       * with that relationship are available, an empty array or \Traversable MUST be returned.
  25       *
  26       * @return LinkInterface[]|\Traversable
  27       */
  28      public function getLinksByRel($rel);
  29  }