Интерфейс CookieInterface
Интерфейс Cookie
Прямые реализаторы
Краткое описание констант
-
string'D, d-M-Y H:i:s T'
Краткое описание методов
- getDomain() publicПолучить атрибут домена.
- getExpiresTimestamp() publicПолучить отметку времени окончания срока действия
- getExpiry() publicПолучить текущее время истечения срока действия
- getFormattedExpires() publicСоздаёт значение срока действия для строки заголовка
- getId() publicПолучить идентификатор куки
- getName() publicПолучить имя куки
- getPath() publicПолучить атрибут пути.
- getValue() publicПолучить значение куки
- isExpired() publicПроверить, истекло ли время действия куки по сравнению с $time
- isHttpOnly() publicПроверить, является ли кука HTTP-только
- isSecure() publicПроверить, является ли кука защищённой
- toHeaderValue() publicВозвращает значение куки в формате заголовка
- withDomain() publicСоздаёт куки с обновлённым доменом
- withExpired() publicСоздаёт новую куки, которая истечёт/будет удалена из браузера.
- withExpiry() publicСоздаёт куки с обновлённой датой истечения срока действия
- withHttpOnly() publicСоздаёт куки с обновлённым атрибутом HTTP-только
- withName() publicУстанавливает имя куки
- withNeverExpire() publicСоздаёт новую куки, которая фактически никогда не истечёт.
- withPath() publicСоздаёт новую куки с обновлённым путём
- withSecure() publicСоздаёт куки с обновлённым атрибутом защищённости
- withValue() publicСоздаёт куки с обновлённым значением.
Подробное описание методов
getExpiresTimestamp()source public
getExpiresTimestamp( )
Получить отметку времени окончания срока действия
Отметки времени являются строками, так как большие отметки времени могут переполнить MAX_INT в 32-битных системах.
Возвращает
строка|nullВремя истечения срока действия в виде строковой отметки времени.
getExpiry()source public
getExpiry( )
Получить текущее время истечения срока действия
Возвращает
DateTime|DateTimeImmutable|nullОтметка времени истечения срока действия или null
getFormattedExpires()source public
getFormattedExpires( )
Создаёт значение срока действия для строки заголовка
Возвращает
строкаgetId()source public
getId( )
Получить идентификатор куки
Куки уникальны в кортежах имя, домен, путь.
Возвращает
строкаisExpired()source public
isExpired( DateTime|DateTimeImmutable $time null )
Проверить, истекло ли время действия куки по сравнению с $time
Куки без даты истечения срока действия всегда возвращают false.
Параметры
- DateTime|DateTimeImmutable
$timeопционально null - Время для проверки. По умолчанию - текущее время в UTC.
Возвращает
логическое значениеisHttpOnly()source public
isHttpOnly( )
Проверить, является ли кука HTTP-только
Возвращает
логическое значениеisSecure()source public
isSecure( )
Проверить, является ли кука защищённой
Возвращает
логическое значениеtoHeaderValue()source public
toHeaderValue( )
Возвращает значение куки в формате заголовка
Возвращает
строкаwithDomain()source public
withDomain( string $domain )
Создаёт куки с обновлённым доменом
Параметры
- строка
$domain - Домен для установки
Возвращает
Cake\Http\Cookie\CookieInterfacewithExpired()source public
withExpired( )
Создаёт новую куки, которая истечёт/будет удалена из браузера.
Это делается путём установки времени истечения на 1 год назад
Возвращает
Cake\Http\Cookie\CookieInterfacewithExpiry()source public
withExpiry( DateTime|DateTimeImmutable $dateTime )
Создаёт куки с обновлённой датой истечения срока действия
Параметры
- DateTime|DateTimeImmutable
$dateTime - Объект даты и времени
Возвращает
Cake\Http\Cookie\CookieInterfacewithHttpOnly()source public
withHttpOnly( boolean $httpOnly )
Создать cookie с обновленным HTTP Only
Параметры
- boolean
$httpOnly - HTTP Only
Возвращает
Cake\Http\Cookie\CookieInterfacewithName()source public
withName( string $name )
Устанавливает имя cookie
Параметры
- string
$name - Имя cookie
Возвращает
Cake\Http\Cookie\CookieInterfacewithNeverExpire()source public
withNeverExpire( )
Создать новый cookie, который практически никогда не истечёт.
Возвращает
Cake\Http\Cookie\CookieInterfacewithPath()source public
withPath( string $path )
Создать новый cookie с обновлённым путем
Параметры
- string
$path - Устанавливает путь
Возвращает
Cake\Http\Cookie\CookieInterfacewithSecure()source public
withSecure( boolean $secure )
Создать cookie с обновленным Secure
Параметры
- boolean
$secure - Значение атрибута Secure
Возвращает
Cake\Http\Cookie\CookieInterfacewithValue()source public
withValue( string|array $value )
Создать cookie с обновленным значением.
Параметры
- string|array
$value - Значение cookie для установки
Возвращает
Cake\Http\Cookie\CookieInterface
© 2005–2017 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/3.4/class-Cake.Http.Cookie.CookieInterface.html