HtmlContent::addCookie() — параметры и описание

Сигнатура

public addCookie(Cookie $cookie[, bool $replace = true ][, bool $checkExpires = true ]) : $this

Описание

Добавляет cookie в ответ.

Параметры

$cookie Cookie

Cookie.

$replace bool = true

Заменять существующий cookie или нет.

$checkExpires bool = true

Проверять значение expires у cookie или нет.

Возвращаемое значение

$this

Как применяется в HtmlContent

HtmlContent::addCookie() — метод класса \Bitrix\Main\Engine\Response\HtmlContent модуля «Главный модуль». HtmlContent: Тип ответа для рендеринга ajax-html-контента из действия.

Метод объекта: сначала нужен экземпляр HtmlContent.

use Bitrix\Main\Engine\Response\HtmlContent;

/** @var HtmlContent $object */
$cookie = null; // Cookie
$result = $object->addCookie($cookie);
// $result: $this

Другие методы HtmlContent

addHeader() Добавляет поле HTTP-заголовка в ответ.
allowPersistentCookies() Запоминает выбор пользователя о хранении постоянных cookie.
appendContent() Добавляет контент.
clear()
copyHeadersTo()
createDenied()
createError()
createSuccess()
flush() Сбрасывает контент в буфер вывода. Весь последующий вывод будет проигнорирован.
getContent() Возвращает контент ответа.
getCookies()
getErrorByCode() Получение единственной ошибки с необходимым кодом.

addCookie() есть и у других классов модуля «Главный модуль»: AjaxJson, Archive, Base, BFile, Component, Component, Extension, File.