Интерфейс CookieInterface

Интерфейс Cookie

Пространство имён: Cake\Http\Cookie

Константы

string

EXPIRES_FORMAT
```
'D, d-M-Y H:i:s T'
```
Формат атрибута срока действия.
string

SAMESITE_LAX
```
'Lax'
```
Значение атрибута SameSite: Lax
string

SAMESITE_NONE
```
'None'
```
Значение атрибута SameSite: None
string

SAMESITE_STRICT
```
'Strict'
```
Значение атрибута SameSite: Strict
array<string>

SAMESITE_VALUES
```
[self::SAMESITE_LAX, self::SAMESITE_STRICT, self::SAMESITE_NONE]
```
Допустимые значения для атрибута "SameSite".

Краткое описание методов

getDomain() public

Получить атрибут домена.
getExpiresTimestamp() public

Получить метку времени истечения срока действия.
getExpiry() public

Получить текущее время истечения срока действия.
getFormattedExpires() public

Создаёт значение атрибута срока действия для строки заголовка.
getId() public

Получить идентификатор куки.
getName() public

Получить имя куки.
getOptions() public

Получить параметры куки.
getPath() public

Получить атрибут пути.
getSameSite() public

Получить атрибут SameSite.
getScalarValue() public

Получить значение куки как скаляр.
getValue() public

Получить значение куки.
isExpired() public

Проверить, истекла ли куки по сравнению со временем $time.
isHttpOnly() public

Проверить, является ли куки HTTP-только.
isSecure() public

Проверить, защищена ли куки.
toArray() public

Получить данные куки в виде массива.
toHeaderValue() public

Возвращает куки в виде значения заголовка.
withDomain() public

Создать куки с обновлённым доменом.
withExpired() public

Создать новую куки, которая истечёт/удалит куки из браузера.
withExpiry() public

Создать куки с обновлённой датой истечения срока действия.
withHttpOnly() public

Создать куки с обновлённым HTTP-только.
withName() public

Установить имя куки.
withNeverExpire() public

Создать новую куки, которая практически никогда не истечёт.
withPath() public

Создать новую куки с обновлённым путём.
withSameSite() public

Создать куки с обновлённым параметром SameSite.
withSecure() public

Создать куки с обновлённым Secure.
withValue() public

Создать куки с обновлённым значением.

Подробное описание методов

getDomain() public

getDomain(): string

Получить атрибут домена.

Возвращает

string

getExpiresTimestamp() public

getExpiresTimestamp(): int|null

Получить метку времени истечения срока действия

Возвращает

int|null

getExpiry() public

getExpiry(): DateTimeDateTimeImmutable|null

Получить текущий срок действия

Возвращает

DateTimeDateTimeImmutable|null

getFormattedExpires() public

getFormattedExpires(): string

Создаёт часть значения времени истечения срока действия в строке заголовка.

Возвращает

string

getId() public

getId(): string

Получить идентификатор куки.

Куки уникальны для набора имя, домен, путь.

Возвращает

string

getName() public

getName(): string

Получить имя куки.

Возвращает

string

getOptions() public

getOptions(): array<string, mixed>

Получить опции куки.

Возвращает

array<string, mixed>

getPath() public

getPath(): string

Получить атрибут пути.

Возвращает

string

getSameSite() public

getSameSite(): string|null

Получить атрибут SameSite.

Возвращает

string|null

getScalarValue() public

getScalarValue(): mixed

Получить значение куки как скаляр.

Это скомпилирует любые сложные данные в куки с помощью json_encode()

Возвращает

mixed

getValue() public

getValue(): array|string

Получить значение куки.

Возвращает

array|string

isExpired() public

isExpired(DateTimeDateTimeImmutable $time = null): bool

Проверить, истекла ли куки по сравнению со временем $time.

Куки без даты истечения всегда возвращают false.

Параметры

DateTimeDateTimeImmutable $time необязательно: Время для проверки. По умолчанию - текущее время в UTC.

Возвращает

bool

isHttpOnly() public

isHttpOnly(): bool

Проверить, является ли куки HTTP-only.

Возвращает

bool

isSecure() public

isSecure(): bool

Проверить, является ли куки безопасной.

Возвращает

bool

toArray() public

toArray(): array<string, mixed>

Получить данные куки в виде массива.

Возвращает

array<string, mixed>

toHeaderValue() public

toHeaderValue(): string

Возвращает куки в виде значения заголовка.

Возвращает

string

withDomain() public

withDomain(string $domain): static

Создаёт куки с обновлённым доменом.

Параметры

string $domain: Домен для установки.

Возвращает

static

withExpired() public

withExpired(): static

Создаёт новую куки, которая истечёт/будет удалена из браузера.

Это делается путем установки времени истечения на 1 год назад.

Возвращает

static

withExpiry() public

withExpiry(DateTimeDateTimeImmutable $dateTime): static

Создаёт куки с обновлённой датой истечения.

Параметры

DateTimeDateTimeImmutable $dateTime: Объект даты и времени.

Возвращает

static

withHttpOnly() public

withHttpOnly(bool $httpOnly): static

Создаёт куки с обновлённым HTTP Only.

Параметры

bool $httpOnly: HTTP Only.

Возвращает

static

withName() public

withName(string $name): static

Устанавливает имя куки.

Параметры

string $name: Имя куки.

Возвращает

static

withNeverExpire() public

withNeverExpire(): static

Создаёт новую куки, которая фактически никогда не истечёт.

Возвращает

static

withPath() public

withPath(string $path): static

Создаёт новую куки с обновлённым путём.

Параметры

string $path: Устанавливает путь.

Возвращает

static

withSameSite() public

withSameSite(string|null $sameSite): static

Создаёт куки с обновлённым параметром SameSite.

Параметры

string|null $sameSite: Значение для установки параметра Samesite. Одно из констант CookieInterface::SAMESITE_*.

Возвращает

static

withSecure() public

withSecure(bool $secure): static

Создаёт куки с обновлённым Secure.

Параметры

bool $secure: Значение атрибута Secure.

Возвращает

static

withValue() public

withValue(array|string $value): static

Создаёт куки с обновлённым значением.

Параметры

array|string $value: Значение куки для установки.

Возвращает

static

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/interface-Cake.Http.Cookie.CookieInterface.html