$cookies
$cookies : \GuzzleHttp\Cookie\SetCookie[]
Persists non-session cookies using a JSON formatted file
$cookies : \GuzzleHttp\Cookie\SetCookie[]
$strictMode : bool
$filename : string
$storeSessionCookies : bool
__construct(string $cookieFile, bool $storeSessionCookies = false) : mixed
Create a new FileCookieJar object
| string | $cookieFile | File to store the cookie data |
| bool | $storeSessionCookies | Set to true to store session cookies in the cookie jar. |
if the file cannot be found or created
shouldPersist(\GuzzleHttp\Cookie\SetCookie $cookie, bool $allowSessionCookies = false) : bool
Evaluate if this cookie should be persisted to storage that survives between requests.
| \GuzzleHttp\Cookie\SetCookie | $cookie | Being evaluated. |
| bool | $allowSessionCookies | If we should persist session cookies |
clear(?string $domain = null, ?string $path = null, ?string $name = null) : void
Remove cookies currently held in the cookie jar.
| ?string | $domain | Clears cookies matching a domain |
| ?string | $path | Clears cookies matching a domain and path |
| ?string | $name | Clears cookies matching a domain, path, and name |
extractCookies(\Psr\Http\Message\RequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : void
Extract cookies from an HTTP response and store them in the CookieJar.
| \Psr\Http\Message\RequestInterface | $request | Request that was sent |
| \Psr\Http\Message\ResponseInterface | $response | Response that was received |
withCookieHeader(\Psr\Http\Message\RequestInterface $request) : \Psr\Http\Message\RequestInterface
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.
| \Psr\Http\Message\RequestInterface | $request | Request object to modify. |
returns the modified request.