Добавить cookie HttpResponse::addCookie
Модуль: main — подключать отдельно не нужно
Метод HttpResponse::addCookie добавляет cookie в ответ и возвращает тот же объект. Метод writeHeaders отправляет cookie клиенту.
Аналог в классическом API — метод $APPLICATION->set_cookie.
Сигнатура метода в классе Bitrix\Main\HttpResponse:
public function addCookie(Web\Cookie $cookie, $replace = true, $checkExpires = true)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| cookie* | Bitrix\Main\Web\Cookie |
Задает объект cookie, который метод добавит в ответ |
| replace | bool |
Задает, заменять ли cookie с тем же именем, доменом и путем. Если передать false, метод оставляет прежнюю cookie. По умолчанию — true |
| checkExpires | bool |
Задает, проверять ли согласие пользователя на постоянные cookie. По умолчанию — true |
Типы replace и checkExpires в таблице описывают назначение аргументов. Сигнатура PHP объявляет только тип cookie.
Возвращаемое значение
Метод возвращает текущий объект.
Метод хранит cookie по ключу из имени, домена и пути. Две cookie с одним именем и разными путями — разные cookie.
Особенности
- Если в главном модуле включен параметр
ask_to_store_cookiesи пользователь не разрешил постоянные cookie, метод превращает постоянную cookie в сессионную и задает срок действия0. Метод меняет переданный объект. Согласие пользователя запоминает метод allowPersistentCookies. - Конструктор
Cookieпо умолчанию добавляет к имени значение параметраcookie_nameглавного модуля и знак_. По умолчанию параметр равенBITRIX_SM.
Примеры
Пример. Код добавляет cookie на 30 дней и выводит имя, под которым ее отправит ответ:
<?php
use Bitrix\Main\HttpResponse;
use Bitrix\Main\Web\Cookie;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$response = new HttpResponse();
$response->addCookie(new Cookie('UNIT', 'kg', time() + 86400 * 30));
foreach ($response->getCookies() as $cookie)
{
echo $cookie->getName() . '=' . $cookie->getValue();
}
При параметре cookie_name, равном BITRIX_SM, код выведет BITRIX_SM_UNIT=kg.
Пример. Код добавляет cookie в ответ текущего запроса:
<?php
use Bitrix\Main\Context;
use Bitrix\Main\Web\Cookie;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$cookie = new Cookie('VIEW_MODE', 'list');
$cookie->setHttpOnly(true);
Context::getCurrent()->getResponse()->addCookie($cookie);
echo count(Context::getCurrent()->getResponse()->getCookies());
Ответ текущего запроса вместе с cookie отправляет метод Application::end. Его вызывает эпилог страницы, поэтому в скрипте без эпилога вызовите Application::getInstance()->end(). Код выведет число cookie в ответе, например 1.