Open Journal Systems  3.3.0
Public Member Functions | Static Public Member Functions
GuzzleHttp\Cookie\CookieJar Class Reference
Inheritance diagram for GuzzleHttp\Cookie\CookieJar:
GuzzleHttp\Cookie\CookieJarInterface GuzzleHttp\Cookie\FileCookieJar GuzzleHttp\Cookie\SessionCookieJar

Public Member Functions

 __construct ($strictMode=false, $cookieArray=[])
 
 clear ($domain=null, $path=null, $name=null)
 
 clearSessionCookies ()
 
 count ()
 
 extractCookies (RequestInterface $request, ResponseInterface $response)
 
 getCookieByName ($name)
 
 getIterator ()
 
 setCookie (SetCookie $cookie)
 
 toArray ()
 
 withCookieHeader (RequestInterface $request)
 

Static Public Member Functions

static fromArray (array $cookies, $domain)
 
static getCookieValue ($value)
 
static shouldPersist (SetCookie $cookie, $allowSessionCookies=false)
 

Detailed Description

Cookie jar that stores cookies as an array

Definition at line 10 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

Constructor & Destructor Documentation

◆ __construct()

GuzzleHttp\Cookie\CookieJar::__construct (   $strictMode = false,
  $cookieArray = [] 
)
Parameters
bool$strictModeSet to true to throw exceptions when invalid cookies are added to the cookie jar.
array$cookieArrayArray of SetCookie objects or a hash of arrays that can be used with the SetCookie constructor

Reimplemented in GuzzleHttp\Cookie\SessionCookieJar, and GuzzleHttp\Cookie\FileCookieJar.

Definition at line 31 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

References GuzzleHttp\Cookie\CookieJar\setCookie().

Member Function Documentation

◆ clear()

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

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$domainClears cookies matching a domain
string | null$pathClears cookies matching a domain and path
string | null$nameClears cookies matching a domain, path, and name
Returns
CookieJarInterface

Implements GuzzleHttp\Cookie\CookieJarInterface.

Definition at line 123 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

References GuzzleHttp\Cookie\SetCookie\getName(), GuzzleHttp\Cookie\SetCookie\matchesDomain(), and GuzzleHttp\Cookie\SetCookie\matchesPath().

◆ clearSessionCookies()

GuzzleHttp\Cookie\CookieJar::clearSessionCookies ( )

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.

Implements GuzzleHttp\Cookie\CookieJarInterface.

Definition at line 155 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

References GuzzleHttp\Cookie\SetCookie\getDiscard(), and GuzzleHttp\Cookie\SetCookie\getExpires().

◆ count()

GuzzleHttp\Cookie\CookieJar::count ( )

Definition at line 226 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

◆ extractCookies()

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

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

Parameters
RequestInterface$requestRequest that was sent
ResponseInterface$responseResponse that was received

Implements GuzzleHttp\Cookie\CookieJarInterface.

Definition at line 236 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

References GuzzleHttp\Cookie\SetCookie\fromString(), Psr\Http\Message\RequestInterface\getUri(), and GuzzleHttp\Cookie\CookieJar\setCookie().

◆ fromArray()

static GuzzleHttp\Cookie\CookieJar::fromArray ( array  $cookies,
  $domain 
)
static

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

Parameters
array$cookiesCookies to create the jar from
string$domainDomain to set the cookies to
Returns
self

Definition at line 51 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

◆ getCookieByName()

GuzzleHttp\Cookie\CookieJar::getCookieByName (   $name)

Finds and returns the cookie based on the name

Parameters
string$namecookie name to search for
Returns
SetCookie|null cookie that was found or null if not found

Definition at line 101 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

◆ getCookieValue()

static GuzzleHttp\Cookie\CookieJar::getCookieValue (   $value)
static
Deprecated:

Definition at line 69 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

◆ getIterator()

GuzzleHttp\Cookie\CookieJar::getIterator ( )

Definition at line 231 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

Referenced by GuzzleHttp\Cookie\CookieJar\toArray().

◆ setCookie()

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

Sets a cookie in the cookie jar.

Parameters
SetCookie$cookieCookie to set.
Returns
bool Returns true on success or false on failure

Implements GuzzleHttp\Cookie\CookieJarInterface.

Definition at line 165 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

References GuzzleHttp\Cookie\SetCookie\getDiscard(), GuzzleHttp\Cookie\SetCookie\getDomain(), GuzzleHttp\Cookie\SetCookie\getExpires(), GuzzleHttp\Cookie\SetCookie\getName(), GuzzleHttp\Cookie\SetCookie\getPath(), GuzzleHttp\Cookie\SetCookie\getValue(), and GuzzleHttp\Cookie\SetCookie\validate().

Referenced by GuzzleHttp\Cookie\CookieJar\__construct(), GuzzleHttp\Cookie\CookieJar\extractCookies(), GuzzleHttp\Cookie\SessionCookieJar\load(), and GuzzleHttp\Cookie\FileCookieJar\load().

◆ shouldPersist()

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

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

Parameters
SetCookie$cookieBeing evaluated.
bool$allowSessionCookiesIf we should persist session cookies
Returns
bool

Definition at line 82 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

References GuzzleHttp\Cookie\SetCookie\getDiscard(), and GuzzleHttp\Cookie\SetCookie\getExpires().

Referenced by GuzzleHttp\Cookie\SessionCookieJar\save(), and GuzzleHttp\Cookie\FileCookieJar\save().

◆ toArray()

GuzzleHttp\Cookie\CookieJar::toArray ( )

Converts the cookie jar to an array.

Returns
array

Implements GuzzleHttp\Cookie\CookieJarInterface.

Definition at line 116 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

References GuzzleHttp\Cookie\CookieJar\getIterator(), and GuzzleHttp\Cookie\SetCookie\toArray().

◆ withCookieHeader()

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

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$requestRequest object to modify.
Returns
RequestInterface returns the modified request.

Implements GuzzleHttp\Cookie\CookieJarInterface.

Definition at line 281 of file guzzlehttp/guzzle/src/Cookie/CookieJar.php.

References Psr\Http\Message\RequestInterface\getUri(), and Psr\Http\Message\MessageInterface\withHeader().

The documentation for this class was generated from the following file: