/var/www/vhosts/ihelp.ro/httpdocs/vendor/cakephp/cakephp/src/Http/Cookie
Edit: /var/www/vhosts/ihelp.ro/httpdocs/vendor/cakephp/cakephp/src/Http/Cookie/CookieInterface.php (5816B)
*/
public const SAMESITE_VALUES = [
self::SAMESITE_LAX,
self::SAMESITE_STRICT,
self::SAMESITE_NONE,
];
/**
* Sets the cookie name
*
* @param string $name Name of the cookie
* @return static
*/
public function withName(string $name);
/**
* Gets the cookie name
*
* @return string
*/
public function getName(): string;
/**
* Gets the cookie value
*
* @return array|string
*/
public function getValue();
/**
* Gets the cookie value as scalar.
*
* This will collapse any complex data in the cookie with json_encode()
*
* @return mixed
*/
public function getScalarValue();
/**
* Create a cookie with an updated value.
*
* @param array|string $value Value of the cookie to set
* @return static
*/
public function withValue($value);
/**
* Get the id for a cookie
*
* Cookies are unique across name, domain, path tuples.
*
* @return string
*/
public function getId(): string;
/**
* Get the path attribute.
*
* @return string
*/
public function getPath(): string;
/**
* Create a new cookie with an updated path
*
* @param string $path Sets the path
* @return static
*/
public function withPath(string $path);
/**
* Get the domain attribute.
*
* @return string
*/
public function getDomain(): string;
/**
* Create a cookie with an updated domain
*
* @param string $domain Domain to set
* @return static
*/
public function withDomain(string $domain);
/**
* Get the current expiry time
*
* @return \DateTime|\DateTimeImmutable|null Timestamp of expiry or null
*/
public function getExpiry();
/**
* Get the timestamp from the expiration time
*
* @return int|null The expiry time as an integer.
*/
public function getExpiresTimestamp(): ?int;
/**
* Builds the expiration value part of the header string
*
* @return string
*/
public function getFormattedExpires(): string;
/**
* Create a cookie with an updated expiration date
*
* @param \DateTime|\DateTimeImmutable $dateTime Date time object
* @return static
*/
public function withExpiry($dateTime);
/**
* Create a new cookie that will virtually never expire.
*
* @return static
*/
public function withNeverExpire();
/**
* 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
*
* @return static
*/
public function withExpired();
/**
* Check if a cookie is expired when compared to $time
*
* Cookies without an expiration date always return false.
*
* @param \DateTime|\DateTimeImmutable $time The time to test against. Defaults to 'now' in UTC.
* @return bool
*/
public function isExpired($time = null): bool;
/**
* Check if the cookie is HTTP only
*
* @return bool
*/
public function isHttpOnly(): bool;
/**
* Create a cookie with HTTP Only updated
*
* @param bool $httpOnly HTTP Only
* @return static
*/
public function withHttpOnly(bool $httpOnly);
/**
* Check if the cookie is secure
*
* @return bool
*/
public function isSecure(): bool;
/**
* Create a cookie with Secure updated
*
* @param bool $secure Secure attribute value
* @return static
*/
public function withSecure(bool $secure);
/**
* Get the SameSite attribute.
*
* @return string|null
*/
public function getSameSite(): ?string;
/**
* Create a cookie with an updated SameSite option.
*
* @param string|null $sameSite Value for to set for Samesite option.
* One of CookieInterface::SAMESITE_* constants.
* @return static
*/
public function withSameSite(?string $sameSite);
/**
* Get cookie options
*
* @return array
*/
public function getOptions(): array;
/**
* Get cookie data as array.
*
* @return array With keys `name`, `value`, `expires` etc. options.
*/
public function toArray(): array;
/**
* Returns the cookie as header value
*
* @return string
*/
public function toHeaderValue(): string;
}