wordpress-seo / vendor_prefixed / guzzlehttp / guzzle / src / Cookie / CookieJarInterface.php

CookieJarInterface.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 18.2, at vendor_prefixed/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php

77 lines 2.9 KB

Raw Download Zip

1	<?php
2
3	namespace YoastSEO_Vendor\GuzzleHttp\Cookie;
4
5	use YoastSEO_Vendor\Psr\Http\Message\RequestInterface;
6	use YoastSEO_Vendor\Psr\Http\Message\ResponseInterface;
7	/**
8	* Stores HTTP cookies.
9	*
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.
14	*
15	* @link http://docs.python.org/2/library/cookielib.html Inspiration
16	*/
17	interface CookieJarInterface extends \Countable, \IteratorAggregate
18	{
19	/**
20	* Create a request with added cookie headers.
21	*
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.
24	*
25	* @param RequestInterface $request Request object to modify.
26	*
27	* @return RequestInterface returns the modified request.
28	*/
29	public function withCookieHeader(\YoastSEO_Vendor\Psr\Http\Message\RequestInterface $request);
30	/**
31	* Extract cookies from an HTTP response and store them in the CookieJar.
32	*
33	* @param RequestInterface $request Request that was sent
34	* @param ResponseInterface $response Response that was received
35	*/
36	public function extractCookies(\YoastSEO_Vendor\Psr\Http\Message\RequestInterface $request, \YoastSEO_Vendor\Psr\Http\Message\ResponseInterface $response);
37	/**
38	* Sets a cookie in the cookie jar.
39	*
40	* @param SetCookie $cookie Cookie to set.
41	*
42	* @return bool Returns true on success or false on failure
43	*/
44	public function setCookie(\YoastSEO_Vendor\GuzzleHttp\Cookie\SetCookie $cookie);
45	/**
46	* Remove cookies currently held in the cookie jar.
47	*
48	* Invoking this method without arguments will empty the whole cookie jar.
49	* If given a $domain argument only cookies belonging to that domain will
50	* be removed. If given a $domain and $path argument, cookies belonging to
51	* the specified path within that domain are removed. If given all three
52	* arguments, then the cookie with the specified name, path and domain is
53	* removed.
54	*
55	* @param string\|null $domain Clears cookies matching a domain
56	* @param string\|null $path Clears cookies matching a domain and path
57	* @param string\|null $name Clears cookies matching a domain, path, and name
58	*
59	* @return CookieJarInterface
60	*/
61	public function clear($domain = null, $path = null, $name = null);
62	/**
63	* Discard all sessions cookies.
64	*
65	* Removes cookies that don't have an expire field or a have a discard
66	* field set to true. To be called when the user agent shuts down according
67	* to RFC 2965.
68	*/
69	public function clearSessionCookies();
70	/**
71	* Converts the cookie jar to an array.
72	*
73	* @return array
74	*/
75	public function toArray();
76	}
77