\GuzzleHttp\CookieSessionCookieJar

Persists cookies in the client session

Summary

Methods

Properties

Constants

__construct()
fromArray()
getCookieValue()
shouldPersist()
getCookieByName()
toArray()
clear()
clearSessionCookies()
setCookie()
count()
getIterator()
extractCookies()
withCookieHeader()
__destruct()
save()

No public properties found

No constants found

load()

No protected properties found

N/A

getCookiePathFromRequest()
removeCookieIfEmpty()

$cookies
$strictMode
$sessionKey
$storeSessionCookies

N/A

File: core/api/Qcos/vendor/guzzlehttp/guzzle/src/Cookie/SessionCookieJar.php
Package: Application
Class hierarchy: CookieJar

\GuzzleHttp\Cookie\SessionCookieJar
Uses

Properties

$cookies

$cookies : \GuzzleHttp\Cookie\SetCookie[]

Type

SetCookie[] — Loaded cookie data

$strictMode

$strictMode : bool

Type

bool —

$sessionKey

$sessionKey : string

Type

string — session key

$storeSessionCookies

$storeSessionCookies : bool

Type

bool — Control whether to persist session cookies or not.

Methods

__construct()

__construct(string  $sessionKey, bool  $storeSessionCookies = false) : mixed

Create a new SessionCookieJar object

Parameters

string	$sessionKey	Session key name to store the cookie data in session
bool	$storeSessionCookies	Set to true to store session cookies in the cookie jar.

Returns

mixed —

fromArray()

fromArray(array  $cookies, string  $domain) : self

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

Returns

self —

getCookieValue()

getCookieValue(mixed  $value) : mixed

Parameters

mixed

$value

Returns

mixed —

shouldPersist()

shouldPersist(\GuzzleHttp\Cookie\SetCookie  $cookie, bool  $allowSessionCookies = false) : bool

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

Parameters

\GuzzleHttp\Cookie\SetCookie	$cookie	Being evaluated.
bool	$allowSessionCookies	If we should persist session cookies

Returns

bool —

getCookieByName()

getCookieByName(string  $name) : \GuzzleHttp\Cookie\SetCookie|null

Finds and returns the cookie based on the name

Parameters

string

$name

cookie name to search for

Returns

\GuzzleHttp\Cookie\SetCookie|null —

cookie that was found or null if not found

toArray()

toArray() : array

Converts the cookie jar to an array.

Returns

array —

clear()

clear(mixed  $domain = null, mixed  $path = null, mixed  $name = null) : \GuzzleHttp\Cookie\CookieJarInterface

Remove cookies currently held in the cookie jar.

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

mixed	$domain	Clears cookies matching a domain
mixed	$path	Clears cookies matching a domain and path
mixed	$name	Clears cookies matching a domain, path, and name

Returns

\GuzzleHttp\Cookie\CookieJarInterface —

clearSessionCookies()

clearSessionCookies() : mixed

Discard all sessions cookies.

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.

Returns

mixed —

setCookie()

setCookie(\GuzzleHttp\Cookie\SetCookie  $cookie) : bool

Sets a cookie in the cookie jar.

Parameters

\GuzzleHttp\Cookie\SetCookie

$cookie

Cookie to set.

Returns

bool —

Returns true on success or false on failure

count()

count() : mixed

Returns

mixed —

getIterator()

getIterator() : mixed

Returns

mixed —

extractCookies()

extractCookies(\Psr\Http\Message\RequestInterface  $request, \Psr\Http\Message\ResponseInterface  $response) : mixed

Extract cookies from an HTTP response and store them in the CookieJar.

Parameters

\Psr\Http\Message\RequestInterface	$request	Request that was sent
\Psr\Http\Message\ResponseInterface	$response	Response that was received

Returns

mixed —

withCookieHeader()

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.

Parameters

\Psr\Http\Message\RequestInterface

$request

Request object to modify.

Returns

\Psr\Http\Message\RequestInterface —

returns the modified request.

__destruct()

__destruct() : mixed

Saves cookies to session when shutting down

Returns

mixed —

save()

save() : mixed

Save cookies to the client session

Returns

mixed —

load()

load() : mixed

Load the contents of the client session into the data array

Returns

mixed —

getCookiePathFromRequest()

getCookiePathFromRequest(\Psr\Http\Message\RequestInterface  $request) : string

Computes cookie path following RFC 6265 section 5.1.4

Parameters

\Psr\Http\Message\RequestInterface

$request

Returns

string —

removeCookieIfEmpty()

removeCookieIfEmpty(\GuzzleHttp\Cookie\SetCookie  $cookie) : mixed

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

Parameters

\GuzzleHttp\Cookie\SetCookie

$cookie

Returns

mixed —