Класс Cookie

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

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

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

Объекты Cookie неизменяемы, и вам необходимо повторно присвоить переменные при модификации объектов 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
Метод-сеттер для атрибута value.
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(). Сохраняет обратную совместимость со _flatten() CookieComponent 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 )

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

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

Параметры

строка $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( )

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

Возвращает

строка

Реализация

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

getName()source public

getName( )

Получение имени куки.

Возвращает

строка

Реализация

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

getPath()source public

getPath( )

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

Возвращает

строка

Реализация

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

getStringValue()source public

getStringValue( )

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

Возвращает

строка

Реализация

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

getValue()source public

getValue( )

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

Возвращает

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

Реализация

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

isExpanded()source public

isExpanded( )

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

Возвращает

логическое

isExpired()source public

isExpired( DateTime|DateTimeImmutable $time = null )

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

Параметры

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

Возвращает

логическое

Реализация

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

isHttpOnly()source public

isHttpOnly( )

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

Возвращает

логическое

Реализация

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

isSecure()source public

isSecure( )

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

Возвращает

логическое

Реализация

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

read()source public

read( string $path = null )

Чтение данных из куки.

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

Параметры

строка $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 )

Проверка имени куки.

Параметры

строка $name: Имя куки.

Исключения

InvalidArgumentException

Ссылка

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

validateString()source protected

validateString( string $value )

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

Параметры

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

Исключения

InvalidArgumentException

withAddedValue()source public

withAddedValue( string $path , mixed $value )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

END_OF_DOCUMENT_MARKER

withDomain()source public

withDomain( string $domain )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

withExpired()source public

withExpired( )

Создать новый cookie, который истечёт/удалит 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

Параметры

строка $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 с обновлённым путём

Параметры

строка $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 с обновлённым значением.

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

withoutAddedValue()source public

withoutAddedValue( string $path )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

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

$domainsource

protected строка

Домен

''

$expiresAtsource

protected DateTime|DateTimeImmutable|null

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

$httpOnlysource

protected boolean

Только HTTP

false

$isExpandedsource

protected boolean

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

false

$namesource

protected строка

Имя cookie

''

$pathsource

protected строка

Путь

'/'

$securesource

protected boolean

Secure

false

$valuesource

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

Исходное значение 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.7/class-Cake.Http.Cookie.Cookie.html