Final Class Yiisoft\Cookies\Cookie

                public function __construct(
    string $name,
    string $value = '',
    ?DateTimeInterface $expires = null,
    ?string $domain = null,
    ?string $path = '/',
    ?bool $secure = true,
    ?bool $httpOnly = true,
    ?string $sameSite = self::SAME_SITE_LAX,
    bool $encodeValue = true,
    ?ClockInterface $clock = null
) {
    if (!preg_match(self::PATTERN_TOKEN, $name)) {
        throw new InvalidArgumentException("The cookie name \"$name\" contains invalid characters or is empty.");
    }
    $this->name = $name;
    $this->value = $value;
    $this->encodeValue = $encodeValue;
    $this->expires = $expires !== null ? clone $expires : null;
    $this->domain = $domain;
    $this->setPath($path);
    $this->secure = $secure;
    $this->httpOnly = $httpOnly;
    $this->setSameSite($sameSite);
    $this->clock = $clock;
}

            

                public function __toString(): string
{
    $cookieParts = [
        $this->name . '=' . ($this->encodeValue ? urlencode($this->value) : $this->value),
    ];
    if ($this->expires !== null) {
        $cookieParts[] = 'Expires=' . $this->expires->format(DateTimeInterface::RFC1123);
        $cookieParts[] = 'Max-Age=' . ($this->expires->getTimestamp() - $this->getCurrentTimestamp());
    }
    if ($this->domain !== null) {
        $cookieParts[] = 'Domain=' . $this->domain;
    }
    if ($this->path !== null) {
        $cookieParts[] = 'Path=' . $this->path;
    }
    if ($this->secure) {
        $cookieParts[] = 'Secure';
    }
    if ($this->httpOnly) {
        $cookieParts[] = 'HttpOnly';
    }
    if ($this->sameSite !== null) {
        $cookieParts[] = 'SameSite=' . $this->sameSite;
    }
    return implode('; ', $cookieParts);
}

            

                public function addToResponse(ResponseInterface $response): ResponseInterface
{
    return $response->withAddedHeader(Header::SET_COOKIE, (string) $this);
}

            

                public function expire(): self
{
    $new = clone $this;
    $new->expires = $this->getCurrentTime()->modify('-1 year');
    return $new;
}

            

                public function expireWhenBrowserIsClosed(): self
{
    $new = clone $this;
    $new->expires = null;
    return $new;
}

            

                public static function fromCookieString(string $string, ?ClockInterface $clock = null): self
{
    /** @psalm-var list<string> $rawAttributes */
    $rawAttributes = preg_split('~\s*[;]\s*~', $string);
    // array_filter with empty callback is used to filter out all falsy values.
    $rawAttributes = array_filter($rawAttributes);
    $rawAttribute = array_shift($rawAttributes);
    if (!is_string($rawAttribute)) {
        throw new InvalidArgumentException('Cookie string must have at least name.');
    }
    [$cookieName, $cookieValue] = self::splitCookieAttribute($rawAttribute);
    /** @var array{name: string, value: string} $params */
    $params = [
        'name' => $cookieName,
        'value' => $cookieValue !== null ? urldecode($cookieValue) : '',
    ];
    while ($rawAttribute = array_shift($rawAttributes)) {
        /** @var string $attributeKey */
        [$attributeKey, $attributeValue] = self::splitCookieAttribute($rawAttribute);
        $attributeKey = strtolower($attributeKey);
        if ($attributeValue === null && !in_array($attributeKey, ['secure', 'httponly'], true)) {
            continue;
        }
        $currentTimestamp = $clock === null ? time() : $clock->now()->getTimestamp();
        /** @var string $attributeValue */
        switch ($attributeKey) {
            case 'expires':
                $params['expires'] = new DateTimeImmutable($attributeValue);
                break;
            case 'max-age':
                $params['expires'] = (new DateTimeImmutable())
                    ->setTimestamp($currentTimestamp + (int) $attributeValue);
                break;
            case 'domain':
                $params['domain'] = $attributeValue;
                break;
            case 'path':
                $params['path'] = $attributeValue;
                break;
            case 'secure':
                $params['secure'] = true;
                break;
            case 'httponly':
                $params['httpOnly'] = true;
                break;
            case 'samesite':
                $params['sameSite'] = $attributeValue;
                break;
        }
    }
    return new self(
        $params['name'],
        $params['value'],
        $params['expires'] ?? null,
        $params['domain'] ?? null,
        $params['path'] ?? null,
        $params['secure'] ?? null,
        $params['httpOnly'] ?? null,
        $params['sameSite'] ?? null,
        true,
        $clock
    );
}

            

                public function getDomain(): ?string
{
    return $this->domain;
}

            

                public function getExpires(): ?DateTimeImmutable
{
    if ($this->expires === null) {
        return null;
    }
    // Can be replaced with DateTimeImmutable::createFromInterface in PHP 8.
    return (new DateTimeImmutable())->setTimestamp($this->expires->getTimestamp());
}

            

                public function getName(): string
{
    return $this->name;
}

            

                public function getPath(): ?string
{
    return $this->path;
}

            

                public function getSameSite(): ?string
{
    return $this->sameSite;
}

            

                public function getValue(): string
{
    return $this->value;
}

            

                public function isExpired(): bool
{
    return $this->expires !== null && $this->expires->getTimestamp() < $this->getCurrentTimestamp();
}

            

                public function isHttpOnly(): bool
{
    return $this->httpOnly ?? false;
}

            

                public function isSecure(): bool
{
    return $this->secure ?? false;
}

            

                public function withDomain(string $domain): self
{
    $new = clone $this;
    $new->domain = $domain;
    return $new;
}

            

                public function withExpires(DateTimeInterface $dateTime): self
{
    $new = clone $this;
    // Defensively clone the object to prevent further change
    $new->expires = clone $dateTime;
    return $new;
}

            

                public function withHttpOnly(bool $httpOnly = true): self
{
    $new = clone $this;
    $new->httpOnly = $httpOnly;
    return $new;
}

            

                public function withMaxAge(DateInterval $interval): self
{
    $new = clone $this;
    $new->expires = $this->getCurrentTime()->add($interval);
    return $new;
}

            

                public function withPath(string $path): self
{
    $new = clone $this;
    $new->setPath($path);
    return $new;
}

            

                public function withRawValue(string $value): self
{
    $new = clone $this;
    $new->value = $value;
    $new->encodeValue = false;
    return $new;
}

            

                public function withSameSite(string $sameSite): self
{
    $new = clone $this;
    $new->setSameSite($sameSite);
    return $new;
}

            

                public function withSecure(bool $secure = true): self
{
    $new = clone $this;
    $new->secure = $secure;
    return $new;
}

            

                public function withValue(string $value): self
{
    $new = clone $this;
    $new->value = $value;
    $new->encodeValue = true;
    return $new;
}