Interface CookieInterface
Cookie Interface
Direct Implementers
Constants summary
Method Summary
-
getDomain() public
Get the domain attribute. -
getExpiresTimestamp() public
Get the timestamp from the expiration time -
getExpiry() public
Get the current expiry time -
getFormattedExpires() public
Builds the expiration value part of the header string -
getId() public
Get the id for a cookie -
getName() public
Gets the cookie name -
getPath() public
Get the path attribute. -
getStringValue() public
Gets the cookie value as a string. -
getValue() public
Gets the cookie value -
isExpired() public
Check if a cookie is expired when compared to $time -
isHttpOnly() public
Check if the cookie is HTTP only -
isSecure() public
Check if the cookie is secure -
toHeaderValue() public
Returns the cookie as header value -
withDomain() public
Create a cookie with an updated domain -
withExpired() public
Create a new cookie that will expire/delete the cookie from the browser. -
withExpiry() public
Create a cookie with an updated expiration date -
withHttpOnly() public
Create a cookie with HTTP Only updated -
withName() public
Sets the cookie name -
withNeverExpire() public
Create a new cookie that will virtually never expire. -
withPath() public
Create a new cookie with an updated path -
withSecure() public
Create a cookie with Secure updated -
withValue() public
Create a cookie with an updated value.
Method Detail
getExpiresTimestamp() public ¶
getExpiresTimestamp( )
Get the timestamp from the expiration time
Timestamps are strings as large timestamps can overflow MAX_INT in 32bit systems.
Returns
The expiry time as a string timestamp.
getExpiry() public ¶
getExpiry( )
Get the current expiry time
Returns
Timestamp of expiry or null
getFormattedExpires() public ¶
getFormattedExpires( )
Builds the expiration value part of the header string
Returns
getId() public ¶
getId( )
Get the id for a cookie
Cookies are unique across name, domain, path tuples.
Returns
getStringValue() public ¶
getStringValue( )
Gets the cookie value as a string.
This will collapse any complex data in the cookie with json_encode()
Returns
isExpired() 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
withDomain() public ¶
withDomain( string $domain )
Create a cookie with an updated domain
Parameters
- string $domain
- Domain to set
Returns
withExpired() 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() public ¶
withExpiry( DateTime|DateTimeImmutable $dateTime )
Create a cookie with an updated expiration date
Parameters
- DateTime|DateTimeImmutable $dateTime
- Date time object
Returns
withHttpOnly() public ¶
withHttpOnly( boolean $httpOnly )
Create a cookie with HTTP Only updated
Parameters
- boolean $httpOnly
- HTTP Only
Returns
withName() public ¶
withName( string $name )
Sets the cookie name
Parameters
- string $name
- Name of the cookie
Returns
withPath() public ¶
withPath( string $path )
Create a new cookie with an updated path
Parameters
- string $path
- Sets the path
Returns
withSecure() public ¶
withSecure( boolean $secure )
Create a cookie with Secure updated
Parameters
- boolean $secure
- Secure attribute value
Returns
withValue() public ¶
withValue( string|array $value )
Create a cookie with an updated value.
Parameters
- string|array $value
- Value of the cookie to set