1. class
  2. mako
  3. \
  4. http
  5. \
  6. response
  7. \
  8. Cookies

Cookies

class Cookies implements Countable, IteratorAggregate

Cookies.

Properties

protected array $defaults Default options.
protected array $cookies Cookies.
protected Signer $signer Signer instance.

Methods

__construct(Signer|null $signer = null)

Constructor.

int
count()

Returns the numner of cookies.

ArrayIterator
getIterator()

Retruns an array iterator object.

Cookies
setOptions(array $defaults)

Set default options values.

Cookies
add(string $name, string $value, int $ttl = 0, array $options = [], bool $raw = false)

Adds a unsigned cookie.

Cookies
addSigned(string $name, string $value, int $ttl = 0, array $options = [])

Adds a signed cookie.

bool
has(string $name)

Returns TRUE if the cookie exists and FALSE if not.

Cookies
remove(string $name)

Removes a cookie.

Cookies
delete(string $name, array $options = [])

Deletes a cookie.

Cookies
clear()

Clears all the cookies.

array
all()

Returns all the cookies.

Details

at line 58
__construct(Signer|null $signer = null)

Constructor.

Parameters

Signer|null $signer Signer

at line 68
int count()

Returns the numner of cookies.

Return Value

int

at line 78
ArrayIterator getIterator()

Retruns an array iterator object.

Return Value

ArrayIterator

at line 89
Cookies setOptions(array $defaults)

Set default options values.

Parameters

array $defaults Default option values

Return Value

Cookies

at line 106
Cookies add(string $name, string $value, int $ttl = 0, array $options = [], bool $raw = false)

Adds a unsigned cookie.

Parameters

string $name Cookie name
string $value Cookie value
int $ttl Time to live - if omitted or set to 0 the cookie will expire when the browser closes
array $options Cookie options
bool $raw Set the cookie without urlencoding the value?

Return Value

Cookies

at line 130
Cookies addSigned(string $name, string $value, int $ttl = 0, array $options = [])

Adds a signed cookie.

Parameters

string $name Cookie name
string $value Cookie value
int $ttl Time to live - if omitted or set to 0 the cookie will expire when the browser closes
array $options Cookie options

Return Value

Cookies

at line 146
bool has(string $name)

Returns TRUE if the cookie exists and FALSE if not.

Parameters

string $name Cookie name

Return Value

bool

at line 157
Cookies remove(string $name)

Removes a cookie.

Parameters

string $name Cookie name

Return Value

Cookies

at line 171
Cookies delete(string $name, array $options = [])

Deletes a cookie.

Parameters

string $name Cookie name
array $options Cookie options

Return Value

Cookies

at line 183
Cookies clear()

Clears all the cookies.

Return Value

Cookies

at line 195
array all()

Returns all the cookies.

Return Value

array