Documentation

Cookie extends Helper
in package

Table of Contents

$app  : App
$_cookies  : array<string|int, mixed>
$_deleted_cookies  : array<string|int, mixed>
__call()  : mixed
__construct()  : mixed
__get()  : mixed
__invoke()  : mixed
delete()  : bool
deletes a cookie
get()  : mixed
gets a cookie
getAndDelete()  : mixed
gets a cookie and eats it
initialize()  : mixed
set()  : bool
sets a cookie

Properties

$_cookies

protected array<string|int, mixed> $_cookies = array()

$_deleted_cookies

protected array<string|int, mixed> $_deleted_cookies = array()

Methods

__call()

public __call(mixed $name, mixed $arguments) : mixed
Parameters
$name : mixed
$arguments : mixed
Return values
mixed

__construct()

public __construct(mixed $app) : mixed
Parameters
$app : mixed
Return values
mixed

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

__invoke()

public __invoke(mixed $helper) : mixed
Parameters
$helper : mixed
Return values
mixed

delete()

deletes a cookie

public delete(string $name[, mixed $path = '/' ][, mixed $domain = '' ][, mixed $secure = false ][, mixed $http_only = false ][, mixed $same_site = null ]) : bool
Parameters
$name : string
$path : mixed = '/'
$domain : mixed = ''
$secure : mixed = false
$http_only : mixed = false
$same_site : mixed = null
Return values
bool

get()

gets a cookie

public get(string $name) : mixed
Parameters
$name : string
Return values
mixed

getAndDelete()

gets a cookie and eats it

public getAndDelete(string $name[, mixed $path = '/' ][, mixed $domain = '' ][, mixed $secure = false ][, mixed $http_only = false ][, mixed $same_site = null ]) : mixed
Parameters
$name : string
$path : mixed = '/'
$domain : mixed = ''
$secure : mixed = false
$http_only : mixed = false
$same_site : mixed = null
Return values
mixed

initialize()

public initialize() : mixed
Return values
mixed

set()

sets a cookie

public set(string $name[, string $value = "" ][, mixed $ttl = 86400 ][, string $path = '/' ][, string $domain = '' ][, bool $secure = false ][, bool $http_only = false ][, (string|null) $same_site = null ]) : bool
Parameters
$name : string
$value : string = ""
$ttl : mixed = 86400
$path : string = '/'
$domain : string = ''
$secure : bool = false
$http_only : bool = false
$same_site : (string|null) = null
Tags
throws
Exception
  • throws Exception if SameSite=None and Secure=False
Return values
bool

Search results