Class ArrayCookieJar
Cookie cookieJar that stores cookies an an array
- Guzzle\Plugin\Cookie\CookieJar\ArrayCookieJar implements Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface, Serializable
Direct known subclasses
Located at Guzzle/Plugin/Cookie/CookieJar/ArrayCookieJar.php
Methods summary
-
public
__construct ( bool $strictMode = false )
-
public
setStrictMode ( bool $strictMode )
Enable or disable strict mode on the cookie jar
-
public
remove ( string $domain = null, string $path = null, string $name = null )
Remove cookies currently held in the Cookie cookieJar.
-
public
removeTemporary ( )
Discard all temporary cookies.
-
public
removeExpired ( )
Delete any expired cookies
-
public
all ( string $domain = null, string $path = null, string $name = null, bool $skipDiscardable = false, bool $skipExpired = true )
Get all of the matching cookies
-
public
add ( Guzzle\Plugin\Cookie\Cookie $cookie )
Add a cookie to the cookie cookieJar
-
public
serialize ( )
Serializes the cookie cookieJar
-
public
unserialize ( mixed $data )
Unserializes the cookie cookieJar
-
public
count ( )
Returns the total number of stored cookies
-
public
getIterator ( )
Returns an iterator
-
public
addCookiesFromResponse ( Guzzle\Http\Message\Response $response, Guzzle\Http\Message\RequestInterface $request = null )
Add cookies from a
Guzzle\Http\Message\Response
object -
public
getMatchingCookies ( Guzzle\Http\Message\RequestInterface $request )
Get cookies matching a request object
Methods detail
Parameters
- $strictMode
boolean
$strictMode Set to true to throw exceptions when invalid cookies are added to the cookie jar
Enable or disable strict mode on the cookie jar
Parameters
- $strictMode
boolean
$strictMode Set to true to throw exceptions when invalid cookies are added. False to ignore them.
Returns
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
Implementation of
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
Implementation of
Delete any expired cookies
Returns
Implementation of
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
array
Returns an array of Cookie objects
Implementation of
Add a cookie to the cookie cookieJar
Parameters
- $cookie
Guzzle\Plugin\Cookie\Cookie
$cookie Cookie to add
Returns
boolean
Returns true on success or false on failure
Implementation of
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
Implementation of
Get cookies matching a request object
Parameters
- $request
Guzzle\Http\Message\RequestInterface
$request Request object to match
Returns
array
Implementation of
Magic methods summary
Properties summary
protected
array
|
$cookies |
#
Loaded cookie data |
protected
boolean
|
$strictMode |
#
Whether or not strict mode is enabled. When enabled, exceptions will be thrown for invalid cookies |