\GuzzleHttp\CookieCookieJarInterface

Stores HTTP cookies.

It extracts cookies from HTTP requests, and returns them in HTTP responses. CookieJarInterface instances automatically expire contained cookies when necessary. Subclasses are also responsible for storing and retrieving cookies from a file, database, etc.

Summary

Methods

Constants

withCookieHeader()
extractCookies()
setCookie()
clear()
clearSessionCookies()
toArray()

No constants found

No protected methods found

N/A

No private methods found

N/A

File: serve/vendor/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php
Package: \Application
Parents
See also: Inspiration

Methods

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.

extractCookies()

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

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

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

clear()

clear(string|null  $domain = null, string|null  $path = null, string|null  $name = null) : void

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

string\|null	$domain	Clears cookies matching a domain
string\|null	$path	Clears cookies matching a domain and path
string\|null	$name	Clears cookies matching a domain, path, and name

clearSessionCookies()

clearSessionCookies() : void

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.

toArray()

toArray() : array

Converts the cookie jar to an array.

Returns

array —

extends	\IteratorAggregate<SetCookie>
uses