CookieJar

class CookieJar (View source)

Properties

protected string	$path	The default path (if specified).
protected string	$domain	The default domain (if specified).
protected array	$queued	All of the cookies queued for sending.

Methods

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

Create a new cookie instance.

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).

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

Expire the given cookie.

bool

hasQueued(string $key)

Determine if a cookie has been queued.

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

Get a queued cookie instance.

void

queue()

Queue a cookie to send with the next response.

unqueue(string $name)

Remove a cookie from the queue.

array

getPathAndDomain(string $path, string $domain)

Get the path and domain, or the default values.

$this

setDefaultPathAndDomain(string $path, string $domain)

Set the default path and domain for the jar.

array

getQueuedCookies()

Get the cookies which have been queued for the next request

Details

Cookie make(string $name, string $value, int $minutes, 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 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 forget(string $name, string $path = null, string $domain = null)

Expire the given cookie.

Parameters

string	$name
string	$path
string	$domain

Return Value

bool hasQueued(string $key)

Determine if a cookie has been queued.

Parameters

string

$key

Return Value

bool

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

Get a queued cookie instance.

Parameters

string	$key
mixed	$default

Return Value

void queue()

Queue a cookie to send with the next response.

Return Value

void

unqueue(string $name)

Remove a cookie from the queue.

Parameters

string

$name

protected array getPathAndDomain(string $path, string $domain)

Get the path and domain, or the default values.

Parameters

string	$path
string	$domain

Return Value

array

$this setDefaultPathAndDomain(string $path, string $domain)

Set the default path and domain for the jar.

Parameters

string	$path
string	$domain

Return Value

$this

array getQueuedCookies()

Get the cookies which have been queued for the next request

Return Value

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Cookie/CookieJar.html