\Symfony\Component\HttpFoundationAcceptHeader

Represents an Accept-* header.

An accept header is compound with a list of items, sorted by descending quality.

Summary

Methods
Properties
Constants
__construct()
fromString()
__toString()
has()
get()
add()
all()
filter()
first()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
sort()
$items
$sorted
N/A

Properties

$items

$items : \Symfony\Component\HttpFoundation\AcceptHeaderItem[]

Type

AcceptHeaderItem[]

$sorted

$sorted : bool

Type

bool

Methods

__construct()

__construct(\Symfony\Component\HttpFoundation\AcceptHeaderItem[]  $items) : mixed

Parameters

\Symfony\Component\HttpFoundation\AcceptHeaderItem[] $items

Returns

mixed —

fromString()

fromString(?string  $headerValue) : self

Builds an AcceptHeader instance from a string.

Parameters

?string $headerValue

Returns

self —

__toString()

__toString() : string

Returns header value's string representation.

Returns

string —

has()

has(string  $value) : bool

Tests if header has given value.

Parameters

string $value

Returns

bool —

get()

get(string  $value) : \Symfony\Component\HttpFoundation\AcceptHeaderItem|null

Returns given value's item, if exists.

Parameters

string $value

Returns

\Symfony\Component\HttpFoundation\AcceptHeaderItem|null —

add()

add(\Symfony\Component\HttpFoundation\AcceptHeaderItem  $item) : $this

Adds an item.

Parameters

\Symfony\Component\HttpFoundation\AcceptHeaderItem $item

Returns

$this —

all()

all() : \Symfony\Component\HttpFoundation\AcceptHeaderItem[]

Returns all items.

Returns

\Symfony\Component\HttpFoundation\AcceptHeaderItem[] —

filter()

filter(string  $pattern) : self

Filters items on their value using given regex.

Parameters

string $pattern

Returns

self —

first()

first() : \Symfony\Component\HttpFoundation\AcceptHeaderItem|null

Returns first item.

Returns

\Symfony\Component\HttpFoundation\AcceptHeaderItem|null —

sort()

sort() : void

Sorts items by descending quality.