1. class
  2. Tsugi
  3. \
  4. Util
  5. \
  6. LinkHeader

LinkHeader

class LinkHeader

Constants

PATTERN

Methods

__construct(array|null $items = [])

Constructor

static LinkHeader
fromString(string $headerValue)

Builds a LinkHeader instance from a string.

LinkHeaderItem[]
all()

get all items

LinkHeader
add(LinkHeaderItem $item)

add a LinkHeaderItem.

LinkHeaderItem|null
getRel(string $rel)

gets an item for a certain rel

void
removeRel(string $rel)

removes a certain relation

string
__toString()

Cast contents to string.

Details

at line 26
__construct(array|null $items = [])

Constructor

Parameters

array|null $items link header items

at line 38
static LinkHeader fromString(string $headerValue)

Builds a LinkHeader instance from a string.

Parameters

string $headerValue value of complete header

Return Value

LinkHeader

at line 62
LinkHeaderItem[] all()

get all items

Return Value

LinkHeaderItem[]

at line 74
LinkHeader add(LinkHeaderItem $item)

add a LinkHeaderItem.

Parameters

LinkHeaderItem $item item to add

Return Value

LinkHeader

at line 87
LinkHeaderItem|null getRel(string $rel)

gets an item for a certain rel

Parameters

string $rel rel

Return Value

LinkHeaderItem|null item

at line 105
void removeRel(string $rel)

removes a certain relation

Parameters

string $rel rel name

Return Value

void

at line 120
string __toString()

Cast contents to string.

Return Value

string