[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  namespace Psr\Link;
   4  
   5  /**
   6   * An evolvable link value object.
   7   */
   8  interface EvolvableLinkInterface extends LinkInterface
   9  {
  10      /**
  11       * Returns an instance with the specified href.
  12       *
  13       * @param string $href
  14       *   The href value to include.  It must be one of:
  15       *     - An absolute URI, as defined by RFC 5988.
  16       *     - A relative URI, as defined by RFC 5988. The base of the relative link
  17       *       is assumed to be known based on context by the client.
  18       *     - A URI template as defined by RFC 6570.
  19       *     - An object implementing __toString() that produces one of the above
  20       *       values.
  21       *
  22       * An implementing library SHOULD evaluate a passed object to a string
  23       * immediately rather than waiting for it to be returned later.
  24       *
  25       * @return static
  26       */
  27      public function withHref($href);
  28  
  29      /**
  30       * Returns an instance with the specified relationship included.
  31       *
  32       * If the specified rel is already present, this method MUST return
  33       * normally without errors, but without adding the rel a second time.
  34       *
  35       * @param string $rel
  36       *   The relationship value to add.
  37       * @return static
  38       */
  39      public function withRel($rel);
  40  
  41      /**
  42       * Returns an instance with the specified relationship excluded.
  43       *
  44       * If the specified rel is already not present, this method MUST return
  45       * normally without errors.
  46       *
  47       * @param string $rel
  48       *   The relationship value to exclude.
  49       * @return static
  50       */
  51      public function withoutRel($rel);
  52  
  53      /**
  54       * Returns an instance with the specified attribute added.
  55       *
  56       * If the specified attribute is already present, it will be overwritten
  57       * with the new value.
  58       *
  59       * @param string $attribute
  60       *   The attribute to include.
  61       * @param string $value
  62       *   The value of the attribute to set.
  63       * @return static
  64       */
  65      public function withAttribute($attribute, $value);
  66  
  67  
  68      /**
  69       * Returns an instance with the specified attribute excluded.
  70       *
  71       * If the specified attribute is not present, this method MUST return
  72       * normally without errors.
  73       *
  74       * @param string $attribute
  75       *   The attribute to remove.
  76       * @return static
  77       */
  78      public function withoutAttribute($attribute);
  79  }