Class Header
Represents a header and all of the values stored by that header
- Guzzle\Http\Message\Header implements Guzzle\Http\Message\Header\HeaderInterface
Direct known subclasses
Guzzle\Http\Message\Header\CacheControl,
Guzzle\Http\Message\Header\Link
Methods summary
-
public__construct ( string $header, array|string $values = array(), string $glue = ',' ) -
public__toString ( )Convert the header to a string
-
publicadd ( string $value )Add a value to the list of header values
-
publicgetName ( )Get the name of the header
-
publicsetName ( string $name )Change the name of the header
-
publicsetGlue ( string $glue )Change the glue used to implode the values
-
publicgetGlue ( )Get the glue used to implode multiple values into a string
-
publicnormalize ( )Normalize the header to be a single header with an array of values.
-
publichasValue ( string $searchValue )Check if the collection of headers has a particular value
-
publicremoveValue ( string $searchValue )Remove a specific value from the header
-
publictoArray ( )Get the array representation of an object
-
publiccount ( ) -
publicgetIterator ( ) -
publicparseParams ( )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.
-
protectedtrimHeader ( mixed $str )Trim a header by removing excess spaces and wrapping quotes
Methods detail
Parameters
- $header
string
$header Name of the header- $values
array|string
$values Values of the header as an array or a scalar- $glue
string
$glue Glue used to combine multiple values into a string
Convert the header to a string
Returns
stringImplementation of
Add a value to the list of header values
Parameters
- $value
string
$value Value to add to the header
Returns
Implementation of
Get the name of the header
Returns
stringImplementation of
Change the name of the header
Parameters
- $name
string
$name Name to change to
Returns
Implementation of
Change the glue used to implode the values
Parameters
- $glue
string
$glue Glue used to implode multiple values
Returns
Implementation of
Get the glue used to implode multiple values into a string
Returns
stringImplementation of
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
Check if the collection of headers has a particular value
Parameters
- $searchValue
string
$searchValue Value to search for
Returns
booleanImplementation of
Remove a specific value from the header
Parameters
- $searchValue
string
$searchValue Value to remove
Returns
Implementation of
Get the array representation of an object
Returns
arrayImplementation of
Implementation of
Implementation of
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
arrayImplementation of
Trim a header by removing excess spaces and wrapping quotes
Parameters
- $str
mixed
$str
Returns
stringMagic methods summary
Properties summary
protected
array
|
$values | |
protected
mixed
|
$header | |
protected
mixed
|
$glue |