1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Cookie
  7. \
  8. CookieJar

CookieJar

class CookieJar (View source)

Properties

protected $cookies
protected $clearedCookies
protected $request

Methods

Cookie
set(string $name, string|null $value = null, int $expire = 0, string $path = '/', null|string $domain = null, bool $secure = false, bool $httpOnly = true)

Adds a CookieObject to the cookie pantry.

add(Cookie $cookie)

Adds a CookieObject to the array of cookies for the object.

bool
has(string $cookie)

Used to determine if the cookie key exists in the pantry.

clear($cookie)

No description

mixed
get(string $name, mixed $default = null)

No description

Cookie[]
getCookies()

No description

getClearedCookies()

No description

setRequest(Request $request)

Set a request for this cookie jar

getRequest()

No description

Details

at line 26
Cookie set(string $name, string|null $value = null, int $expire = 0, string $path = '/', null|string $domain = null, bool $secure = false, bool $httpOnly = true)

Adds a CookieObject to the cookie pantry.

Parameters

string $name

The cookie name
string|null $value

The value of the cookie
int $expire

The number of seconds until the cookie expires
string $path

The path for the cookie
null|string $domain

The domain the cookie is available to
bool $secure

whether the cookie should only be transmitted over a HTTPS connection from the client
bool $httpOnly

Whether the cookie will be made accessible only through the HTTP protocol

Return Value

Cookie

at line 46
add(Cookie $cookie)

Adds a CookieObject to the array of cookies for the object.

Parameters

Cookie $cookie

at line 58
bool has(string $cookie)

Used to determine if the cookie key exists in the pantry.

Parameters

string $cookie

Return Value

bool

at line 63
clear($cookie)

No description

Parameters

$cookie

at line 74
mixed get(string $name, mixed $default = null)

No description

Parameters

string $name

The key the cookie is stored under
mixed $default

A value to return if the cookie isn't set

Return Value

mixed

at line 86
Cookie[] getCookies()

No description

Return Value

Cookie[]

at line 91
getClearedCookies()

No description

at line 100
setRequest(Request $request)

Set a request for this cookie jar

Parameters

Request $request

at line 105
protected getRequest()

No description