Link

MMO\core\server · 1 symbol · generated 30 Sep 2026

class

Link

A PSR-7 web link (RFC 5988/8288's Link: header entries, e.g. pagination or HATEOAS links): a href plus arbitrary attributes (rel, title, type, ...), array-accessible (tArray) like $link['rel'].

class MMO\core\server\Link implements Psr\Link\LinkInterface, MMO\core\interfaces\iArray, Stringable, JsonSerializable use MMO\core\classes\tArray

Namespace: MMO\core\server
Implements: LinkInterface, iArray, Stringable, JsonSerializable
Uses traits: tArray

new Link(['href' => '/page/2', 'rel' => 'next']);

new Link('<https://example.com>; rel="self"'); // parsed from a raw RFC 8288 header value

Index

	content
	addRel($rel)	Add a relationship type (space-joined into the 'rel' attribute), if it isn't already present.
	clear()	Empty the underlying content, keeping the object itself.
	count()	\Countable::count
	getAttributes()	Returns a list of attributes that describe the target URI.
	getHref()	Returns the target of the link.
	getIterator()	\IteratorAggregate::getIterator
	getRels()	NOTE: this used to `return explode(' ', $this->content['rel']??'')` -- for a link with no 'rel' set at all, `explode(' ', '')` returns `['']` (one element, an empty string), not `[]`, violating thi…
	isEmpty()
	isTemplated()	Returns whether or not this is a templated link.
	jsonSerialize()
	keys()
	loadArray($data)	Load every entry of a plain array into the content, through `offsetSet` (so any offsetSet() override defined by the class using this trait, e.g.
	offsetExists($key)	\ArrayAccess::offsetExists
	offsetGet($key)	\ArrayAccess::offsetGet
	offsetSet($key, $value)	\ArrayAccess::offsetSet -- a null $key appends (`$bag[] = $value`), like a plain PHP array.
	offsetUnset($key)	\ArrayAccess::offsetUnset -- on a list (sequential integer keys, as produced by `$bag[] = ...`), the element is spliced out (closing the gap and reindexing), matching \unset() semantics on a plain …
	toArray()	Convert the content to a plain array, recursively converting any nested `iArray` value (e.g.
	__construct($data, $attributes)
	__toString()

Properties1

content

protected $content = []

Methods19

addRel($rel)

Link.php:37

Add a relationship type (space-joined into the 'rel' attribute), if it isn't already present.

function addRel(string $rel): bool

$rel	string
returns	bool	false if $rel was already there.

clear()

tArray.php:25

Empty the underlying content, keeping the object itself.

function clear()

returns

$bag->clear(); // count($bag) === 0 afterwards

count()

tArray.php:90

\Countable::count

function count(): int

returns

int

getAttributes()

Link.php:110

Returns a list of attributes that describe the target URI.

function getAttributes(): array

returns

array

A key-value list of attributes, where the key is a string and the value is either a PHP primitive or an array of PHP strings. If no values are found an empty array MUST be returned.

getHref()

Link.php:69

Returns the target of the link.

function getHref(): string

The target link must be one of: - An absolute URI, as defined by RFC 5988. - A relative URI, as defined by RFC 5988. The base of the relative link is assumed to be known based on context by the client. - A URI template as defined by RFC 6570. If a URI template is returned, isTemplated() MUST return True.

returns

string

getIterator()

tArray.php:97

\IteratorAggregate::getIterator

function getIterator(): Traversable

returns

Traversable

getRels()

Link.php:98

NOTE: this used to return explode(' ', $this->content['rel']??'') -- for a link with no 'rel' set at all, explode(' ', '') returns [''] (one element, an empty string), not [], violating this very method's own docblock ("returns 0 or more relationship types") and PSR-7's contract. Verified concretely: count() and empty() both disagreed with "this link has no rel" as a result. Fixed to return [] when there's no rel.

function getRels(): array

returns

array

isEmpty()

tArray.php:33

function isEmpty()

returns

true if the underlying content has no elements

$bag->isEmpty(); // true right after clear(), false as soon as an item is set

isTemplated()

Link.php:79

Returns whether or not this is a templated link.

function isTemplated(): bool

returns

bool

True if this link object is templated, False otherwise.

jsonSerialize()

Link.php:52

function jsonSerialize(): string

returns string same as __toString -- this link's JSON representation is its raw header-value form.

keys()

tArray.php:82

function keys(): array

returns

array

the list of keys currently set

$bag->keys(); // e.g. ['x', 0]

loadArray($data)

tArray.php:71

Load every entry of a plain array into the content, through offsetSet (so any offsetSet() override defined by the class using this trait, e.g. for validation or type coercion, is honored for every entry).

function loadArray(array $data): static

$data	array
returns	static	$this, for chaining

$bag->loadArray(['x' => 1, 'y' => 2]); // equivalent to $bag['x'] = 1; $bag['y'] = 2;

offsetExists($key)

tArray.php:130

\ArrayAccess::offsetExists

function offsetExists(mixed $key): bool

$key	mixed
returns	bool

offsetGet($key)

tArray.php:115

\ArrayAccess::offsetGet

function offsetGet(mixed $key): mixed

$key	mixed
returns	mixed

offsetSet($key, $value)

tArray.php:122

\ArrayAccess::offsetSet -- a null $key appends ($bag[] = $value), like a plain PHP array.

function offsetSet(mixed $key, mixed $value): void

$key	mixed
$value	mixed
returns	void

offsetUnset($key)

tArray.php:107

\ArrayAccess::offsetUnset -- on a list (sequential integer keys, as produced by $bag[] = ...), the element is spliced out (closing the gap and reindexing), matching \unset() semantics on a plain PHP list; on an associative array, the key is simply removed.

function offsetUnset(mixed $key): void

$key	mixed
returns	void

unset($bag[0]); // on a list: every following index shifts down by one, like array_splice()

toArray()

tArray.php:56

Convert the content to a plain array, recursively converting any nested iArray value (e.g. another object using this same trait) into its own plain-array form as well.

function toArray(): array

returns

array

$inner = new Bag(); $inner['a'] = 1; $outer = new Bag(); $outer['inner'] = $inner; $outer->toArray(); // ['inner' => ['a' => 1]] -- $inner is recursively expanded, not left as an object

__construct($data, $attributes)

Link.php:23

function __construct(array|string $data = [], ?array $attributes = null)

$data = []	array \| string	an href string (or a raw `<uri>; attr="value"; ...` RFC 8288 header value, decoded via `decodeLink`), or an already-built attributes array (with an 'href' key).
$attributes = null	null \| array	extra attributes to merge in when $data is a string.

__toString()

Link.php:45

function __toString(): string

returns string this link as a raw RFC 8288 <uri>; attr="value"; ... header value (encodeLink).