Документация для разработчиков
Темная тема

Component

\Bitrix\Main\Engine\Response\Component - методы работы с компонентами.

Когда необходимо загрузить компонент на аяксе, то достаточно в действии вернуть \Bitrix\Main\Engine\Response\Component. Сигнатура конструктора совпадает с $APPLICATION->IncludeComponent($name, $template, $parameters)

new \Bitrix\Main\Engine\Response\Component('bitrix:disk.file.view', '', [
    'FILE_ID' => $fileId,            
]);

Формирует ответ для представления компонента:

{
    "status": string,
    "data": {
      "html": string,
        "assets": {
            "css": array,
            "js": array,
            "string": array
        },
      "additionalParams": array      
    },
    "errors": array
}

Методы

Метод Описание С версии
__construct(
   $componentName,
   $componentTemplate = '',
   array $componentParams = [],
   array $additionalResponseParams = [],
   $dataKeys = []
)
Метод-конструктор. Параметры:
  • $componentName {string} название компонента, например, "bitrix:disk.file.view".
  • $componentTemplate {string} - название шаблона компонента, по умолчанию ".default".
  • $componentParams {array} - массив параметров компонента, по умолчанию пустой массив.
  • $additionalResponseParams {array} - массив, который будет передан в JSON ответе отдельным ключом. Удобно использовать, если необходимо вывести ассоциированные данные с компонентом.
  • $dataKeys {array} - массив, который перечисляет все ключи arResult компонента, которые нужно вернуть в json-ответе.

© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх