Cookie
class Cookie (View source)
A set of static methods for manipulating cookies.
Traits
Provides extensions to this object to integrate it with standard config API methods.
Constants
| SAMESITE_STRICT |
|
| SAMESITE_LAX |
|
| SAMESITE_NONE |
|
Config options
| report_errors | bool | ||
| default_samesite | string | Must be "Strict", "Lax", or "None" |
Properties
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Set a cookie variable.
Get the cookie value by name. Returns null if not set.
Force the expiry of a cookie by name
Get the default value for the "samesite" cookie attribute.
Validate if the samesite value for a cookie is valid for the current request.
Details
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
static Cookie_Backend
get_inst()
Fetch the current instance of the cookie backend.
static
set(string $name, string|false $value, int $expiry = 90, string|null $path = null, string|null $domain = null, bool $secure = false, bool $httpOnly = true, string $sameSite = '')
Set a cookie variable.
Expiry time is set in days, and defaults to 90.
static string|null
get(string $name, bool $includeUnsent = true)
Get the cookie value by name. Returns null if not set.
static array
get_all(bool $includeUnsent = true)
Get all the cookies.
static void
force_expiry(string $name, string|null $path = null, string|null $domain = null, bool $secure = false, bool $httpOnly = true, string $sameSite = '')
Force the expiry of a cookie by name
static string
getDefaultSameSite()
Get the default value for the "samesite" cookie attribute.
static void
validateSameSite(string $sameSite)
Validate if the samesite value for a cookie is valid for the current request.
Logs a warning if the samesite value is "None" for a non-https request.