Public Member Functions | |
| __construct ($cookieFile, $storeSessionCookies=false) | |
| __destruct () | |
| load ($filename) | |
| save ($filename) | |
 Public Member Functions inherited from GuzzleHttp\Cookie\CookieJar | |
| clear ($domain=null, $path=null, $name=null) | |
| clearSessionCookies () | |
| count () | |
| extractCookies (RequestInterface $request, ResponseInterface $response) | |
| getCookieByName ($name) | |
| getIterator () | |
| setCookie (SetCookie $cookie) | |
| toArray () | |
| withCookieHeader (RequestInterface $request) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from GuzzleHttp\Cookie\CookieJar | |
| static | fromArray (array $cookies, $domain) |
| static | getCookieValue ($value) |
| static | shouldPersist (SetCookie $cookie, $allowSessionCookies=false) |
Detailed Description
Persists non-session cookies using a JSON formatted file
Definition at line 7 of file vendor/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php.
Constructor & Destructor Documentation
◆ __construct()
| GuzzleHttp\Cookie\FileCookieJar::__construct | ( | $cookieFile, | |
$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
-
Reimplemented from GuzzleHttp\Cookie\CookieJar.
Definition at line 30 of file vendor/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php.
References GuzzleHttp\Cookie\FileCookieJar\load().
◆ __destruct()
| GuzzleHttp\Cookie\FileCookieJar::__destruct | ( | ) |
Saves the file when shutting down
Definition at line 44 of file vendor/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php.
References GuzzleHttp\Cookie\FileCookieJar\save().
Member Function Documentation
◆ load()
| GuzzleHttp\Cookie\FileCookieJar::load | ( | $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
-
Definition at line 79 of file vendor/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php.
References GuzzleHttp\json_decode(), and GuzzleHttp\Cookie\CookieJar\setCookie().
Referenced by GuzzleHttp\Cookie\FileCookieJar\__construct().
◆ save()
| GuzzleHttp\Cookie\FileCookieJar::save | ( | $filename | ) |
Saves the cookies to a file.
- Parameters
-
string $filename File to save
- Exceptions
-
Definition at line 55 of file vendor/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php.
References GuzzleHttp\Cookie\CookieJar\shouldPersist().
Referenced by GuzzleHttp\Cookie\FileCookieJar\__destruct().
The documentation for this class was generated from the following file:
