Интерфейс CookieInterface

getDomain()source public

getDomain( )

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

Возвращает

строка

getExpiresTimestamp()source public

getExpiresTimestamp( )

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

Временные метки — это строки, так как большие временные метки могут переполнять MAX_INT в 32-разрядных системах.

Возвращает

строка|null
Временная метка истечения срока действия в виде строки.

getExpiry()source public

getExpiry( )

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

Возвращает

DateTime|DateTimeImmutable|null
Временная метка истечения срока действия или null

getFormattedExpires()source public

getFormattedExpires( )

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

Возвращает

строка

getId()source public

getId( )

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

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

Возвращает

строка

getName()source public

getName( )

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

Возвращает

строка

getPath()source public

getPath( )

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

Возвращает

строка

getStringValue()source public

getStringValue( )

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

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

Возвращает

строка

getValue()source public

getValue( )

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

Возвращает

строка|массив

isExpired()source public

isExpired( DateTime|DateTimeImmutable $time = null )

Проверить, истекла ли куки по сравнению с заданным временем.

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

Параметры

DateTime|DateTimeImmutable $time необязательно null

Время для проверки. По умолчанию — текущее время в UTC.

Возвращает

логическое значение

isHttpOnly()source public

isHttpOnly( )

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

Возвращает

логическое значение

isSecure()source public

isSecure( )

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

Возвращает

логическое значение

toHeaderValue()source public

toHeaderValue( )

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

Возвращает

строка

withDomain()source public

withDomain( string $domain )

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

Параметры

строка $domain

Устанавливаемый домен

Возвращает

Cake\Http\Cookie\CookieInterface

withExpired()source public

withExpired( )

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

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

Возвращает

Cake\Http\Cookie\CookieInterface

withExpiry()source public

withExpiry( DateTime|DateTimeImmutable $dateTime )

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

Параметры

DateTime|DateTimeImmutable $dateTime

Объект даты и времени

Возвращаемое значение

Cake\Http\Cookie\CookieInterface

withHttpOnly()source public

withHttpOnly( boolean $httpOnly )

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

Параметры

boolean $httpOnly

HTTP Only

Возвращаемое значение

Cake\Http\Cookie\CookieInterface

withName()source public

withName( string $name )

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

Параметры

string $name

Имя куки

Возвращаемое значение

Cake\Http\Cookie\CookieInterface

withNeverExpire()source public

withNeverExpire( )

Создаёт куки, который фактически никогда не истекает.

Возвращаемое значение

Cake\Http\Cookie\CookieInterface

withPath()source public

withPath( string $path )

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

Параметры

string $path

Устанавливает путь

Возвращаемое значение

Cake\Http\Cookie\CookieInterface

withSecure()source public

withSecure( boolean $secure )

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

Параметры

boolean $secure

Значение атрибута Secure

Возвращаемое значение

Cake\Http\Cookie\CookieInterface

withValue()source public

withValue( string|array $value )

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

Параметры

string|array $value

Значение куки для установки

Возвращаемое значение

Cake\Http\Cookie\CookieInterface