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

Класс CBitrixComponent

Класс CBitrixComponent является оболочкой компонента. Для каждого подключаемого компонента создаётся свой экземпляр класса CBitrixComponent, который живет до конца подключения компонента. Внутри компонента методы этого класса доступны через переменную-псевдоним $this.

Метод Описание С версии
StartResultCache Метод поддержки внутреннего кеширования компонента.
ShowComponentTemplate Метод подключает шаблон компонента. 5.1.9
SetTemplateCachedData Метод возвращает шаблону данные, которые необходимо было сохранить в кэше. 5.1.9
InitComponentTemplate Метод инициализирует шаблон компонента.
IncludeComponentTemplate Метод инициализирует и подключает шаблон компонента.
GetTemplatePage Метод возвращает имя страницы шаблона компонента.
GetTemplateName Метод возвращает имя шаблона компонента.
GetTemplateCachedData метод возвращает данные, которые необходимо сохранить в кэше.
GetTemplate Метод возвращает ссылку на объект шаблона компонента. 12.0.0
GetRelativePath Метод возвращает путь к папке компонента относительно папки /bitrix/components.
GetPath Метод возвращает путь к папке компонента относительно корня сайта.
GetParent Метод возвращает ссылку на объект родительского комплексного компонента. 12.0.0
GetName Метод возвращает имя компонента.
AddIncludeAreaIcons Добавляет массив новых кнопок к кнопкам компонента.
AddIncludeAreaIcon Добавляет новую кнопку к кнопкам компонента.
AbortResultCache Метод поддержки внутреннего кеширования компонента.
ClearResultCache Метод поддержки внутреннего кеширования компонента.
SetResultCacheKeys Метод поддержки внутреннего кеширования компонента. 7.0.14
EndResultCache Метод позволяет кешировать только $arResult без кеширования html-кода. Вызывается в конце блока получения данных, сохраняемых в кеше (перед закрывающей скобкой), и тогда IncludeComponentTemplate можно вынести из этого блока. 5.1.8


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх