vendor/symfony/web-link/Link.php line 16

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\WebLink;
  14. use Psr\Link\EvolvableLinkInterface;
  16. class Link implements EvolvableLinkInterface
  17. {
  18.     // @see https://www.iana.org/assignments/link-relations/link-relations.xhtml
  19.     public const REL_ABOUT = 'about';
  20.     public const REL_ACL = 'acl';
  21.     public const REL_ALTERNATE = 'alternate';
  22.     public const REL_AMPHTML = 'amphtml';
  23.     public const REL_APPENDIX = 'appendix';
  24.     public const REL_APPLE_TOUCH_ICON = 'apple-touch-icon';
  25.     public const REL_APPLE_TOUCH_STARTUP_IMAGE = 'apple-touch-startup-image';
  26.     public const REL_ARCHIVES = 'archives';
  27.     public const REL_AUTHOR = 'author';
  28.     public const REL_BLOCKED_BY = 'blocked-by';
  29.     public const REL_BOOKMARK = 'bookmark';
  30.     public const REL_CANONICAL = 'canonical';
  31.     public const REL_CHAPTER = 'chapter';
  32.     public const REL_CITE_AS = 'cite-as';
  33.     public const REL_COLLECTION = 'collection';
  34.     public const REL_CONTENTS = 'contents';
  35.     public const REL_CONVERTEDFROM = 'convertedfrom';
  36.     public const REL_COPYRIGHT = 'copyright';
  37.     public const REL_CREATE_FORM = 'create-form';
  38.     public const REL_CURRENT = 'current';
  39.     public const REL_DESCRIBEDBY = 'describedby';
  40.     public const REL_DESCRIBES = 'describes';
  41.     public const REL_DISCLOSURE = 'disclosure';
  42.     public const REL_DNS_PREFETCH = 'dns-prefetch';
  43.     public const REL_DUPLICATE = 'duplicate';
  44.     public const REL_EDIT = 'edit';
  45.     public const REL_EDIT_FORM = 'edit-form';
  46.     public const REL_EDIT_MEDIA = 'edit-media';
  47.     public const REL_ENCLOSURE = 'enclosure';
  48.     public const REL_EXTERNAL = 'external';
  49.     public const REL_FIRST = 'first';
  50.     public const REL_GLOSSARY = 'glossary';
  51.     public const REL_HELP = 'help';
  52.     public const REL_HOSTS = 'hosts';
  53.     public const REL_HUB = 'hub';
  54.     public const REL_ICON = 'icon';
  55.     public const REL_INDEX = 'index';
  56.     public const REL_INTERVALAFTER = 'intervalafter';
  57.     public const REL_INTERVALBEFORE = 'intervalbefore';
  58.     public const REL_INTERVALCONTAINS = 'intervalcontains';
  59.     public const REL_INTERVALDISJOINT = 'intervaldisjoint';
  60.     public const REL_INTERVALDURING = 'intervalduring';
  61.     public const REL_INTERVALEQUALS = 'intervalequals';
  62.     public const REL_INTERVALFINISHEDBY = 'intervalfinishedby';
  63.     public const REL_INTERVALFINISHES = 'intervalfinishes';
  64.     public const REL_INTERVALIN = 'intervalin';
  65.     public const REL_INTERVALMEETS = 'intervalmeets';
  66.     public const REL_INTERVALMETBY = 'intervalmetby';
  67.     public const REL_INTERVALOVERLAPPEDBY = 'intervaloverlappedby';
  68.     public const REL_INTERVALOVERLAPS = 'intervaloverlaps';
  69.     public const REL_INTERVALSTARTEDBY = 'intervalstartedby';
  70.     public const REL_INTERVALSTARTS = 'intervalstarts';
  71.     public const REL_ITEM = 'item';
  72.     public const REL_LAST = 'last';
  73.     public const REL_LATEST_VERSION = 'latest-version';
  74.     public const REL_LICENSE = 'license';
  75.     public const REL_LINKSET = 'linkset';
  76.     public const REL_LRDD = 'lrdd';
  77.     public const REL_MANIFEST = 'manifest';
  78.     public const REL_MASK_ICON = 'mask-icon';
  79.     public const REL_MEDIA_FEED = 'media-feed';
  80.     public const REL_MEMENTO = 'memento';
  81.     public const REL_MICROPUB = 'micropub';
  82.     public const REL_MODULEPRELOAD = 'modulepreload';
  83.     public const REL_MONITOR = 'monitor';
  84.     public const REL_MONITOR_GROUP = 'monitor-group';
  85.     public const REL_NEXT = 'next';
  86.     public const REL_NEXT_ARCHIVE = 'next-archive';
  87.     public const REL_NOFOLLOW = 'nofollow';
  88.     public const REL_NOOPENER = 'noopener';
  89.     public const REL_NOREFERRER = 'noreferrer';
  90.     public const REL_OPENER = 'opener';
  91.     public const REL_OPENID_2_LOCAL_ID = 'openid2.local_id';
  92.     public const REL_OPENID_2_PROVIDER = 'openid2.provider';
  93.     public const REL_ORIGINAL = 'original';
  94.     public const REL_P_3_PV_1 = 'p3pv1';
  95.     public const REL_PAYMENT = 'payment';
  96.     public const REL_PINGBACK = 'pingback';
  97.     public const REL_PRECONNECT = 'preconnect';
  98.     public const REL_PREDECESSOR_VERSION = 'predecessor-version';
  99.     public const REL_PREFETCH = 'prefetch';
  100.     public const REL_PRELOAD = 'preload';
  102.     /**
  103.      * This feature is deprecated and superseded by the Speculation Rules API.
  104.      *
  105.      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel/prerender
  106.      */
  107.     public const REL_PRERENDER = 'prerender';
  108.     public const REL_PREV = 'prev';
  109.     public const REL_PREVIEW = 'preview';
  110.     public const REL_PREVIOUS = 'previous';
  111.     public const REL_PREV_ARCHIVE = 'prev-archive';
  112.     public const REL_PRIVACY_POLICY = 'privacy-policy';
  113.     public const REL_PROFILE = 'profile';
  114.     public const REL_PUBLICATION = 'publication';
  115.     public const REL_RELATED = 'related';
  116.     public const REL_RESTCONF = 'restconf';
  117.     public const REL_REPLIES = 'replies';
  118.     public const REL_RULEINPUT = 'ruleinput';
  119.     public const REL_SEARCH = 'search';
  120.     public const REL_SECTION = 'section';
  121.     public const REL_SELF = 'self';
  122.     public const REL_SERVICE = 'service';
  123.     public const REL_SERVICE_DESC = 'service-desc';
  124.     public const REL_SERVICE_DOC = 'service-doc';
  125.     public const REL_SERVICE_META = 'service-meta';
  126.     public const REL_SIPTRUNKINGCAPABILITY = 'siptrunkingcapability';
  127.     public const REL_SPONSORED = 'sponsored';
  128.     public const REL_START = 'start';
  129.     public const REL_STATUS = 'status';
  130.     public const REL_STYLESHEET = 'stylesheet';
  131.     public const REL_SUBSECTION = 'subsection';
  132.     public const REL_SUCCESSOR_VERSION = 'successor-version';
  133.     public const REL_SUNSET = 'sunset';
  134.     public const REL_TAG = 'tag';
  135.     public const REL_TERMS_OF_SERVICE = 'terms-of-service';
  136.     public const REL_TIMEGATE = 'timegate';
  137.     public const REL_TIMEMAP = 'timemap';
  138.     public const REL_TYPE = 'type';
  139.     public const REL_UGC = 'ugc';
  140.     public const REL_UP = 'up';
  141.     public const REL_VERSION_HISTORY = 'version-history';
  142.     public const REL_VIA = 'via';
  143.     public const REL_WEBMENTION = 'webmention';
  144.     public const REL_WORKING_COPY = 'working-copy';
  145.     public const REL_WORKING_COPY_OF = 'working-copy-of';
  147.     // Extra relations
  148.     public const REL_MERCURE = 'mercure';
  150.     private string $href = '';
  152.     /**
  153.      * @var string[]
  154.      */
  155.     private array $rel = [];
  157.     /**
  158.      * @var array<string, string|bool|string[]>
  159.      */
  160.     private array $attributes = [];
  162.     public function __construct(?string $rel = null, string $href = '')
  163.     {
  164.         if (null !== $rel) {
  165.             $this->rel[$rel] = $rel;
  166.         }
  167.         $this->href = $href;
  168.     }
  170.     public function getHref(): string
  171.     {
  172.         return $this->href;
  173.     }
  175.     public function isTemplated(): bool
  176.     {
  177.         return $this->hrefIsTemplated($this->href);
  178.     }
  180.     public function getRels(): array
  181.     {
  182.         return array_values($this->rel);
  183.     }
  185.     public function getAttributes(): array
  186.     {
  187.         return $this->attributes;
  188.     }
  190.     public function withHref(string|\Stringable $href): static
  191.     {
  192.         $that = clone $this;
  193.         $that->href = $href;
  195.         return $that;
  196.     }
  198.     public function withRel(string $rel): static
  199.     {
  200.         $that = clone $this;
  201.         $that->rel[$rel] = $rel;
  203.         return $that;
  204.     }
  206.     public function withoutRel(string $rel): static
  207.     {
  208.         $that = clone $this;
  209.         unset($that->rel[$rel]);
  211.         return $that;
  212.     }
  214.     public function withAttribute(string $attribute, string|\Stringable|int|float|bool|array $value): static
  215.     {
  216.         $that = clone $this;
  217.         $that->attributes[$attribute] = $value;
  219.         return $that;
  220.     }
  222.     public function withoutAttribute(string $attribute): static
  223.     {
  224.         $that = clone $this;
  225.         unset($that->attributes[$attribute]);
  227.         return $that;
  228.     }
  230.     private function hrefIsTemplated(string $href): bool
  231.     {
  232.         return str_contains($href, '{') || str_contains($href, '}');
  233.     }
  234. }