CodeIgniter v4.5 API

Cookie

in package

• Application

implements ArrayAccess, CloneableCookieInterface

A `Cookie` class represents an immutable HTTP cookie value object.

$cookie = new Cookie('test_cookie', 'test_value');
$cookie->getName(); // test_cookie

$cookie->withName('prod_cookie');
$cookie->getName(); // test_cookie

$cookie2 = $cookie->withName('prod_cookie');
$cookie2->getName(); // prod_cookie

Tags

template-implements

ArrayAccess<string, bool|int|string>

see

CookieTest

Table of Contents

Interfaces

ArrayAccess

CloneableCookieInterface

Interface for a fresh Cookie instance with selected attribute(s) only changed from the original instance.

Properties

$domain  : string

$expires  : int

$httponly  : bool

$name  : string

$path  : string

$prefix  : string

$raw  : bool

$samesite  : string

$secure  : bool

$value  : string

$defaults  : array<string, bool|int|string>

Default attributes for a Cookie object. The keys here are the lowercase attribute names. Do not camelCase!

$reservedCharsList  : string

A cookie name can be any US-ASCII characters, except control characters, spaces, tabs, or separator characters.

Methods

__construct()  : mixed

Construct a new Cookie instance.

__toString()  : string

Returns the string representation of the Cookie object.

fromHeaderString()  : static

Create a new Cookie instance from a `Set-Cookie` header.

getDomain()  : string

Gets the "Domain" cookie attribute.

getExpiresString()  : string

Gets the formatted expires time.

getExpiresTimestamp()  : int

Gets the time in Unix timestamp the cookie expires.

getId()  : string

Returns a unique identifier for the cookie consisting of its prefixed name, path, and domain.

getMaxAge()  : int

Gets the "Max-Age" cookie attribute.

getName()  : string

Gets the cookie name.

getOptions()  : array<string, bool|int|string>

Gets the options that are passable to the `setcookie` variant available on PHP 7.3+

getPath()  : string

Gets the "Path" cookie attribute.

getPrefix()  : string

Gets the cookie prefix.

getPrefixedName()  : string

Gets the cookie name prepended with the prefix, if any.

getSameSite()  : string

Gets the "SameSite" cookie attribute.

getValue()  : string

Gets the cookie value.

isExpired()  : bool

Checks if the cookie is expired.

isHTTPOnly()  : bool

Gets the "HttpOnly" cookie attribute.

isRaw()  : bool

Checks if the cookie should be sent with no URL encoding.

isSecure()  : bool

Gets the "Secure" cookie attribute.

offsetExists()  : bool

Whether an offset exists.

offsetGet()  : bool|int|string

Offset to retrieve.

offsetSet()  : void

Offset to set.

offsetUnset()  : void

Offset to unset.

setDefaults()  : array<string, mixed>

Set the default attributes to a Cookie instance by injecting the values from the `CookieConfig` config or an array.

toArray()  : array<string, bool|int|string>

Returns the array representation of the Cookie object.

toHeaderString()  : string

Returns the Cookie as a header value.

withDomain()  : static

Creates a new Cookie with a new domain the cookie is available.

withExpired()  : static

Creates a new Cookie that will expire the cookie from the browser.

withExpires()  : static

Creates a new Cookie with a new cookie expires time.

withHTTPOnly()  : static

Creates a new Cookie with a new "HttpOnly" attribute

withName()  : static

Creates a new Cookie with a new name.

withNeverExpiring()  : static

Creates a new Cookie that will virtually never expire from the browser.

withPath()  : static

Creates a new Cookie with a new path on the server the cookie is available.

withPrefix()  : static

Creates a new Cookie with a new cookie prefix.

withRaw()  : static

Creates a new Cookie with URL encoding option updated.

withSameSite()  : static

Creates a new Cookie with a new "SameSite" attribute.

withSecure()  : static

Creates a new Cookie with a new "Secure" attribute.

withValue()  : static

Creates a new Cookie with new value.

convertExpiresTimestamp()  : int

Converts expires time to Unix format.

validateName()  : void

Validates the cookie name per RFC 2616.

validatePrefix()  : void

Validates the special prefixes if some attribute requirements are met.

validateSameSite()  : void

Validates the `SameSite` to be within the allowed types.