Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface Interface Reference

Inheritance diagram for Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface:

Public Member Functions
	add (Cookie $cookie)
	addCookiesFromResponse (Response $response, RequestInterface $request=null)
	all ($domain=null, $path=null, $name=null, $skipDiscardable=false, $skipExpired=true)
	getMatchingCookies (RequestInterface $request)
	remove ($domain=null, $path=null, $name=null)
	removeExpired ()
	removeTemporary ()

Detailed Description

Interface for persisting cookies

Definition at line 12 of file lib/vendor/guzzle/guzzle/src/Guzzle/Plugin/Cookie/CookieJar/CookieJarInterface.php.

Member Function Documentation

add()

Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface::add

(

Cookie

$cookie

)

Add a cookie to the cookie cookieJar

Parameters

Cookie

$cookie

Cookie to add

Returns

bool Returns true on success or false on failure

Implemented in Guzzle\Plugin\Cookie\CookieJar\ArrayCookieJar.

addCookiesFromResponse()

Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface::addCookiesFromResponse	(	Response	$response,
		RequestInterface	$request = null
	)

Add cookies from a {

See also

Guzzle\Http\Message\Response} object

Parameters

Response	$response	Response object
RequestInterface	$request	Request that received the response

Implemented in Guzzle\Plugin\Cookie\CookieJar\ArrayCookieJar.

all()

Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface::all	(		$domain = null,
			$path = null,
			$name = null,
			$skipDiscardable = false,
			$skipExpired = true
	)

Get all of the matching cookies

Parameters

string	$domain	Domain of the cookie
string	$path	Path of the cookie
string	$name	Name of the cookie
bool	$skipDiscardable	Set to TRUE to skip cookies with the Discard attribute.
bool	$skipExpired	Set to FALSE to include expired

Returns

array Returns an array of Cookie objects

Implemented in Guzzle\Plugin\Cookie\CookieJar\ArrayCookieJar.

getMatchingCookies()

Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface::getMatchingCookies

(

RequestInterface

$request

)

Get cookies matching a request object

Parameters

RequestInterface

$request

Request object to match

Returns

array

Implemented in Guzzle\Plugin\Cookie\CookieJar\ArrayCookieJar.

remove()

Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface::remove	(		$domain = null,
			$path = null,
			$name = null
	)

Remove cookies currently held in the Cookie cookieJar.

Invoking this method without arguments will empty the whole Cookie cookieJar. If given a $domain argument only cookies belonging to that domain will be removed. If given a $domain and $path argument, cookies belonging to the specified path within that domain are removed. If given all three arguments, then the cookie with the specified name, path and domain is removed.

Parameters

string	$domain	Set to clear only cookies matching a domain
string	$path	Set to clear only cookies matching a domain and path
string	$name	Set to clear only cookies matching a domain, path, and name

Returns

CookieJarInterface

Implemented in Guzzle\Plugin\Cookie\CookieJar\ArrayCookieJar.

removeExpired()

Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface::removeExpired

(

)

Delete any expired cookies

Returns

CookieJarInterface

Implemented in Guzzle\Plugin\Cookie\CookieJar\ArrayCookieJar.

removeTemporary()

Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface::removeTemporary

(

)

Discard all temporary cookies.

Scans for all cookies in the cookieJar with either no expire field or a true discard flag. To be called when the user agent shuts down according to RFC 2965.

Returns

CookieJarInterface

Implemented in Guzzle\Plugin\Cookie\CookieJar\ArrayCookieJar.

---

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

• lib/vendor/guzzle/guzzle/src/Guzzle/Plugin/Cookie/CookieJar/CookieJarInterface.php