LinkHeader
in package
Tags
Table of Contents
Constants
- PATTERN : mixed = '/\<(?<uri>.*)\>;(\s?)rel=\"(?<rel>.*)\"/U'
Properties
- $items : array<string|int, LinkHeaderItem>
Methods
- __construct() : mixed
- Constructor
- __toString() : string
- Cast contents to string.
- add() : LinkHeader
- add a LinkHeaderItem.
- all() : array<string|int, LinkHeaderItem>
- get all items
- fromString() : LinkHeader
- Builds a LinkHeader instance from a string.
- getRel() : LinkHeaderItem|null
- gets an item for a certain rel
- removeRel() : void
- removes a certain relation
Constants
PATTERN
public
mixed
PATTERN
= '/\<(?<uri>.*)\>;(\s?)rel=\"(?<rel>.*)\"/U'
Properties
$items
private
array<string|int, LinkHeaderItem>
$items
Methods
__construct()
Constructor
public
__construct([array<string|int, LinkHeaderItem> $items = [] ]) : mixed
Parameters
- $items : array<string|int, LinkHeaderItem> = []
-
link header items
__toString()
Cast contents to string.
public
__toString() : string
Return values
stringadd()
add a LinkHeaderItem.
public
add(LinkHeaderItem $item) : LinkHeader
Parameters
- $item : LinkHeaderItem
-
item to add
Return values
LinkHeaderall()
get all items
public
all() : array<string|int, LinkHeaderItem>
Return values
array<string|int, LinkHeaderItem>fromString()
Builds a LinkHeader instance from a string.
public
static fromString(string $headerValue) : LinkHeader
Parameters
- $headerValue : string
-
value of complete header
Return values
LinkHeadergetRel()
gets an item for a certain rel
public
getRel(string $rel) : LinkHeaderItem|null
Parameters
- $rel : string
-
rel
Return values
LinkHeaderItem|null —item
removeRel()
removes a certain relation
public
removeRel(string $rel) : void
Parameters
- $rel : string
-
rel name