PHPFUI/InstaDoc
 
Copied!

Persists non-session cookies using a JSON formatted file

CloneableInstantiableIterable
Methods
public __construct(string $cookieFile, bool $storeSessionCookies = false)
 

Create a new FileCookieJar object

  • param string $cookieFile File to store the cookie data
  • param bool $storeSessionCookies Set to true to store session cookies in the cookie jar.
  • throws \RuntimeException if the file cannot be found or created
public __destruct()
 

Saves the file when shutting down

public GuzzleHttp\Cookie\CookieJar::clear(?string $domain = NULL, ?string $path = NULL, ?string $name = NULL) : void
public GuzzleHttp\Cookie\CookieJar::clearSessionCookies() : void
public GuzzleHttp\Cookie\CookieJar::count() : int
public GuzzleHttp\Cookie\CookieJar::extractCookies(Psr\Http\Message\RequestInterface $request, Psr\Http\Message\ResponseInterface $response) : void
public static GuzzleHttp\Cookie\CookieJar::fromArray(array $cookies, string $domain) : self
 

Create a new Cookie jar from an associative array and domain.

  • param array $cookies Cookies to create the jar from
  • param string $domain Domain to set the cookies to
public GuzzleHttp\Cookie\CookieJar::getCookieByName(string $name) : ?GuzzleHttp\Cookie\SetCookie
 

Finds and returns the cookie based on the name

  • param string $name cookie name to search for
  • return \SetCookie|null cookie that was found or null if not found
public GuzzleHttp\Cookie\CookieJar::getIterator() : ArrayIterator
 
  • return \ArrayIterator<int,\SetCookie>
public load(string $filename) : void
 

Load cookies from a JSON formatted file.

Old cookies are kept unless overwritten by newly loaded ones.

  • param string $filename Cookie file to load.
  • throws \RuntimeException if the file cannot be loaded.
public save(string $filename) : void
 

Saves the cookies to a file.

  • param string $filename File to save
  • throws \RuntimeException if the file cannot be found or created
public GuzzleHttp\Cookie\CookieJar::setCookie(GuzzleHttp\Cookie\SetCookie $cookie) : bool
public static GuzzleHttp\Cookie\CookieJar::shouldPersist(GuzzleHttp\Cookie\SetCookie $cookie, bool $allowSessionCookies = false) : bool
 

Evaluate if this cookie should be persisted to storage that survives between requests.

  • param \SetCookie $cookie Being evaluated.
  • param bool $allowSessionCookies If we should persist session cookies
public GuzzleHttp\Cookie\CookieJar::toArray() : array
public GuzzleHttp\Cookie\CookieJar::withCookieHeader(Psr\Http\Message\RequestInterface $request) : Psr\Http\Message\RequestInterface
Properties
private $filename = NULL
 
  • var string filename
private $storeSessionCookies = NULL
 
  • var bool Control whether to persist session cookies or not.
Methods
public static GuzzleHttp\Cookie\CookieJar::fromArray(array $cookies, string $domain) : self
 

Create a new Cookie jar from an associative array and domain.

  • param array $cookies Cookies to create the jar from
  • param string $domain Domain to set the cookies to
public static GuzzleHttp\Cookie\CookieJar::shouldPersist(GuzzleHttp\Cookie\SetCookie $cookie, bool $allowSessionCookies = false) : bool
 

Evaluate if this cookie should be persisted to storage that survives between requests.

  • param \SetCookie $cookie Being evaluated.
  • param bool $allowSessionCookies If we should persist session cookies
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration