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

Public Member Functions

 __toString ()
 
 add ($value)
 
 getGlue ()
 
 getName ()
 
 hasValue ($searchValue)
 
 parseParams ()
 
 removeValue ($searchValue)
 
 setGlue ($glue)
 
 setName ($name)
 
- Public Member Functions inherited from Guzzle\Common\ToArrayInterface
 toArray ()
 

Detailed Description

Member Function Documentation

◆ __toString()

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

Convert the header to a string

Returns
string

Implemented in Guzzle\Http\Message\Header.

◆ add()

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

Add a value to the list of header values

Parameters
string$valueValue to add to the header
Returns
self

Implemented in Guzzle\Http\Message\Header, and Guzzle\Http\Message\Header\CacheControl.

◆ getGlue()

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

Get the glue used to implode multiple values into a string

Returns
string

Implemented in Guzzle\Http\Message\Header.

◆ getName()

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

Get the name of the header

Returns
string

Implemented in Guzzle\Http\Message\Header.

◆ hasValue()

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

Check if the collection of headers has a particular value

Parameters
string$searchValueValue to search for
Returns
bool

Implemented in Guzzle\Http\Message\Header.

◆ parseParams()

Guzzle\Http\Message\Header\HeaderInterface::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

Implemented in Guzzle\Http\Message\Header.

◆ removeValue()

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

Remove a specific value from the header

Parameters
string$searchValueValue to remove
Returns
self

Implemented in Guzzle\Http\Message\Header, and Guzzle\Http\Message\Header\CacheControl.

◆ setGlue()

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

Change the glue used to implode the values

Parameters
string$glueGlue used to implode multiple values
Returns
self

Implemented in Guzzle\Http\Message\Header.

◆ setName()

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

Change the name of the header

Parameters
string$nameName to change to
Returns
self

Implemented in Guzzle\Http\Message\Header.


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