Интерфейс 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( )

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

Возвращает

string

getId()source public

getId( )

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

Cookie уникальны по имени, домену и пути.

Возвращает

string

getName()source public

getName( )

Получить имя cookie

Возвращает

string

getPath()source public

getPath( )

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

Возвращает

string

getStringValue()source public

getStringValue( )

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

Это схлопнет любые сложные данные в cookie с помощью json_encode()

Возвращает

string

getValue()source public

getValue( )

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

Возвращает

string|array

isExpired()source public

isExpired( DateTime|DateTimeImmutable $time null )

Проверить, истек ли срок действия cookie по сравнению со временем $time

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

Параметры

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

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

Возвращает

boolean

isHttpOnly()source public

isHttpOnly( )

Проверить, является ли cookie только для HTTP

Возвращает

boolean

isSecure()source public

isSecure( )

Проверить, является ли cookie защищенным

Возвращает

boolean

toHeaderValue()source public

toHeaderValue( )

Возвращает cookie в качестве значения заголовка

Возвращает

string

withDomain()source public

withDomain( string $domain )

Создать cookie с обновленным доменным именем

Параметры

string $domain

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

Возвращает

Cake\Http\Cookie\CookieInterface

withExpired()source public

withExpired( )

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

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

Возвращает

Cake\Http\Cookie\CookieInterface

withExpiry()source public

withExpiry( DateTime|DateTimeImmutable $dateTime )

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

Параметры

DateTime|DateTimeImmutable $dateTime

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

Возвращает

Cake\Http\Cookie\CookieInterface

withHttpOnly()source public

withHttpOnly( boolean $httpOnly )

Создать cookie с обновлённым HTTP Only

Параметры

boolean $httpOnly

HTTP Only

Возвращает

Cake\Http\Cookie\CookieInterface

withName()source public

withName( string $name )

Устанавливает имя cookie

Параметры

string $name

Имя cookie

Возвращает

Cake\Http\Cookie\CookieInterface

withNeverExpire()source public

withNeverExpire( )

Создать новый cookie, который практически никогда не истечёт.

Возвращает

Cake\Http\Cookie\CookieInterface

withPath()source public

withPath( string $path )

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

Параметры

string $path

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

Возвращает

Cake\Http\Cookie\CookieInterface

withSecure()source public

withSecure( boolean $secure )

Создать cookie с обновлённым Secure

Параметры

boolean $secure

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

Возвращает

Cake\Http\Cookie\CookieInterface

withValue()source public

withValue( string|array $value )

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

Параметры

string|array $value

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

Возвращает

Cake\Http\Cookie\CookieInterface