Documentation

FileCookieJar extends CookieJar
in package

Persists non-session cookies using a JSON formatted file

Table of Contents

$cookies  : array<string|int, SetCookie>
$filename  : string
$storeSessionCookies  : bool
$strictMode  : bool
__construct()  : mixed
Create a new FileCookieJar object
__destruct()  : mixed
Saves the file when shutting down
clear()  : CookieJarInterface
Remove cookies currently held in the cookie jar.
clearSessionCookies()  : mixed
Discard all sessions cookies.
count()  : mixed
extractCookies()  : mixed
Extract cookies from an HTTP response and store them in the CookieJar.
fromArray()  : self
Create a new Cookie jar from an associative array and domain.
getCookieByName()  : SetCookie|null
Finds and returns the cookie based on the name
getCookieValue()  : mixed
getIterator()  : mixed
load()  : mixed
Load cookies from a JSON formatted file.
save()  : mixed
Saves the cookies to a file.
setCookie()  : bool
Sets a cookie in the cookie jar.
shouldPersist()  : bool
Evaluate if this cookie should be persisted to storage that survives between requests.
toArray()  : array<string|int, mixed>
Converts the cookie jar to an array.
withCookieHeader()  : RequestInterface
Create a request with added cookie headers.
getCookiePathFromRequest()  : string
Computes cookie path following RFC 6265 section 5.1.4
removeCookieIfEmpty()  : mixed
If a cookie already exists and the server asks to set it again with a null value, the cookie must be deleted.

Properties

Methods

__construct()

Create a new FileCookieJar object

public __construct(string $cookieFile[, bool $storeSessionCookies = false ]) : mixed
Parameters
$cookieFile : string

File to store the cookie data

$storeSessionCookies : bool = false

Set to true to store session cookies in the cookie jar.

Tags
throws
RuntimeException

if the file cannot be found or created

Return values
mixed —

__destruct()

Saves the file when shutting down

public __destruct() : mixed
Return values
mixed —

clear()

Remove cookies currently held in the cookie jar.

public clear([mixed $domain = null ][, mixed $path = null ][, mixed $name = null ]) : CookieJarInterface

Invoking this method without arguments will empty the whole cookie jar. If given a $domain argument only cookies belonging to that domain will be removed. If given a $domain and $path argument, cookies belonging to the specified path within that domain are removed. If given all three arguments, then the cookie with the specified name, path and domain is removed.

Parameters
$domain : mixed = null

Clears cookies matching a domain

$path : mixed = null

Clears cookies matching a domain and path

$name : mixed = null

Clears cookies matching a domain, path, and name

Return values
CookieJarInterface —

clearSessionCookies()

Discard all sessions cookies.

public clearSessionCookies() : mixed

Removes cookies that don't have an expire field or a have a discard field set to true. To be called when the user agent shuts down according to RFC 2965.

Return values
mixed —

count()

public count() : mixed
Return values
mixed —

fromArray()

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

public static fromArray(array<string|int, mixed> $cookies, string $domain) : self
Parameters
$cookies : array<string|int, mixed>

Cookies to create the jar from

$domain : string

Domain to set the cookies to

Return values
self —

getCookieByName()

Finds and returns the cookie based on the name

public getCookieByName(string $name) : SetCookie|null
Parameters
$name : string

cookie name to search for

Return values
SetCookie|null —

cookie that was found or null if not found

getCookieValue()

public static getCookieValue(mixed $value) : mixed
Parameters
$value : mixed
Tags
deprecated
Return values
mixed —

getIterator()

public getIterator() : mixed
Return values
mixed —

load()

Load cookies from a JSON formatted file.

public load(string $filename) : mixed

Old cookies are kept unless overwritten by newly loaded ones.

Parameters
$filename : string

Cookie file to load.

Tags
throws
RuntimeException

if the file cannot be loaded.

Return values
mixed —

save()

Saves the cookies to a file.

public save(string $filename) : mixed
Parameters
$filename : string

File to save

Tags
throws
RuntimeException

if the file cannot be found or created

Return values
mixed —

setCookie()

Sets a cookie in the cookie jar.

public setCookie(SetCookie $cookie) : bool
Parameters
$cookie : SetCookie

Cookie to set.

Return values
bool —

Returns true on success or false on failure

shouldPersist()

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

public static shouldPersist(SetCookie $cookie[, bool $allowSessionCookies = false ]) : bool
Parameters
$cookie : SetCookie

Being evaluated.

$allowSessionCookies : bool = false

If we should persist session cookies

Return values
bool —

toArray()

Converts the cookie jar to an array.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

withCookieHeader()

Create a request with added cookie headers.

public withCookieHeader(RequestInterface $request) : RequestInterface

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
$request : RequestInterface

Request object to modify.

Return values
RequestInterface —

returns the modified request.

removeCookieIfEmpty()

If a cookie already exists and the server asks to set it again with a null value, the cookie must be deleted.

private removeCookieIfEmpty(SetCookie $cookie) : mixed
Parameters
$cookie : SetCookie
Return values
mixed —

Search results