Interface CookieJarInterface

Stores HTTP cookies.

It extracts cookies from HTTP requests, and returns them in HTTP responses. CookieJarInterface instances automatically expire contained cookies when necessary. Subclasses are also responsible for storing and retrieving cookies from a file, database, etc.

GuzzleHttp\Cookie\CookieJarInterface implements Countable, IteratorAggregate

Direct known implementers

GuzzleHttp\Cookie\CookieJar

Indirect known implementers

GuzzleHttp\Cookie\FileCookieJar, GuzzleHttp\Cookie\SessionCookieJar

Namespace: GuzzleHttp\Cookie
Link: Inspiration
Located at Cookie/CookieJarInterface.php

Methods summary
`public Psr\Http\Message\RequestInterface`	# `withCookieHeader( Psr\Http\Message\RequestInterface $request )` Create a request with added cookie headers. Create a request with added cookie headers. If no matching cookies are found in the cookie jar, then no Cookie header is added to the request and the same request is returned. Parameters `$request` Request object to modify. Returns `Psr\Http\Message\RequestInterface` returns the modified request.
`public`	# `extractCookies( Psr\Http\Message\RequestInterface $request, Psr\Http\Message\ResponseInterface $response )` Extract cookies from an HTTP response and store them in the CookieJar. Extract cookies from an HTTP response and store them in the CookieJar. Parameters `$request` Request that was sent `$response` Response that was received
`public boolean`	# `setCookie( GuzzleHttp\Cookie\SetCookie $cookie )` Sets a cookie in the cookie jar. Sets a cookie in the cookie jar. Parameters `$cookie` Cookie to set. Returns boolean Returns true on success or false on failure
`public GuzzleHttp\Cookie\CookieJarInterface`	# `clear( string $domain = null, string $path = null, string $name = null )` Remove cookies currently held in the cookie jar. Remove cookies currently held in the cookie jar. Invoking this method without arguments will empty the whole cookie jar. 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` Clears cookies matching a domain `$path` Clears cookies matching a domain and path `$name` Clears cookies matching a domain, path, and name Returns `GuzzleHttp\Cookie\CookieJarInterface`
`public`	# `clearSessionCookies( )` Discard all sessions cookies. Discard all sessions cookies. Removes cookies that don't have an expire field or a have a discard field set to true. To be called when the user agent shuts down according to RFC 2965.
`public array`	# `toArray( )` Converts the cookie jar to an array. Converts the cookie jar to an array. Returns array

Methods inherited from Countable
`count()`

Methods inherited from IteratorAggregate
`getIterator()`

Namespaces

Classes

Interfaces

Interface CookieJarInterface

Direct known implementers

Indirect known implementers

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns