Interface CookieJarInterface
Interface for persisting cookies
- Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface implements Countable, IteratorAggregate
Direct known implementers
Indirect known implementers
Located at Guzzle/Plugin/Cookie/CookieJar/CookieJarInterface.php
Methods summary
-
publicremove ( string $domain = null, string $path = null, string $name = null )Remove cookies currently held in the Cookie cookieJar.
-
publicremoveTemporary ( )Discard all temporary cookies.
-
publicremoveExpired ( )Delete any expired cookies
-
publicadd ( Guzzle\Plugin\Cookie\Cookie $cookie )Add a cookie to the cookie cookieJar
-
publicaddCookiesFromResponse ( Guzzle\Http\Message\Response $response, Guzzle\Http\Message\RequestInterface $request = null )Add cookies from a
Guzzle\Http\Message\Responseobject -
publicgetMatchingCookies ( Guzzle\Http\Message\RequestInterface $request )Get cookies matching a request object
-
publicall ( string $domain = null, string $path = null, string $name = null, bool $skipDiscardable = false, bool $skipExpired = true )Get all of the matching cookies
Methods detail
public
Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface
remove( string $domain = null, string $path = null, string $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
- $domain
string
$domain Set to clear only cookies matching a domain- $path
string
$path Set to clear only cookies matching a domain and path- $name
string
$name Set to clear only cookies matching a domain, path, and name
Returns
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
Add a cookie to the cookie cookieJar
Parameters
- $cookie
Guzzle\Plugin\Cookie\Cookie
$cookie Cookie to add
Returns
booleanReturns true on success or false on failure
public
addCookiesFromResponse( Guzzle\Http\Message\Response $response, Guzzle\Http\Message\RequestInterface $request = null )
Add cookies from a Guzzle\Http\Message\Response object
Parameters
- $response
Guzzle\Http\Message\Response
$response Response object- $request
Guzzle\Http\Message\RequestInterface
$request Request that received the response
Get cookies matching a request object
Parameters
- $request
Guzzle\Http\Message\RequestInterface
$request Request object to match
Returns
array
public
array
all( string $domain = null, string $path = null, string $name = null, boolean $skipDiscardable = false, boolean $skipExpired = true )
Get all of the matching cookies
Parameters
- $domain
string
$domain Domain of the cookie- $path
string
$path Path of the cookie- $name
string
$name Name of the cookie- $skipDiscardable
boolean
$skipDiscardable Set to TRUE to skip cookies with the Discard attribute.- $skipExpired
boolean
$skipExpired Set to FALSE to include expired
Returns
arrayReturns an array of Cookie objects