Помощник по файлам Cookie

Файл Cookie Helper содержит функции, которые помогают работать с файлами cookie.

• Загрузка этого помощника
• Доступные функции

Загрузка этого помощника

Этот помощник загружается с помощью следующего кода:

helper('cookie');

Доступные функции

Доступны следующие функции:

set_cookie($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = false[, $httpOnly = false[, $sameSite = '']]]]]]]])

Параметры:

$name (mixed) – Имя файла cookie или ассоциативный массив всех параметров, доступных для этой функции $value (string) – Значение файла cookie $expire (int) – Количество секунд до истечения срока действия $domain (string) – Домен файла cookie (обычно: .yourdomain.com) $path (string) – Путь файла cookie $prefix (string) – Префикс имени файла cookie $secure (bool) – Следует ли отправлять файл cookie только через HTTPS $httpOnly (bool) – Следует ли скрыть файл cookie от JavaScript $sameSite (string) – Значение параметра SameSite для файла cookie. Если null, используется значение по умолчанию из config/App.php

Тип возвращаемого значения:

void

Эта вспомогательная функция предоставляет более удобный синтаксис для установки файлов cookie браузера. Обратитесь к Библиотеке отклика для описания ее использования, поскольку эта функция является псевдонимом для Response::setCookie().

get_cookie($index[, $xssClean = false])

Параметры:	$index (string) – Имя файла cookie $xss_clean (bool) – Следует ли применять фильтрацию XSS к возвращаемому значению
Возвращаемое значение:	Значение файла cookie или null, если он не найден
Тип возвращаемого значения:	mixed

Эта вспомогательная функция предоставляет более удобный синтаксис для получения файлов cookie браузера. Обратитесь к Библиотеке входящих запросов для подробного описания ее использования, поскольку эта функция работает очень похоже на IncomingRequest::getCookie(), за исключением того, что она также добавит префикс $cookiePrefix, который вы, возможно, установили в файле app/Config/App.php.

delete_cookie($name[, $domain = ''[, $path = '/'[, $prefix = '']]])

Параметры:	$name (string) – Имя файла cookie $domain (string) – Домен файла cookie (обычно: .yourdomain.com) $path (string) – Путь файла cookie $prefix (string) – Префикс имени файла cookie
Тип возвращаемого значения:	void

Позволяет удалить файл cookie. Если вы не установили пользовательский путь или другие значения, достаточно только имени файла cookie.

delete_cookie('name');

В остальном эта функция идентична set_cookie(), за исключением того, что у нее нет параметров значения и срока действия. Вы можете передать массив значений в первом параметре или установить отдельные параметры.

delete_cookie($name, $domain, $path, $prefix);

has_cookie(string $name[, ?string $value = null[, string $prefix = '']])

Параметры:	$name (string) – Имя файла cookie $value (string|null) – Значение файла cookie $prefix (string) – Префикс файла cookie
Тип возвращаемого значения:	bool

Проверяет наличие файла cookie по имени. Это псевдоним для Response::hasCookie().