\Guzzle\Plugin\Cookie\CookieJarCookieJarInterface

Interface for persisting cookies

Summary

Methods
Constants
remove()
removeTemporary()
removeExpired()
add()
addCookiesFromResponse()
getMatchingCookies()
all()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

remove()

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

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

\Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface

removeTemporary()

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

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

\Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface

add()

add(\Guzzle\Plugin\Cookie\Cookie  $cookie) : boolean

Add a cookie to the cookie cookieJar

Parameters

\Guzzle\Plugin\Cookie\Cookie $cookie

Cookie to add

Returns

boolean —

Returns true on success or false on failure

addCookiesFromResponse()

addCookiesFromResponse(\Guzzle\Http\Message\Response  $response, \Guzzle\Http\Message\RequestInterface  $request = null) 

Add cookies from a {@see Guzzle\Http\Message\Response} object

Parameters

\Guzzle\Http\Message\Response $response

Response object

\Guzzle\Http\Message\RequestInterface $request

Request that received the response

getMatchingCookies()

getMatchingCookies(\Guzzle\Http\Message\RequestInterface  $request) : array

Get cookies matching a request object

Parameters

\Guzzle\Http\Message\RequestInterface $request

Request object to match

Returns

array

all()

all(string  $domain = null, string  $path = null, string  $name = null, boolean  $skipDiscardable = false, boolean  $skipExpired = true) : array

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

boolean $skipDiscardable

Set to TRUE to skip cookies with the Discard attribute.

boolean $skipExpired

Set to FALSE to include expired

Returns

array —

Returns an array of Cookie objects