getDomain()source public

getDomain( )

Get the domain attribute.

Returns

getExpiresTimestamp()source public

getExpiresTimestamp( )

Get the timestamp from the expiration time

Timestamps are strings as large timestamps can overflow MAX_INT in 32bit systems.

Returns

getExpiry()source public

getExpiry( )

Get the current expiry time

Returns

getFormattedExpires()source public

getFormattedExpires( )

Builds the expiration value part of the header string

Returns

getId()source public

getId( )

Get the id for a cookie

Cookies are unique across name, domain, path tuples.

Returns

getName()source public

getName( )

Gets the cookie name

Returns

getPath()source public

getPath( )

Get the path attribute.

Returns

getValue()source public

getValue( )

Gets the cookie value

Returns

isExpired()source public

isExpired( DateTime|DateTimeImmutable $time null )

Check if a cookie is expired when compared to $time

Cookies without an expiration date always return false.

Parameters

DateTime|DateTimeImmutable $time optional null

The time to test against. Defaults to 'now' in UTC.

Returns

isHttpOnly()source public

isHttpOnly( )

Check if the cookie is HTTP only

Returns

isSecure()source public

isSecure( )

Check if the cookie is secure

Returns

toHeaderValue()source public

toHeaderValue( )

Returns the cookie as header value

Returns

withDomain()source public

withDomain( string $domain )

Create a cookie with an updated domain

Parameters

string $domain

Domain to set

Returns

withExpired()source public

withExpired( )

Create a new cookie that will expire/delete the cookie from the browser.

This is done by setting the expiration time to 1 year ago

Returns

withExpiry()source public

withExpiry( DateTime|DateTimeImmutable $dateTime )

Create a cookie with an updated expiration date

Parameters

DateTime|DateTimeImmutable $dateTime

Date time object

Returns

withHttpOnly()source public

withHttpOnly( boolean $httpOnly )

Create a cookie with HTTP Only updated

Parameters

boolean $httpOnly

HTTP Only

Returns

withName()source public

withName( string $name )

Sets the cookie name

Parameters

string $name

Name of the cookie

Returns

withNeverExpire()source public

withNeverExpire( )

Create a new cookie that will virtually never expire.

Returns

withPath()source public

withPath( string $path )

Create a new cookie with an updated path

Parameters

string $path

Sets the path

Returns

withSecure()source public

withSecure( boolean $secure )

Create a cookie with Secure updated

Parameters

boolean $secure

Secure attribute value

Returns

withValue()source public

withValue( string|array $value )

Create a cookie with an updated value.

Parameters

string|array $value

Value of the cookie to set

Returns