Класс Cookie

Объект Cookie для создания куки и преобразования его в значение заголовка

HTTP-куки (также называемые веб-куки, куки Интернета, куки браузера или просто куки) — небольшой фрагмент данных, отправляемый веб-сайтом и сохраняемый на компьютере пользователя веб-браузером во время просмотра сайта.

Куки были разработаны как надёжный механизм для веб-сайтов, чтобы запоминать состояние (например, добавленные в корзину товары в интернет-магазине) или записывать действия пользователя во время просмотра (включая нажатия на определённые кнопки, вход в систему или запись посещённых страниц). Они также могут использоваться для запоминания произвольной информации, ранее введённой пользователем в поля форм, такие как имена и настройки.

Объекты Cookie неизменяемы, и при изменении объектов куки необходимо повторно назначать переменные:

$cookie = $cookie->withValue('0');

Cake\Http\Cookie\Cookie реализует Cake\Http\Cookie\CookieInterface

Пространство имён: Cake\Http\Cookie
Ссылка: https://tools.ietf.org/html/rfc6265
Ссылка: https://en.wikipedia.org/wiki/HTTP_cookie
См.: Cake\Http\Cookie\CookieCollection для работы с коллекциями куки.
См.: Cake\Http\Response::getCookieCollection() для работы с куки ответа.
Расположение: Http/Cookie/Cookie.php

Унаследованные константы

EXPIRES_FORMAT

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

$domain protected

string
Домен
$expiresAt protected

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

boolean
Только для HTTP
$isExpanded protected

boolean
Расшифровано ли значение JSON в массив.
$name protected

string
Имя куки
$path protected

string
Путь
$secure protected

boolean
Защищён
$value protected

string|array
Необработанное значение куки.

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

__construct() public
Конструктор
_expand() protected

Метод разбиения, возвращающий массив из строки, установленной в CookieComponent::_flatten() Сохраняет обратную совместимость чтения с 1.x CookieComponent::_flatten().
_flatten() protected
Метод конкатенации для сохранения многомерных массивов в качестве ключей
_setValue() protected
Сеттер для атрибута значения.
check() public
Проверяет, существует ли значение в данных куки.
getDomain() public
Получить атрибут домена.
getExpiresTimestamp() public
Получить метку времени из времени истечения срока действия
getExpiry() public
Получить текущее время истечения срока действия
getFormattedExpires() public
Строит часть значения времени истечения срока действия в строке заголовка
getId() public
Получить идентификатор куки
getName() public
Получить имя куки
getPath() public
Получить атрибут пути.
getStringValue() public
Получить значение куки в виде строки.
getValue() public
Получить значение куки
isExpanded() public
Проверить, было ли расширено значение куки
isExpired() public
Проверить, истекло ли время действия куки по сравнению со временем $time
isHttpOnly() public
Проверить, является ли куки только для HTTP
isSecure() public
Проверить, является ли куки защищённым
read() public
Чтение данных из куки
toHeaderValue() public
Возвращает значение заголовка в виде строки
validateBool() protected
Проверка того, является ли аргумент булевым
validateName() protected
Проверка имени куки
validateString() protected
Проверка того, является ли аргумент строкой
withAddedValue() public
Создание новой куки с обновлёнными данными.
withDomain() public
Создание куки с обновлённым доменом
withExpired() public
Создание новой куки, которая истечёт/удалится из браузера.
withExpiry() public
Создание куки с обновлённой датой истечения срока действия
withHttpOnly() public
Создание куки с обновлённым значением HTTP Only
withName() public
Устанавливает имя куки
withNeverExpire() public
Создание новой куки, которая практически никогда не истечёт.
withPath() public
Создание новой куки с обновлённым путём
withSecure() public
Создание куки с обновлённым значением Secure
withValue() public
Создание куки с обновлённым значением.
withoutAddedValue() public
Создание новой куки без определённого пути

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

__construct()исходный код public

__construct( string $name , string|array $value = '' , DateTime|DateTimeImmutable|null $expiresAt = null , string $path = '/' , string $domain = '' , boolean $secure = false , boolean $httpOnly = false )

Конструктор

Аргументы конструктора аналогичны методу setcookie() языка PHP. Единственное различие заключается в третьем аргументе, который принимает null или объект DateTime или DateTimeImmutable вместо целого числа.

Параметры

строка $name: Имя куки
строка|массив $value необязательно '': Значение куки
DateTime|DateTimeImmutable|null $expiresAt необязательно null: Время и дата истечения срока действия
строка $path необязательно '/': Путь
строка $domain необязательно '': Домен
булево $secure необязательно false: Защищён ли доступ
булево $httpOnly необязательно false: Только для HTTP

Ссылка

http://php.net/manual/en/function.setcookie.php

END_OF_DOCUMENT_MARKER

_expand()source protected

_expand( string $string )

Метод разбора, возвращающий массив из строки, установленной в CookieComponent::_flatten(). Сохраняет обратную совместимость с CookieComponent::_flatten() версии 1.x.

Параметры

строка $string: Строка, содержащая данные, закодированные в формате JSON, или обычная строка.

Возвращает

строка|массив
Словарь ключей и значений

_flatten()source protected

_flatten( array $array )

Метод склеивания, сохраняющий многомерные массивы ключей.

Параметры

массив $array: Словарь ключей и значений

Возвращает

строка
Строка, закодированная в формате JSON.

_setValue()source protected

_setValue( mixed $value )

Установщик атрибута значения.

Параметры

смешанное $value: Значение для сохранения.

check()source public

check( string $path )

Проверяет, существует ли значение в данных cookie.

Этот метод будет расширять сериализованные сложные данные при первом использовании.

Параметры

строка $path: Путь для проверки

Возвращает

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

getDomain()source public

getDomain( )

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

Возвращает

строка

Реализация

Cake\Http\Cookie\CookieInterface::getDomain()

getExpiresTimestamp()source public

getExpiresTimestamp( )

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

Возвращает

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

Реализация

Cake\Http\Cookie\CookieInterface::getExpiresTimestamp()

getExpiry()source public

getExpiry( )

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

Возвращает

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

Реализация

Cake\Http\Cookie\CookieInterface::getExpiry()

getFormattedExpires()source public

getFormattedExpires( )

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

Возвращает

строка

Реализация

Cake\Http\Cookie\CookieInterface::getFormattedExpires()

getId()source public

getId( )

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

Возвращает

строка

Реализация

Cake\Http\Cookie\CookieInterface::getId()

getName()source public

getName( )

Получение имени cookie

Возвращает

строка

Реализация

Cake\Http\Cookie\CookieInterface::getName()

getPath()source public

getPath( )

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

Возвращает

строка

Реализация

Cake\Http\Cookie\CookieInterface::getPath()

getStringValue()source public

getStringValue( )

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

Возвращает

строка

Реализация

Cake\Http\Cookie\CookieInterface::getStringValue()

getValue()source public

getValue( )

Получение значения cookie.

Возвращает

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

Реализация

Cake\Http\Cookie\CookieInterface::getValue()

isExpanded()source public

isExpanded( )

Проверка, было ли расширено значение cookie.

Возвращает

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

isExpired()source public

isExpired( DateTime|DateTimeImmutable $time = null )

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

Параметры

DateTime|DateTimeImmutable $time необязательный null: Время для проверки. По умолчанию — текущее время в UTC.

Возвращает

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

Реализация

Cake\Http\Cookie\CookieInterface::isExpired()

isHttpOnly()source public

isHttpOnly( )

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

Возвращает

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

Реализация

Cake\Http\Cookie\CookieInterface::isHttpOnly()

isSecure()source public

isSecure( )

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

Возвращает

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

Реализация

Cake\Http\Cookie\CookieInterface::isSecure()

read()source public

read( string $path = null )

Чтение данных из cookie.

Этот метод будет расширять сериализованные сложные данные при первом использовании.

Параметры

строка $path необязательный null: Путь для чтения данных

Возвращает

смешанное

toHeaderValue()source public

toHeaderValue( )

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

Возвращает

строка

Реализация

Cake\Http\Cookie\CookieInterface::toHeaderValue()

validateBool()source protected

validateBool( boolean $value )

Проверка, является ли аргумент булевым значением

Параметры

логическое значение $value: Значение для проверки.

Исключение

InvalidArgumentException

validateName()source protected

validateName( string $name )

Проверка имени cookie

Параметры

строка $name: Имя cookie

Исключение

InvalidArgumentException

Ссылка

Правила именования cookie.

validateString()source protected

validateString( string $value )

Проверка, является ли аргумент строкой

Параметры

строка $value: Значение для проверки.

Исключение

InvalidArgumentException

withAddedValue()source public

withAddedValue( string $path , mixed $value )

Создание новой cookie с обновленными данными.

Параметры

строка $path: Путь для записи
смешанное $value: Значение для записи

Возвращает

Cake\Http\Cookie\Cookie

withDomain()source public

withDomain( string $domain )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

Cake\Http\Cookie\CookieInterface::withDomain()

END_OF_DOCUMENT_MARKER

withExpired()source public

withExpired( )

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

Cake\Http\Cookie\CookieInterface::withExpired()

withExpiry()source public

withExpiry( DateTime|DateTimeImmutable $dateTime )

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

Параметры

DateTime|DateTimeImmutable $dateTime: Объект времени и даты

Возвращает

Cake\Http\Cookie\Cookie

Реализация

Cake\Http\Cookie\CookieInterface::withExpiry()

withHttpOnly()source public

withHttpOnly( boolean $httpOnly )

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

Параметры

boolean $httpOnly: HTTP Only

Возвращает

Cake\Http\Cookie\Cookie

Реализация

Cake\Http\Cookie\CookieInterface::withHttpOnly()

withName()source public

withName( string $name )

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

Параметры

string $name: Имя cookie

Возвращает

Cake\Http\Cookie\Cookie

Реализация

Cake\Http\Cookie\CookieInterface::withName()

withNeverExpire()source public

withNeverExpire( )

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

Cake\Http\Cookie\CookieInterface::withNeverExpire()

withPath()source public

withPath( string $path )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

Cake\Http\Cookie\CookieInterface::withPath()

withSecure()source public

withSecure( boolean $secure )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

Cake\Http\Cookie\CookieInterface::withSecure()

withValue()source public

withValue( string|array $value )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

Cake\Http\Cookie\CookieInterface::withValue()

withoutAddedValue()source public

withoutAddedValue( string $path )

Создать новый cookie без конкретного пути

Параметры

string $path: Путь для удаления

Возвращает

Cake\Http\Cookie\Cookie

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

$domainsource

protected string

Домен

''

$expiresAtsource

protected DateTime|DateTimeImmutable|null

Время истечения

$httpOnlysource

protected boolean

Только HTTP

false

$isExpandedsource

protected boolean

Расширено ли JSON-значение в массив.

false

$namesource

protected string

Имя cookie

''

$pathsource

protected string

Путь

'/'

$securesource

protected boolean

Secure

false

$valuesource

protected string|array

Исходное значение cookie.

''

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