2 namespace GuzzleHttp\Cookie;
4 use Psr\Http\Message\RequestInterface;
5 use Psr\Http\Message\ResponseInterface;
10 * It extracts cookies from HTTP requests, and returns them in HTTP responses.
11 * CookieJarInterface instances automatically expire contained cookies when
12 * necessary. Subclasses are also responsible for storing and retrieving
13 * cookies from a file, database, etc.
15 * @link http://docs.python.org/2/library/cookielib.html Inspiration
17 interface CookieJarInterface extends \Countable, \IteratorAggregate
20 * Create a request with added cookie headers.
22 * If no matching cookies are found in the cookie jar, then no Cookie
23 * header is added to the request and the same request is returned.
25 * @param RequestInterface $request Request object to modify.
27 * @return RequestInterface returns the modified request.
29 public function withCookieHeader(RequestInterface $request);
32 * Extract cookies from an HTTP response and store them in the CookieJar.
34 * @param RequestInterface $request Request that was sent
35 * @param ResponseInterface $response Response that was received
37 public function extractCookies(
38 RequestInterface $request,
39 ResponseInterface $response
43 * Sets a cookie in the cookie jar.
45 * @param SetCookie $cookie Cookie to set.
47 * @return bool Returns true on success or false on failure
49 public function setCookie(SetCookie $cookie);
52 * Remove cookies currently held in the cookie jar.
54 * Invoking this method without arguments will empty the whole cookie jar.
55 * If given a $domain argument only cookies belonging to that domain will
56 * be removed. If given a $domain and $path argument, cookies belonging to
57 * the specified path within that domain are removed. If given all three
58 * arguments, then the cookie with the specified name, path and domain is
61 * @param string $domain Clears cookies matching a domain
62 * @param string $path Clears cookies matching a domain and path
63 * @param string $name Clears cookies matching a domain, path, and name
65 * @return CookieJarInterface
67 public function clear($domain = null, $path = null, $name = null);
70 * Discard all sessions cookies.
72 * Removes cookies that don't have an expire field or a have a discard
73 * field set to true. To be called when the user agent shuts down according
76 public function clearSessionCookies();
79 * Converts the cookie jar to an array.
83 public function toArray();