Class Cookie

Constants summary

• string
  EXPIRES_FORMAT
  'D, d-M-Y H:i:s T'
• string
  SAMESITE_LAX
  'Lax'
• string
  SAMESITE_NONE
  'None'
• string
  SAMESITE_STRICT
  'Strict'
• string[]
  SAMESITE_VALUES
  [self::SAMESITE_LAX, self::SAMESITE_STRICT, self::SAMESITE_NONE]

Properties summary

• $domain protected
  string

  Domain

• $expiresAt protected
  \DateTime|\DateTimeImmutable|null

  Expiration time

• $httpOnly protected
  bool

  HTTP only

• $isExpanded protected
  bool

  Whether or not a JSON value has been expanded into an array.

• $name protected
  string

  Cookie name

• $path protected
  string

  Path

• $sameSite protected
  string|null

  Samesite

• $secure protected
  bool

  Secure

• $value protected
  string|array

  Raw Cookie value.

Method Summary

• __construct() public

  Constructor

• _expand() protected

  Explode method to return array from string set in CookieComponent::_flatten() Maintains reading backwards compatibility with 1.x CookieComponent::_flatten().

• _flatten() protected

  Implode method to keep keys are multidimensional arrays

• _setValue() protected

  Setter for the value attribute.

• check() public

  Checks if a value exists in the cookie data.

• 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.

• getSameSite() public

  Get the SameSite attribute.

• getStringValue() public

  Gets the cookie value as a string.

• getValue() public

  Gets the cookie value

• isExpanded() public

  Checks if the cookie value was expanded

• 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

• read() public

  Read data from the cookie

• toHeaderValue() public

  Returns a header value as string

• validateBool() protected

  Validate that an argument is a boolean

• validateName() protected

  Validates the cookie name

• validateSameSiteValue() protected static

  Check that value passed for SameSite is valid.

• validateString() protected

  Validate that an argument is a string

• withAddedValue() public

  Create a new cookie with updated data.

• 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

• withSameSite() public

  Create a cookie with an updated SameSite option.

• withSecure() public

  Create a cookie with Secure updated

• withValue() public

  Create a cookie with an updated value.

• withoutAddedValue() public

  Create a new cookie without a specific path

Method Detail

__construct(mixed $name, mixed $value, mixed $expiresAt, mixed $path, mixed $domain, mixed $secure, mixed $httpOnly, mixed $sameSite)

_expand(mixed $string)

_flatten(array $array)

_setValue(mixed $value)

check(mixed $path)

getDomain()

getExpiresTimestamp()

getExpiry()

getFormattedExpires()

getId()

getName()

getPath()

getSameSite()

getStringValue()

getValue()

isExpanded()

isExpired(mixed $time)

isHttpOnly()

isSecure()

read(mixed $path)

toHeaderValue()

validateBool(mixed $value)

validateName(mixed $name)

validateSameSiteValue(mixed $sameSite)

validateString(mixed $value)

withAddedValue(mixed $path, mixed $value)

withDomain(mixed $domain)

withExpired()

withExpiry(mixed $dateTime)

withHttpOnly(mixed $httpOnly)

withName(mixed $name)

withNeverExpire()

withPath(mixed $path)

withSameSite(mixed $sameSite)

withSecure(mixed $secure)

withValue(mixed $value)

withoutAddedValue(mixed $path)

Property Detail