package and depencies
This commit is contained in:
113
vendor/symfony/http-foundation/Cookie.php
vendored
113
vendor/symfony/http-foundation/Cookie.php
vendored
@@ -30,9 +30,9 @@ class Cookie
|
||||
protected $secure;
|
||||
protected $httpOnly;
|
||||
|
||||
private $raw;
|
||||
private $sameSite;
|
||||
private $secureDefault = false;
|
||||
private bool $raw;
|
||||
private ?string $sameSite = null;
|
||||
private bool $secureDefault = false;
|
||||
|
||||
private const RESERVED_CHARS_LIST = "=,; \t\r\n\v\f";
|
||||
private const RESERVED_CHARS_FROM = ['=', ',', ';', ' ', "\t", "\r", "\n", "\v", "\f"];
|
||||
@@ -40,10 +40,8 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Creates cookie from raw header string.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public static function fromString(string $cookie, bool $decode = false)
|
||||
public static function fromString(string $cookie, bool $decode = false): static
|
||||
{
|
||||
$data = [
|
||||
'expires' => 0,
|
||||
@@ -71,7 +69,12 @@ class Cookie
|
||||
return new static($name, $value, $data['expires'], $data['path'], $data['domain'], $data['secure'], $data['httponly'], $data['raw'], $data['samesite']);
|
||||
}
|
||||
|
||||
public static function create(string $name, string $value = null, $expire = 0, ?string $path = '/', string $domain = null, bool $secure = null, bool $httpOnly = true, bool $raw = false, ?string $sameSite = self::SAMESITE_LAX): self
|
||||
/**
|
||||
* @see self::__construct
|
||||
*
|
||||
* @param self::SAMESITE_*|''|null $sameSite
|
||||
*/
|
||||
public static function create(string $name, string $value = null, int|string|\DateTimeInterface $expire = 0, ?string $path = '/', string $domain = null, bool $secure = null, bool $httpOnly = true, bool $raw = false, ?string $sameSite = self::SAMESITE_LAX): self
|
||||
{
|
||||
return new self($name, $value, $expire, $path, $domain, $secure, $httpOnly, $raw, $sameSite);
|
||||
}
|
||||
@@ -85,11 +88,11 @@ class Cookie
|
||||
* @param bool|null $secure Whether the client should send back the cookie only over HTTPS or null to auto-enable this when the request is already using HTTPS
|
||||
* @param bool $httpOnly Whether the cookie will be made accessible only through the HTTP protocol
|
||||
* @param bool $raw Whether the cookie value should be sent with no url encoding
|
||||
* @param string|null $sameSite Whether the cookie will be available for cross-site requests
|
||||
* @param self::SAMESITE_*|''|null $sameSite Whether the cookie will be available for cross-site requests
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
public function __construct(string $name, string $value = null, $expire = 0, ?string $path = '/', string $domain = null, bool $secure = null, bool $httpOnly = true, bool $raw = false, ?string $sameSite = 'lax')
|
||||
public function __construct(string $name, string $value = null, int|string|\DateTimeInterface $expire = 0, ?string $path = '/', string $domain = null, bool $secure = null, bool $httpOnly = true, bool $raw = false, ?string $sameSite = self::SAMESITE_LAX)
|
||||
{
|
||||
// from PHP source code
|
||||
if ($raw && false !== strpbrk($name, self::RESERVED_CHARS_LIST)) {
|
||||
@@ -113,10 +116,8 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Creates a cookie copy with a new value.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public function withValue(?string $value): self
|
||||
public function withValue(?string $value): static
|
||||
{
|
||||
$cookie = clone $this;
|
||||
$cookie->value = $value;
|
||||
@@ -126,10 +127,8 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Creates a cookie copy with a new domain that the cookie is available to.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public function withDomain(?string $domain): self
|
||||
public function withDomain(?string $domain): static
|
||||
{
|
||||
$cookie = clone $this;
|
||||
$cookie->domain = $domain;
|
||||
@@ -139,12 +138,8 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Creates a cookie copy with a new time the cookie expires.
|
||||
*
|
||||
* @param int|string|\DateTimeInterface $expire
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public function withExpires($expire = 0): self
|
||||
public function withExpires(int|string|\DateTimeInterface $expire = 0): static
|
||||
{
|
||||
$cookie = clone $this;
|
||||
$cookie->expire = self::expiresTimestamp($expire);
|
||||
@@ -154,10 +149,8 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Converts expires formats to a unix timestamp.
|
||||
*
|
||||
* @param int|string|\DateTimeInterface $expire
|
||||
*/
|
||||
private static function expiresTimestamp($expire = 0): int
|
||||
private static function expiresTimestamp(int|string|\DateTimeInterface $expire = 0): int
|
||||
{
|
||||
// convert expiration time to a Unix timestamp
|
||||
if ($expire instanceof \DateTimeInterface) {
|
||||
@@ -175,10 +168,8 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Creates a cookie copy with a new path on the server in which the cookie will be available on.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public function withPath(string $path): self
|
||||
public function withPath(string $path): static
|
||||
{
|
||||
$cookie = clone $this;
|
||||
$cookie->path = '' === $path ? '/' : $path;
|
||||
@@ -188,10 +179,8 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Creates a cookie copy that only be transmitted over a secure HTTPS connection from the client.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public function withSecure(bool $secure = true): self
|
||||
public function withSecure(bool $secure = true): static
|
||||
{
|
||||
$cookie = clone $this;
|
||||
$cookie->secure = $secure;
|
||||
@@ -201,10 +190,8 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Creates a cookie copy that be accessible only through the HTTP protocol.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public function withHttpOnly(bool $httpOnly = true): self
|
||||
public function withHttpOnly(bool $httpOnly = true): static
|
||||
{
|
||||
$cookie = clone $this;
|
||||
$cookie->httpOnly = $httpOnly;
|
||||
@@ -214,10 +201,8 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Creates a cookie copy that uses no url encoding.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public function withRaw(bool $raw = true): self
|
||||
public function withRaw(bool $raw = true): static
|
||||
{
|
||||
if ($raw && false !== strpbrk($this->name, self::RESERVED_CHARS_LIST)) {
|
||||
throw new \InvalidArgumentException(sprintf('The cookie name "%s" contains invalid characters.', $this->name));
|
||||
@@ -232,9 +217,9 @@ class Cookie
|
||||
/**
|
||||
* Creates a cookie copy with SameSite attribute.
|
||||
*
|
||||
* @return static
|
||||
* @param self::SAMESITE_*|''|null $sameSite
|
||||
*/
|
||||
public function withSameSite(?string $sameSite): self
|
||||
public function withSameSite(?string $sameSite): static
|
||||
{
|
||||
if ('' === $sameSite) {
|
||||
$sameSite = null;
|
||||
@@ -254,10 +239,8 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Returns the cookie as a string.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function __toString()
|
||||
public function __toString(): string
|
||||
{
|
||||
if ($this->isRaw()) {
|
||||
$str = $this->getName();
|
||||
@@ -268,12 +251,12 @@ class Cookie
|
||||
$str .= '=';
|
||||
|
||||
if ('' === (string) $this->getValue()) {
|
||||
$str .= 'deleted; expires='.gmdate('D, d-M-Y H:i:s T', time() - 31536001).'; Max-Age=0';
|
||||
$str .= 'deleted; expires='.gmdate('D, d M Y H:i:s T', time() - 31536001).'; Max-Age=0';
|
||||
} else {
|
||||
$str .= $this->isRaw() ? $this->getValue() : rawurlencode($this->getValue());
|
||||
|
||||
if (0 !== $this->getExpiresTime()) {
|
||||
$str .= '; expires='.gmdate('D, d-M-Y H:i:s T', $this->getExpiresTime()).'; Max-Age='.$this->getMaxAge();
|
||||
$str .= '; expires='.gmdate('D, d M Y H:i:s T', $this->getExpiresTime()).'; Max-Age='.$this->getMaxAge();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -302,50 +285,40 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Gets the name of the cookie.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getName()
|
||||
public function getName(): string
|
||||
{
|
||||
return $this->name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of the cookie.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getValue()
|
||||
public function getValue(): ?string
|
||||
{
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the domain that the cookie is available to.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getDomain()
|
||||
public function getDomain(): ?string
|
||||
{
|
||||
return $this->domain;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the time the cookie expires.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getExpiresTime()
|
||||
public function getExpiresTime(): int
|
||||
{
|
||||
return $this->expire;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the max-age attribute.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getMaxAge()
|
||||
public function getMaxAge(): int
|
||||
{
|
||||
$maxAge = $this->expire - time();
|
||||
|
||||
@@ -354,60 +327,48 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Gets the path on the server in which the cookie will be available on.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getPath()
|
||||
public function getPath(): string
|
||||
{
|
||||
return $this->path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isSecure()
|
||||
public function isSecure(): bool
|
||||
{
|
||||
return $this->secure ?? $this->secureDefault;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether the cookie will be made accessible only through the HTTP protocol.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isHttpOnly()
|
||||
public function isHttpOnly(): bool
|
||||
{
|
||||
return $this->httpOnly;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether this cookie is about to be cleared.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isCleared()
|
||||
public function isCleared(): bool
|
||||
{
|
||||
return 0 !== $this->expire && $this->expire < time();
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the cookie value should be sent with no url encoding.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isRaw()
|
||||
public function isRaw(): bool
|
||||
{
|
||||
return $this->raw;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the SameSite attribute.
|
||||
*
|
||||
* @return string|null
|
||||
* @return self::SAMESITE_*|null
|
||||
*/
|
||||
public function getSameSite()
|
||||
public function getSameSite(): ?string
|
||||
{
|
||||
return $this->sameSite;
|
||||
}
|
||||
|
Reference in New Issue
Block a user