Interface CookieJarInterface

Interface for persisting cookies

Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface implements Countable, IteratorAggregate

Direct known implementers

Guzzle\Plugin\Cookie\CookieJar\ArrayCookieJar

Indirect known implementers

Guzzle\Plugin\Cookie\CookieJar\FileCookieJar

Namespace: Guzzle\Plugin\Cookie\CookieJar
Located at Guzzle/Plugin/Cookie/CookieJar/CookieJarInterface.php

Methods summary
`public Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface`	# `remove( string $domain = null, string $path = null, string $name = null )` Remove cookies currently held in the Cookie cookieJar. 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 `Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface`
`public Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface`	# `removeTemporary( )` Discard all temporary cookies. 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`
`public Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface`	# `removeExpired( )` Delete any expired cookies Delete any expired cookies Returns `Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface`
`public boolean`	# `add( Guzzle\Plugin\Cookie\Cookie $cookie )` Add a cookie to the cookie cookieJar 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
`public`	# `addCookiesFromResponse( Guzzle\Http\Message\Response $response )` Add cookies from a `Guzzle\Http\Message\Response` object Add cookies from a `Guzzle\Http\Message\Response` object Parameters `$response` `Guzzle\Http\Message\Response` $response Response object
`public array`	# `getMatchingCookies( Guzzle\Http\Message\RequestInterface $request )` Get cookies matching a request object 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 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

Methods inherited from Countable
`count()`

Methods inherited from IteratorAggregate
`getIterator()`