\GuzzleHttp\CookieFileCookieJar

__construct()

__construct(string  $cookieFile, boolean  $storeSessionCookies = false) 

Create a new FileCookieJar object

Parameters

Throws

\RuntimeException

if the file cannot be found or created

fromArray()

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

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

Parameters

Returns

getCookieValue()

getCookieValue(  $value) 

Parameters

shouldPersist()

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

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

Parameters

Returns

getCookieByName()

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

Finds and returns the cookie based on the name

Parameters

Returns

cookie that was found or null if not found

toArray()

toArray() : array

Converts the cookie jar to an array.

Returns

clear()

clear(string  $domain = null, string  $path = null, string  $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

Returns

clearSessionCookies()

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.

setCookie()

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

Sets a cookie in the cookie jar.

Parameters

Returns

Returns true on success or false on failure

count()

count() 

getIterator()

getIterator() 

extractCookies()

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

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

Parameters

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

Returns

returns the modified request.

__destruct()

__destruct() 

Saves the file when shutting down

save()

save(string  $filename) 

Saves the cookies to a file.

Parameters

Throws

\RuntimeException

if the file cannot be found or created

load()

load(string  $filename) 

Load cookies from a JSON formatted file.

Old cookies are kept unless overwritten by newly loaded ones.

Parameters

Throws

\RuntimeException

if the file cannot be loaded.

getCookiePathFromRequest()

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

Computes cookie path following RFC 6265 section 5.1.4

Parameters

Returns

removeCookieIfEmpty()

removeCookieIfEmpty(\GuzzleHttp\Cookie\SetCookie  $cookie) 

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

Parameters