Guzzle\Http\Message\Header\Link Class Reference

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

Public Member Functions
	addLink ($url, $rel, array $params=array())
	getLink ($rel)
	getLinks ()
	hasLink ($rel)
Public Member Functions inherited from Guzzle\Http\Message\Header
	__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 ()

Additional Inherited Members
Protected Member Functions inherited from Guzzle\Http\Message\Header
	trimHeader ($str)
Protected Attributes inherited from Guzzle\Http\Message\Header
	$glue
	$header
	$values = array()

Detailed Description

Provides helpful functionality for link headers

Definition at line 10 of file Link.php.

Member Function Documentation

addLink()

Guzzle\Http\Message\Header\Link::addLink	(		$url,
			$rel,
		array	$params = array()
	)

Add a link to the header

Parameters

string	$url	Link URL
string	$rel	Link rel
array	$params	Other link parameters

Returns

self

Definition at line 21 of file Link.php.

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

getLink()

Guzzle\Http\Message\Header\Link::getLink

(

$rel

)

Get a specific link for a given rel attribute

Parameters

string

$rel

Rel value

Returns

array|null

Definition at line 51 of file Link.php.

References Guzzle\Http\Message\Header\Link\getLinks().

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

getLinks()

Guzzle\Http\Message\Header\Link::getLinks

(

)

Get an associative array of links

For example: Link: http:/.../front.jpeg; rel=front; type="image/jpeg", http://.../back.jpeg; rel=back; type="image/jpeg"

var_export($response->getLinks()); array( array( 'url' => 'http:/.../front.jpeg', 'rel' => 'back', 'type' => 'image/jpeg', ) )

Returns

array

Definition at line 81 of file Link.php.

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

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

hasLink()

Guzzle\Http\Message\Header\Link::hasLink

(

$rel

)

Check if a specific link exists for a given rel attribute

Parameters

string

$rel

rel value

Returns

bool

Definition at line 39 of file Link.php.

References Guzzle\Http\Message\Header\Link\getLink().

---

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

• Link.php