Guzzle\Http\Message\Header\CacheControl Class Reference

Inheritance diagram for Guzzle\Http\Message\Header\CacheControl:

Public Member Functions
	add ($value)
	addDirective ($param, $value)
	getDirective ($param)
	getDirectives ()
	hasDirective ($param)
	removeDirective ($param)
	removeValue ($searchValue)
Public Member Functions inherited from Guzzle\Http\Message\Header
	__construct ($header, $values=array(), $glue=',')
	__toString ()
	count ()
	getGlue ()
	getIterator ()
	getName ()
	hasExactHeader ($header)
	hasValue ($searchValue)
	normalize ()
	parseParams ()
	raw ()
	setGlue ($glue)
	setName ($name)
	toArray ()

Protected Member Functions
	updateFromDirectives (array $directives)
Protected Member Functions inherited from Guzzle\Http\Message\Header
	trimHeader ($str)

Protected Attributes
	$directives
Protected Attributes inherited from Guzzle\Http\Message\Header
	$glue
	$header
	$values = array()

Detailed Description

Provides helpful functionality for Cache-Control headers

Definition at line 10 of file CacheControl.php.

Member Function Documentation

add()

Guzzle\Http\Message\Header\CacheControl::add

(

$value

)

Add a value to the list of header values

Parameters

string

$value

Value to add to the header

Returns

self

Reimplemented from Guzzle\Http\Message\Header.

Definition at line 18 of file CacheControl.php.

addDirective()

Guzzle\Http\Message\Header\CacheControl::addDirective	(		$param,
			$value
	)

Add a cache control directive

Parameters

string	$param	Directive to add
string	$value	Value to set

Returns

self

Definition at line 66 of file CacheControl.php.

References Guzzle\Http\Message\Header\CacheControl\$directives, Guzzle\Http\Message\Header\CacheControl\getDirectives(), and Guzzle\Http\Message\Header\CacheControl\updateFromDirectives().

getDirective()

Guzzle\Http\Message\Header\CacheControl::getDirective

(

$param

)

Get a specific cache control directive

Parameters

string

$param

Directive to retrieve

Returns

string|bool|null

Definition at line 51 of file CacheControl.php.

References Guzzle\Http\Message\Header\CacheControl\$directives, and Guzzle\Http\Message\Header\CacheControl\getDirectives().

getDirectives()

Guzzle\Http\Message\Header\CacheControl::getDirectives

(

)

Get an associative array of cache control directives

Returns

array

Definition at line 96 of file CacheControl.php.

References Guzzle\Http\Message\Header\CacheControl\$directives, and Guzzle\Http\Message\Header\parseParams().

Referenced by Guzzle\Http\Message\Header\CacheControl\addDirective(), Guzzle\Http\Message\Header\CacheControl\getDirective(), Guzzle\Http\Message\Header\CacheControl\hasDirective(), and Guzzle\Http\Message\Header\CacheControl\removeDirective().

hasDirective()

Guzzle\Http\Message\Header\CacheControl::hasDirective

(

$param

)

Check if a specific cache control directive exists

Parameters

string

$param

Directive to retrieve

Returns

bool

Definition at line 37 of file CacheControl.php.

References Guzzle\Http\Message\Header\CacheControl\$directives, and Guzzle\Http\Message\Header\CacheControl\getDirectives().

removeDirective()

Guzzle\Http\Message\Header\CacheControl::removeDirective

(

$param

)

Remove a cache control directive by name

Parameters

string

$param

Directive to remove

Returns

self

Definition at line 82 of file CacheControl.php.

References Guzzle\Http\Message\Header\CacheControl\$directives, Guzzle\Http\Message\Header\CacheControl\getDirectives(), and Guzzle\Http\Message\Header\CacheControl\updateFromDirectives().

removeValue()

Guzzle\Http\Message\Header\CacheControl::removeValue

(

$searchValue

)

Remove a specific value from the header

Parameters

string

$searchValue

Value to remove

Returns

self

Reimplemented from Guzzle\Http\Message\Header.

Definition at line 24 of file CacheControl.php.

updateFromDirectives()

Guzzle\Http\Message\Header\CacheControl::updateFromDirectives ( array  $directives )

protected

Updates the header value based on the parsed directives

Parameters

array

$directives

Array of cache control directives

Definition at line 115 of file CacheControl.php.

References Guzzle\Http\Message\Header\CacheControl\$directives.

Referenced by Guzzle\Http\Message\Header\CacheControl\addDirective(), and Guzzle\Http\Message\Header\CacheControl\removeDirective().

Field Documentation

$directives

array Guzzle\Http\Message\Header\CacheControl::$directives

protected

Definition at line 16 of file CacheControl.php.

Referenced by Guzzle\Http\Message\Header\CacheControl\addDirective(), Guzzle\Http\Message\Header\CacheControl\getDirective(), Guzzle\Http\Message\Header\CacheControl\getDirectives(), Guzzle\Http\Message\Header\CacheControl\hasDirective(), Guzzle\Http\Message\Header\CacheControl\removeDirective(), and Guzzle\Http\Message\Header\CacheControl\updateFromDirectives().

---

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

• CacheControl.php