1. class
  2. Plugins
  3. \
  4. FLeaderPlugin
  5. \
  6. lib
  7. \
  8. Cookie
  9. \
  10. CookieStorage

CookieStorage

class CookieStorage

Class CookieStorage

Properties

protected $cookies

Methods

__construct(bool $cookieFile)

FLeaderCookieStorage constructor.

setCookies($cookies)

No description

getCookies()

No description

addCookie(Cookie $cookie)

Adds a cookie to the current cookie jar.

addCookieHeaders(RequestInterface $request)

Adds Cookie headers to the supplied request.

processSetCookieHeaders(RequestInterface $request, MessageInterface $response)

Processes Set-Cookie headers from a request/response pair.

clearExpiredCookies()

Removes expired cookies.

save(string $filename)

Saves the cookies to a file.

load(string $filename)

Load cookies from a serialized formatted file.

__destruct()

Saves the file when shutting down

Details

at line 25
__construct(bool $cookieFile)

FLeaderCookieStorage constructor.

Parameters

bool $cookieFile

at line 34
setCookies($cookies)

Parameters

$cookies

at line 42
getCookies()

at line 52
addCookie(Cookie $cookie)

Adds a cookie to the current cookie jar.

Parameters

Cookie $cookie A cookie object

at line 63
addCookieHeaders(RequestInterface $request)

Adds Cookie headers to the supplied request.

Parameters

RequestInterface $request A request object

at line 78
processSetCookieHeaders(RequestInterface $request, MessageInterface $response)

Processes Set-Cookie headers from a request/response pair.

Parameters

RequestInterface $request A request object
MessageInterface $response A response object

at line 91
clearExpiredCookies()

Removes expired cookies.

at line 110
save(string $filename)

Saves the cookies to a file.

Parameters

string $filename File to save

Exceptions

RuntimeException if the file cannot be found or created

at line 128
load(string $filename)

Load cookies from a serialized formatted file.

Old cookies are kept unless overwritten by newly loaded ones.

Parameters

string $filename Cookie file to load.

Exceptions

RuntimeException if the file cannot be loaded.

at line 148
__destruct()

Saves the file when shutting down