Интерфейс CookieInterface

Интерфейс Cookie

Прямые реализаторы

Cake\Http\Cookie\Cookie

Пространство имен: Cake\Http\Cookie
Расположение: Http/Cookie/CookieInterface.php

Краткое описание констант

string

EXPIRES_FORMAT

'D, d-M-Y H:i:s T'

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

getDomain() public
Получить атрибут домена.
getExpiresTimestamp() public
Получить метку времени из срока действия.
getExpiry() public
Получить текущее время истечения срока действия.
getFormattedExpires() public
Строит часть значения времени истечения срока действия в строке заголовка.
getId() public
Получить идентификатор куки.
getName() public
Получить имя куки.
getPath() public
Получить атрибут пути.
getStringValue() public
Получить значение куки в виде строки.
getValue() public
Получить значение куки.
isExpired() public
Проверить, истекла ли куки по сравнению со временем $time.
isHttpOnly() public
Проверить, является ли куки HTTP-только.
isSecure() public
Проверить, является ли куки защищенной.
toHeaderValue() public
Возвращает куки в виде значения заголовка.
withDomain() public
Создать куки с обновленным доменом.
withExpired() public
Создать новую куки, которая истечёт/удалится из браузера.
withExpiry() public
Создать куки с обновленной датой истечения срока действия.
withHttpOnly() public
Создать куки с обновленным атрибутом HTTP Only.
withName() public
Установить имя куки.
withNeverExpire() public
Создать новую куки, которая практически никогда не истечет.
withPath() public
Создать новую куки с обновленным путем.
withSecure() public
Создать куки с обновленным атрибутом Secure.
withValue() public
Создать куки с обновленным значением.

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

getDomain()source public

getDomain( )

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

Возвращает

строка

getExpiresTimestamp()source public

getExpiresTimestamp( )

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

Метки времени являются строками, так как большие метки времени могут переполнить MAX_INT в 32-битных системах.

Возвращает

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

END_OF_DOCUMENT_MARKER

getExpiry()source public

getExpiry( )

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

Возвращает

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

getFormattedExpires()source public

getFormattedExpires( )

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

Возвращает

string

getId()source public

getId( )

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

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

Возвращает

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

Cookies без даты истечения срока действия всегда возвращают 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

END_OF_DOCUMENT_MARKER

withExpired()source public

withExpired( )

Создать новый 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

© 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/3.6/class-Cake.Http.Cookie.CookieInterface.html