1. class
  2. Illuminate
  3. \
  4. Cookie
  5. \
  6. CookieJar

CookieJar

class CookieJar implements QueueingFactory

Properties

protected string $path

The default path (if specified).
protected string $domain

The default domain (if specified).
protected bool $secure

The default secure setting (defaults to false).
protected array $queued

All of the cookies queued for sending.

Methods

Cookie
make(string $name, string $value, int $minutes = 0, string $path = null, string $domain = null, bool $secure = false, bool $httpOnly = true)

Create a new cookie instance.

Cookie
forever(string $name, string $value, string $path = null, string $domain = null, bool $secure = false, bool $httpOnly = true)

Create a cookie that lasts "forever" (five years).

Cookie
forget(string $name, string $path = null, string $domain = null)

Expire the given cookie.

bool
hasQueued(string $key)

Determine if a cookie has been queued.

Cookie
queued(string $key, mixed $default = null)

Get a queued cookie instance.

void
queue(array ...$parameters)

Queue a cookie to send with the next response.

unqueue(string $name)

Remove a cookie from the queue.

array
getPathAndDomain(string $path, string $domain, bool $secure = false)

Get the path and domain, or the default values.

$this
setDefaultPathAndDomain(string $path, string $domain, bool $secure = false)

Set the default path and domain for the jar.

array
getQueuedCookies()

Get the cookies which have been queued for the next request.

Details

at line 52
Cookie make(string $name, string $value, int $minutes = 0, string $path = null, string $domain = null, bool $secure = false, bool $httpOnly = true)

Create a new cookie instance.

Parameters

string $name
string $value
int $minutes
string $path
string $domain
bool $secure
bool $httpOnly

Return Value

Cookie

at line 72
Cookie forever(string $name, string $value, string $path = null, string $domain = null, bool $secure = false, bool $httpOnly = true)

Create a cookie that lasts "forever" (five years).

Parameters

string $name
string $value
string $path
string $domain
bool $secure
bool $httpOnly

Return Value

Cookie

at line 85
Cookie forget(string $name, string $path = null, string $domain = null)

Expire the given cookie.

Parameters

string $name
string $path
string $domain

Return Value

Cookie

at line 96
bool hasQueued(string $key)

Determine if a cookie has been queued.

Parameters

string $key

Return Value

bool

at line 108
Cookie queued(string $key, mixed $default = null)

Get a queued cookie instance.

Parameters

string $key
mixed $default

Return Value

Cookie

at line 119
void queue(array ...$parameters)

Queue a cookie to send with the next response.

Parameters

array ...$parameters

Return Value

void

at line 136
unqueue(string $name)

Remove a cookie from the queue.

Parameters

string $name

at line 149
protected array getPathAndDomain(string $path, string $domain, bool $secure = false)

Get the path and domain, or the default values.

Parameters

string $path
string $domain
bool $secure

Return Value

array

at line 162
$this setDefaultPathAndDomain(string $path, string $domain, bool $secure = false)

Set the default path and domain for the jar.

Parameters

string $path
string $domain
bool $secure

Return Value

$this

at line 174
array getQueuedCookies()

Get the cookies which have been queued for the next request.

Return Value

array