Open Journal Systems  3.3.0
Guzzle\Http\Message\Header Class Reference
Inheritance diagram for Guzzle\Http\Message\Header:
Guzzle\Http\Message\Header\HeaderInterface Guzzle\Common\ToArrayInterface Guzzle\Http\Message\Header\CacheControl Guzzle\Http\Message\Header\Link

Public Member Functions

 __construct ($header, $values=array(), $glue=',')
 
 __toString ()
 
 add ($value)
 
 count ()
 
 getGlue ()
 
 getIterator ()
 
 getName ()
 
 hasExactHeader ($header)
 
 hasValue ($searchValue)
 
 normalize ()
 
 parseParams ()
 
 raw ()
 
 removeValue ($searchValue)
 
 setGlue ($glue)
 
 setName ($name)
 
 toArray ()
 

Protected Member Functions

 trimHeader ($str)
 

Protected Attributes

 $glue
 
 $header
 
 $values = array()
 

Detailed Description

Represents a header and all of the values stored by that header

Definition at line 11 of file Header.php.

Constructor & Destructor Documentation

◆ __construct()

Guzzle\Http\Message\Header::__construct (   $header,
  $values = array(),
  $glue = ',' 
)
Parameters
string$headerName of the header
array | string$valuesValues of the header as an array or a scalar
string$glueGlue used to combine multiple values into a string

Definition at line 22 of file Header.php.

References Guzzle\Http\Message\Header\$glue, Guzzle\Http\Message\Header\$header, and Guzzle\Http\Message\Header\$values.

Member Function Documentation

◆ __toString()

Guzzle\Http\Message\Header::__toString ( )

Convert the header to a string

Returns
string

Implements Guzzle\Http\Message\Header\HeaderInterface.

Definition at line 34 of file Header.php.

References Guzzle\Http\Message\Header\toArray().

◆ add()

Guzzle\Http\Message\Header::add (   $value)

Add a value to the list of header values

Parameters
string$valueValue to add to the header
Returns
self

Implements Guzzle\Http\Message\Header\HeaderInterface.

Reimplemented in Guzzle\Http\Message\Header\CacheControl.

Definition at line 39 of file Header.php.

Referenced by Guzzle\Http\Message\Header\Link\addLink().

◆ count()

Guzzle\Http\Message\Header::count ( )

Definition at line 116 of file Header.php.

References Guzzle\Http\Message\Header\toArray().

Referenced by Guzzle\Http\Message\Header\normalize().

◆ getGlue()

Guzzle\Http\Message\Header::getGlue ( )

Get the glue used to implode multiple values into a string

Returns
string

Implements Guzzle\Http\Message\Header\HeaderInterface.

Definition at line 65 of file Header.php.

References Guzzle\Http\Message\Header\$glue.

◆ getIterator()

Guzzle\Http\Message\Header::getIterator ( )

Definition at line 121 of file Header.php.

References Guzzle\Http\Message\Header\toArray().

◆ getName()

Guzzle\Http\Message\Header::getName ( )

Get the name of the header

Returns
string

Implements Guzzle\Http\Message\Header\HeaderInterface.

Definition at line 46 of file Header.php.

References Guzzle\Http\Message\Header\$header.

◆ hasExactHeader()

Guzzle\Http\Message\Header::hasExactHeader (   $header)
Deprecated:
@codeCoverageIgnore

Definition at line 153 of file Header.php.

References Guzzle\Http\Message\Header\$header, and Guzzle\Common\Version\warn().

◆ hasValue()

Guzzle\Http\Message\Header::hasValue (   $searchValue)

Check if the collection of headers has a particular value

Parameters
string$searchValueValue to search for
Returns
bool

Implements Guzzle\Http\Message\Header\HeaderInterface.

Definition at line 97 of file Header.php.

References Guzzle\Http\Message\Header\toArray().

◆ normalize()

Guzzle\Http\Message\Header::normalize ( )

Normalize the header to be a single header with an array of values.

If any values of the header contains the glue string value (e.g. ","), then the value will be exploded into multiple entries in the header.

Returns
self

Definition at line 78 of file Header.php.

References Guzzle\Http\Message\Header\$values, Guzzle\Http\Message\Header\count(), and Guzzle\Http\Message\Header\toArray().

Referenced by Guzzle\Http\Message\Header\parseParams().

◆ parseParams()

Guzzle\Http\Message\Header::parseParams ( )

Parse a header containing ";" separated data into an array of associative arrays representing the header key value pair data of the header. When a parameter does not contain a value, but just contains a key, this function will inject a key with a '' string value.

Returns
array

Implements Guzzle\Http\Message\Header\HeaderInterface.

Definition at line 126 of file Header.php.

References Guzzle\Http\Message\Header\normalize(), and Guzzle\Http\Message\Header\toArray().

Referenced by Guzzle\Http\Message\Header\CacheControl\getDirectives(), and Guzzle\Http\Message\Header\Link\getLinks().

◆ raw()

Guzzle\Http\Message\Header::raw ( )
Deprecated:
@codeCoverageIgnore

Definition at line 163 of file Header.php.

References Guzzle\Http\Message\Header\toArray(), and Guzzle\Common\Version\warn().

◆ removeValue()

Guzzle\Http\Message\Header::removeValue (   $searchValue)

Remove a specific value from the header

Parameters
string$searchValueValue to remove
Returns
self

Implements Guzzle\Http\Message\Header\HeaderInterface.

Reimplemented in Guzzle\Http\Message\Header\CacheControl.

Definition at line 102 of file Header.php.

◆ setGlue()

Guzzle\Http\Message\Header::setGlue (   $glue)

Change the glue used to implode the values

Parameters
string$glueGlue used to implode multiple values
Returns
self

Implements Guzzle\Http\Message\Header\HeaderInterface.

Definition at line 58 of file Header.php.

References Guzzle\Http\Message\Header\$glue.

◆ setName()

Guzzle\Http\Message\Header::setName (   $name)

Change the name of the header

Parameters
string$nameName to change to
Returns
self

Implements Guzzle\Http\Message\Header\HeaderInterface.

Definition at line 51 of file Header.php.

◆ toArray()

◆ trimHeader()

Guzzle\Http\Message\Header::trimHeader (   $str)
protected

Trim a header by removing excess spaces and wrapping quotes

Parameters
$str
Returns
string

Definition at line 176 of file Header.php.

Field Documentation

◆ $glue

Guzzle\Http\Message\Header::$glue
protected

◆ $header

◆ $values

Guzzle\Http\Message\Header::$values = array()
protected

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