Interface CookieInterface

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]

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

• getOptions() public

  Get cookie options

• getPath() public

  Get the path attribute.

• getSameSite() public

  Get the SameSite attribute.

• getScalarValue() public

  Gets the cookie value as scalar.

• 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

• toArray() public

  Get cookie data as array.

• 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

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

Method Detail

getDomain()

getExpiresTimestamp()

getExpiry()

getFormattedExpires()

getId()

getName()

getOptions()

getPath()

getSameSite()

getScalarValue()

getValue()

isExpired(mixed $time)

isHttpOnly()

isSecure()

toArray()

toHeaderValue()

withDomain(string $domain)

withExpired()

withExpiry(mixed $dateTime)

withHttpOnly(bool $httpOnly)

withName(string $name)

withNeverExpire()

withPath(string $path)

withSameSite(?string $sameSite)

withSecure(bool $secure)

withValue(mixed $value)