GuzzleHttp\Cookie\SessionCookieJar Class Reference

Inheritance diagram for GuzzleHttp\Cookie\SessionCookieJar:

Public Member Functions
	__construct (string $sessionKey, bool $storeSessionCookies=false)
	Create a new SessionCookieJar object.
	__destruct ()
	Saves cookies to session when shutting down.
	clear (?string $domain=null, ?string $path=null, ?string $name=null)
	@inheritDoc
	clearSessionCookies ()
	@inheritDoc
	count ()
	extractCookies (RequestInterface $request, ResponseInterface $response)
	Extract cookies from an HTTP response and store them in the CookieJar.
	getCookieByName (string $name)
	Finds and returns the cookie based on the name.
	getIterator ()
	save ()
	Save cookies to the client session.
	setCookie (SetCookie $cookie)
	@inheritDoc
	toArray ()
	@inheritDoc
	withCookieHeader (RequestInterface $request)
	Create a request with added cookie headers.

Static Public Member Functions
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.

Protected Member Functions
	load ()
	Load the contents of the client session into the data array.

Constructor & Destructor Documentation

__construct()

GuzzleHttp\Cookie\SessionCookieJar::__construct	(	string	$sessionKey,
		bool	$storeSessionCookies = false )

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.

Member Function Documentation

clear()

GuzzleHttp\Cookie\CookieJar::clear ( ?string $domain = null, ?string $path = null, ?string $name = null )

inherited

@inheritDoc

Implements GuzzleHttp\Cookie\CookieJarInterface.

clearSessionCookies()

GuzzleHttp\Cookie\CookieJar::clearSessionCookies ( )

inherited

@inheritDoc

Implements GuzzleHttp\Cookie\CookieJarInterface.

extractCookies()

GuzzleHttp\Cookie\CookieJar::extractCookies ( RequestInterface $request, ResponseInterface $response )

inherited

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>

setCookie()

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

inherited

@inheritDoc

Implements GuzzleHttp\Cookie\CookieJarInterface.

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

@inheritDoc

Implements GuzzleHttp\Cookie\CookieJarInterface.

withCookieHeader()

GuzzleHttp\Cookie\CookieJar::withCookieHeader ( RequestInterface $request )

inherited

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/SessionCookieJar.php