Open Journal Systems  3.3.0
Public Member Functions | Static Public Member Functions
Symfony\Component\HttpFoundation\AcceptHeader Class Reference

Public Member Functions

 __construct (array $items)
 
 __construct (array $items)
 
 __toString ()
 
 __toString ()
 
 add (AcceptHeaderItem $item)
 
 add (AcceptHeaderItem $item)
 
 all ()
 
 all ()
 
 filter ($pattern)
 
 filter ($pattern)
 
 first ()
 
 first ()
 
 get ($value)
 
 get ($value)
 
 has ($value)
 
 has ($value)
 

Static Public Member Functions

static fromString ($headerValue)
 
static fromString ($headerValue)
 

Detailed Description

Represents an Accept-* header.

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

Author
Jean-François Simon conta.nosp@m.ct@j.nosp@m.fsimo.nosp@m.n.fr

Definition at line 22 of file lib/vendor/symfony/http-foundation/AcceptHeader.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

Symfony\Component\HttpFoundation\AcceptHeader::__construct ( array  $items)

Constructor.

Parameters
AcceptHeaderItem[]$items

Definition at line 45 of file lib/vendor/symfony/http-foundation/AcceptHeader.php.

References Symfony\Component\HttpFoundation\AcceptHeader\add().

◆ __construct() [2/2]

Symfony\Component\HttpFoundation\AcceptHeader::__construct ( array  $items)
Parameters
AcceptHeaderItem[]$items

Definition at line 46 of file vendor/symfony/http-foundation/AcceptHeader.php.

References Symfony\Component\HttpFoundation\AcceptHeader\add().

Member Function Documentation

◆ __toString() [1/2]

Symfony\Component\HttpFoundation\AcceptHeader::__toString ( )

Returns header value's string representation.

Returns
string

Definition at line 76 of file lib/vendor/symfony/http-foundation/AcceptHeader.php.

◆ __toString() [2/2]

Symfony\Component\HttpFoundation\AcceptHeader::__toString ( )

Returns header value's string representation.

Returns
string

Definition at line 82 of file vendor/symfony/http-foundation/AcceptHeader.php.

◆ add() [1/2]

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

Adds an item.

Parameters
AcceptHeaderItem$item
Returns
$this

Definition at line 112 of file lib/vendor/symfony/http-foundation/AcceptHeader.php.

References Symfony\Component\HttpFoundation\AcceptHeaderItem\getValue().

Referenced by Symfony\Component\HttpFoundation\AcceptHeader\__construct().

◆ add() [2/2]

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

Adds an item.

Returns
$this

Definition at line 116 of file vendor/symfony/http-foundation/AcceptHeader.php.

References Symfony\Component\HttpFoundation\AcceptHeaderItem\getValue().

◆ all() [1/2]

Symfony\Component\HttpFoundation\AcceptHeader::all ( )

Returns all items.

Returns
AcceptHeaderItem[]

Definition at line 125 of file lib/vendor/symfony/http-foundation/AcceptHeader.php.

◆ all() [2/2]

Symfony\Component\HttpFoundation\AcceptHeader::all ( )

Returns all items.

Returns
AcceptHeaderItem[]

Definition at line 129 of file vendor/symfony/http-foundation/AcceptHeader.php.

◆ filter() [1/2]

Symfony\Component\HttpFoundation\AcceptHeader::filter (   $pattern)

Filters items on their value using given regex.

Parameters
string$pattern
Returns
self

Definition at line 139 of file lib/vendor/symfony/http-foundation/AcceptHeader.php.

References Symfony\Component\HttpFoundation\AcceptHeaderItem\getValue().

◆ filter() [2/2]

Symfony\Component\HttpFoundation\AcceptHeader::filter (   $pattern)

Filters items on their value using given regex.

Parameters
string$pattern
Returns
self

Definition at line 143 of file vendor/symfony/http-foundation/AcceptHeader.php.

References Symfony\Component\HttpFoundation\AcceptHeaderItem\getValue().

◆ first() [1/2]

Symfony\Component\HttpFoundation\AcceptHeader::first ( )

Returns first item.

Returns
AcceptHeaderItem|null

Definition at line 151 of file lib/vendor/symfony/http-foundation/AcceptHeader.php.

◆ first() [2/2]

Symfony\Component\HttpFoundation\AcceptHeader::first ( )

Returns first item.

Returns
AcceptHeaderItem|null

Definition at line 155 of file vendor/symfony/http-foundation/AcceptHeader.php.

◆ fromString() [1/2]

static Symfony\Component\HttpFoundation\AcceptHeader::fromString (   $headerValue)
static

Builds an AcceptHeader instance from a string.

Parameters
string$headerValue
Returns
self

Definition at line 59 of file lib/vendor/symfony/http-foundation/AcceptHeader.php.

References Symfony\Component\HttpFoundation\AcceptHeaderItem\fromString().

Referenced by Symfony\Component\HttpFoundation\Request\getAcceptableContentTypes(), Symfony\Component\HttpFoundation\Request\getCharsets(), Symfony\Component\HttpFoundation\Request\getEncodings(), Symfony\Component\HttpFoundation\Request\getLanguages(), Symfony\Component\HttpFoundation\Tests\AcceptHeaderTest\testFilter(), Symfony\Component\HttpFoundation\Tests\AcceptHeaderTest\testFirst(), Symfony\Component\HttpFoundation\Tests\AcceptHeaderTest\testFromString(), and Symfony\Component\HttpFoundation\Tests\AcceptHeaderTest\testSorting().

◆ fromString() [2/2]

static Symfony\Component\HttpFoundation\AcceptHeader::fromString (   $headerValue)
static

Builds an AcceptHeader instance from a string.

Parameters
string$headerValue
Returns
self

Definition at line 60 of file vendor/symfony/http-foundation/AcceptHeader.php.

References Symfony\Component\HttpFoundation\HeaderUtils\combine(), and Symfony\Component\HttpFoundation\HeaderUtils\split().

◆ get() [1/2]

Symfony\Component\HttpFoundation\AcceptHeader::get (   $value)

Returns given value's item, if exists.

Parameters
string$value
Returns
AcceptHeaderItem|null

Definition at line 100 of file lib/vendor/symfony/http-foundation/AcceptHeader.php.

◆ get() [2/2]

Symfony\Component\HttpFoundation\AcceptHeader::get (   $value)

Returns given value's item, if exists.

Parameters
string$value
Returns
AcceptHeaderItem|null

Definition at line 106 of file vendor/symfony/http-foundation/AcceptHeader.php.

◆ has() [1/2]

Symfony\Component\HttpFoundation\AcceptHeader::has (   $value)

Tests if header has given value.

Parameters
string$value
Returns
bool

Definition at line 88 of file lib/vendor/symfony/http-foundation/AcceptHeader.php.

◆ has() [2/2]

Symfony\Component\HttpFoundation\AcceptHeader::has (   $value)

Tests if header has given value.

Parameters
string$value
Returns
bool

Definition at line 94 of file vendor/symfony/http-foundation/AcceptHeader.php.

The documentation for this class was generated from the following file: