Класс Cookie

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

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

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

Объекты 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 для работы со списками cookie.
См.: Cake\Http\Response::getCookieCollection() для работы с cookie ответа.
Расположение: 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
Имя Cookie
$path protected

string
Путь
$secure protected

boolean
Защищённый
$value protected

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

Резюме методов

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

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

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

__construct()source 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: Имя Cookie
строка|массив $value необязательно '': Значение Cookie
DateTime|DateTimeImmutable|null $expiresAt необязательно null: Время и дата истечения срока действия
строка $path необязательно '': Путь
строка $domain необязательно '': Домен
логическое значение $secure необязательно false: Защищён ли
логическое значение $httpOnly необязательно false: Только для HTTP

Ссылка

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

_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 )

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

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

Параметры

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

Возвращает

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

getDomain()source public

getDomain( )

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

Возвращает

строка

Реализация

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

getExpiresTimestamp()source public

getExpiresTimestamp( )

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

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

Возвращает

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

getValue()source public

getValue( )

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

Возвращает

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

Реализация

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

isExpanded()source public

isExpanded( )

Проверка расширения значения куки.

Возвращает

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

isExpired()source public

isExpired( DateTime|DateTimeImmutable $time null )

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

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

Параметры

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

Возвращает

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

Реализация

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

isHttpOnly()source public

isHttpOnly( )

Проверка атрибута HTTP only для куки.

Возвращает

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

Реализация

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

isSecure()source public

isSecure( )

Проверка атрибута secure для куки.

Возвращает

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

Реализация

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

withDomain()source public

withDomain( string $domain )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

END_OF_DOCUMENT_MARKER

withExpired()source public

withExpired( )

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

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

withExpiry()source public

withExpiry( DateTime|DateTimeImmutable $dateTime )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

withHttpOnly()source public

withHttpOnly( boolean $httpOnly )

Создать куки с обновленным HTTP Only

Параметры

boolean $httpOnly: HTTP Only

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

withName()source public

withName( string $name )

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

Параметры

string $name: Имя куки

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

withNeverExpire()source public

withNeverExpire( )

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

withPath()source public

withPath( string $path )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

withSecure()source public

withSecure( boolean $secure )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

withValue()source public

withValue( string|array $value )

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

Параметры

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

Возвращает

Cake\Http\Cookie\Cookie

Реализация

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

withoutAddedValue()source public

withoutAddedValue( string $path )

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

Параметры

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

Имя куки

''

$pathsource

protected string

Путь

''

$securesource

protected boolean

Защищенный

false

$valuesource

protected string|array

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

''

© 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.Cookie.html