|
static | fromArray (array $cookies, string $domain) |
| Create a new Cookie jar from an associative array and domain.
|
|
static | shouldPersist (SetCookie $cookie, bool $allowSessionCookies=false) |
| Evaluate if this cookie should be persisted to storage that survives between requests.
|
|
◆ __construct()
GuzzleHttp\Cookie\FileCookieJar::__construct |
( |
string | $cookieFile, |
|
|
bool | $storeSessionCookies = false ) |
Create a new FileCookieJar object.
- Parameters
-
string | $cookieFile | File to store the cookie data |
bool | $storeSessionCookies | Set to true to store session cookies in the cookie jar. |
- Exceptions
-
RuntimeException | if the file cannot be found or created |
◆ clear()
GuzzleHttp\Cookie\CookieJar::clear |
( |
?string | $domain = null, |
|
|
?string | $path = null, |
|
|
?string | $name = null ) |
|
inherited |
◆ clearSessionCookies()
GuzzleHttp\Cookie\CookieJar::clearSessionCookies |
( |
| ) |
|
|
inherited |
◆ extractCookies()
Extract cookies from an HTTP response and store them in the CookieJar.
- Parameters
-
RequestInterface | $request | Request that was sent |
ResponseInterface | $response | Response that was received |
Implements GuzzleHttp\Cookie\CookieJarInterface.
◆ fromArray()
static GuzzleHttp\Cookie\CookieJar::fromArray |
( |
array | $cookies, |
|
|
string | $domain ) |
|
staticinherited |
Create a new Cookie jar from an associative array and domain.
- Parameters
-
array | $cookies | Cookies to create the jar from |
string | $domain | Domain to set the cookies to |
◆ getCookieByName()
GuzzleHttp\Cookie\CookieJar::getCookieByName |
( |
string | $name | ) |
|
|
inherited |
Finds and returns the cookie based on the name.
- Parameters
-
string | $name | cookie name to search for |
- Return values
-
SetCookie|null | cookie that was found or null if not found |
◆ getIterator()
GuzzleHttp\Cookie\CookieJar::getIterator |
( |
| ) |
|
|
inherited |
- Return values
-
ArrayIterator<int,SetCookie> | |
◆ load()
GuzzleHttp\Cookie\FileCookieJar::load |
( |
string | $filename | ) |
|
Load cookies from a JSON formatted file.
Old cookies are kept unless overwritten by newly loaded ones.
- Parameters
-
string | $filename | Cookie file to load. |
- Exceptions
-
RuntimeException | if the file cannot be loaded. |
◆ save()
GuzzleHttp\Cookie\FileCookieJar::save |
( |
string | $filename | ) |
|
Saves the cookies to a file.
- Parameters
-
string | $filename | File to save |
- Exceptions
-
RuntimeException | if the file cannot be found or created |
◆ setCookie()
GuzzleHttp\Cookie\CookieJar::setCookie |
( |
SetCookie | $cookie | ) |
|
|
inherited |
◆ shouldPersist()
static GuzzleHttp\Cookie\CookieJar::shouldPersist |
( |
SetCookie | $cookie, |
|
|
bool | $allowSessionCookies = false ) |
|
staticinherited |
Evaluate if this cookie should be persisted to storage that survives between requests.
- Parameters
-
SetCookie | $cookie | Being evaluated. |
bool | $allowSessionCookies | If we should persist session cookies |
◆ toArray()
GuzzleHttp\Cookie\CookieJar::toArray |
( |
| ) |
|
|
inherited |
◆ withCookieHeader()
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
-
RequestInterface | $request | Request object to modify. |
- Return values
-
RequestInterface | returns the modified request. |
Implements GuzzleHttp\Cookie\CookieJarInterface.
The documentation for this class was generated from the following file:
- lib/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php