[ Index ]

PHP Cross Reference of phpBB-3.3.5-deutsch

title

Body

[close]

/vendor/guzzlehttp/guzzle/src/Cookie/ -> CookieJarInterface.php (summary)

(no description)

File Size: 84 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CookieJarInterface:: (6 methods):
  withCookieHeader()
  extractCookies()
  setCookie()
  clear()
  clearSessionCookies()
  toArray()


Interface: CookieJarInterface  - X-Ref

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.

withCookieHeader(RequestInterface $request)   X-Ref
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.

param: RequestInterface $request Request object to modify.
return: RequestInterface returns the modified request.

extractCookies(RequestInterface $request,ResponseInterface $response)   X-Ref
Extract cookies from an HTTP response and store them in the CookieJar.

param: RequestInterface  $request  Request that was sent
param: ResponseInterface $response Response that was received

setCookie(SetCookie $cookie)   X-Ref
Sets a cookie in the cookie jar.

param: SetCookie $cookie Cookie to set.
return: bool Returns true on success or false on failure

clear($domain = null, $path = null, $name = null)   X-Ref
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.

param: string|null $domain Clears cookies matching a domain
param: string|null $path   Clears cookies matching a domain and path
param: string|null $name   Clears cookies matching a domain, path, and name
return: CookieJarInterface

clearSessionCookies()   X-Ref
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()   X-Ref
Converts the cookie jar to an array.

return: array



Generated: Mon Oct 4 17:42:11 2021 Cross-referenced by PHPXref 0.7.1