GridComponent::includeComponent() — параметры и описание

Сигнатура

public final includeComponent(string $componentTemplate, array<string|int, mixed> $arParams, CBitrixComponent|null $parentComponent[, mixed $returnResult = false ]) : mixed

Описание

Примечание: компонент должен быть инициализирован методом initComponent.

Параметры

$componentTemplate string

$arParams array<string|int, mixed>

$parentComponent CBitrixComponent|null

$returnResult mixed = false

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

mixed

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

GridComponent::includeComponent() — метод класса \Bitrix\Main\Grid\Component\GridComponent модуля «Главный модуль».

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

use Bitrix\Main\Grid\Component\GridComponent;

/** @var GridComponent $object */
$componentTemplate = '';
$arParams = [];
$parentComponent = null; // CBitrixComponent|null
$result = $object->includeComponent($componentTemplate, $arParams, $parentComponent);
// $result: mixed

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

__prepareComponentParams() Вспомогательная функция для безопасного html-экранирования параметров компонента.
__showError() Функция показывает сообщение о внутренней ошибке.
abortResultCache() Функция прерывает кеш после его старта.
addChildCSS() Функция регистрирует дочерний css-файл для кеширования.
addChildEpilog() Функция регистрирует дочерний файл эпилога для кеширования.
addChildFrame() Регистрирует дочерний фрейм для кеширования.
addChildJS() Функция регистрирует дочерний js-файл для кеширования.
addDeleteAction() Функция добавляет действие удаления в некоторую область внутри компонента.
addEditAction() Функция добавляет действие редактирования в некоторую область внутри компонента.
addEditButton() Функция добавляет кнопку для отображения.
addIncludeAreaIcon() Функция добавляет иконку в область компонента в режиме редактирования.
addIncludeAreaIcons() Функция заменяет иконки, отображаемые для компонента, коллекцией.

includeComponent() есть и у других классов модуля «Главный модуль»: EventMessageThemeCompiler, TabletGridComponent.