[TOC] ## 安裝 ``` composer require psr/link ``` ## 接口 <details> <summary>Psr\Link\LinkInterface </summary> ``` <?php namespace Psr\Link; /** * 一個可讀的鏈接對象。 */ interface LinkInterface { /** * 返回鏈接的目標。 * * 目標鏈接必須是以下中的一個： * * - 一個絕對的 URI，由 RFC 5988 定義的。 * - 一個相對 URI，由 RFC 5988 定義的。相對鏈接的基礎 * 被假定為基于客戶端的上下文而已知。 * - 一個由 RFC 6570 定義的 URI 模板。 * * 如果返回一個 URI 模板，isTemplated 必須返回 True。 * * @return string */ public function getHref(); /** * 返回的是否為一個模板鏈接。 * * @return bool True 表示鏈接對象是模板, False 相反。 */ public function isTemplated(); /** * 返回鏈接的關系類型。 * * 此方法返回一個鏈接的 0 個或更多關系類型，返回值為 * 字符串數組。 * * @return string[] */ public function getRels(); /** * 返回描述目標 URI 的一個屬性列表。 * * @return array * 屬性的一個鍵值對列表，其中鍵是一個字符串，值要么是一個 PHP 原生提供的，要么是 PHP 字符串數組。 * 如果沒有值，必須返回一個空的數組。 */ public function getAttributes(); } ``` </details> <br /> <details> <summary>Psr\Link\EvolvableLinkInterface</summary> ``` <?php namespace Psr\Link; /** * 一個可演進的值對象. */ interface EvolvableLinkInterface extends LinkInterface { /** * 返回一個指定的 href 實例。 * * @param string $href * 這個 href 值必須包括以下其中一項： * - 一個由 RFC 5988 定義的絕對 URI。 * - 一個由 RFC 5988 定義的相對 URI。相對鏈接的基準假設是由已知客戶端基于上下文的。 * - 一個由 RFC 6570 定義的 URI 模板。 * - 一個實現 __toString() 方法的對象，它產生上述某個值。 * * 一個實現庫應當立即將傳遞的對象評估為字符串，而不是等待它稍后返回。 * * @return static */ public function withHref($href); /** * 返回一個包含指定關系的實例。 * * 如果指定的 rel 已經存在，這個方法必須正常返回而沒有錯誤，但不會再次添加 rel。 * * @param string $rel 要添加的關系值。 * * @return static */ public function withRel($rel); /** * 返回一個排除指定關系的實例。 * * 如果指定的 rel 已經不存在，這個方法必須正常返回而沒有錯誤。 * * @param string $rel 要排除的關系值。 * * @return static */ public function withoutRel($rel); /** * 返回一個添加了指定屬性的實例。 * * 如果指定的屬性已經存在，那么屬性的值將被新值覆蓋。 * * @param string $attribute 包含的屬性鍵名。 * @param string $value 屬性待設置的值。 * * @return static */ public function withAttribute($attribute, $value); /** * 返回一個排除了指定屬性的實例。 * * 如果指定的屬性不存在，這個方法必須正常返回而沒有錯誤。 * * @param string $attribute 移除的屬性鍵名。 * * @return static */ public function withoutAttribute($attribute); } ``` </details> <br /> <details> <summary>Psr\Link\LinkProviderInterface </summary> ``` <?php namespace Psr\Link; /** * 一個鏈接提供者對象. */ interface LinkProviderInterface { /** * 返回一個可迭代的 LinkInterface 對象。 * * 迭代可能是一個數組或者任何實現 PHP \Traversable 接口的對象。 * 如果沒有可用的鏈接，一個空的數組或者實現 \Traversable 接口的 * 對象必須被返回。 * * @return LinkInterface[]|\Traversable */ public function getLinks(); /** * 返回一個指定關系的可迭代 LinkInterface 對象。 * * 迭代可能是一個數組或者任何實現 PHP \Traversable 接口的對象。 * 如果沒有與該關系的鏈接是可用的，一個空的數組或者實現 \Traversable * 接口的對象必須被返回。 * * @return LinkInterface[]|\Traversable */ public function getLinksByRel($rel); } ``` </details> <br /> <details> <summary>Psr\Link\EvolvableLinkProviderInterface</summary> ``` <?php namespace Psr\Link; /** * 一個可演進的鏈接提供者值對象. */ interface EvolvableLinkProviderInterface extends LinkProviderInterface { /** * 返回一個包含指定鏈接的實例。 * * 如果指定的鏈接已經存在，這個方法必須正常返回而沒有錯誤。 * 如果 $link 全等于（===）集合中已有的 link 對象，則鏈接存在。 * * @param LinkInterface $link 應該包含在此集合中的鏈接對象。 * * @return static */ public function withLink(LinkInterface $link); /** * 返回一個移除指定鏈接的實例。 * * 如果指定的鏈接不存在，這個方法必須正常返回而沒有錯誤。 * 如果 $link 全等于（===）集合中已有的 link 對象，則鏈接存在。 * * @param LinkInterface $link 移除的鏈接。 * * @return static */ public function withoutLink(LinkInterface $link); } ``` </details> <br />