method public

Component::addCookie()

Класс: \Bitrix\Main\Engine\Response\Render\Component

Сигнатура

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

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

Component::addCookie() — метод класса \Bitrix\Main\Engine\Response\Render\Component модуля «Главный модуль». Component: Ответ с компонентом на шаблоне сайта.

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

use Bitrix\Main\Engine\Response\Render\Component;

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

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

addHeader() Добавляет поле HTTP-заголовка в ответ.
allowPersistentCookies() Запоминает выбор пользователя о хранении постоянных cookie.
appendContent() Добавляет контент.
clear()
copyHeadersTo()
flush() Сбрасывает контент в буфер вывода. Весь последующий вывод будет проигнорирован.
getContent() Возвращает контент ответа.
getCookies()
getHeaders()
getStatus() Возвращает HTTP-статус ответа.
redirectTo()
send() Отправляет контент в вывод.

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

Исходный файл: source/main/lib/engine/response/render/component.php:105