\CBitrixComponent — методы и описание класса

__construct() Конструктор с возможностью копирования компонента.

__prepareComponentParams() Вспомогательная функция для безопасного html-экранирования параметров компонента.

__showError() Функция показывает сообщение о внутренней ошибке.

abortResultCache() Функция прерывает кеш после его старта.

addChildCSS() Функция регистрирует дочерний css-файл для кеширования.

addChildEpilog() Функция регистрирует дочерний файл эпилога для кеширования.

addChildFrame() Регистрирует дочерний фрейм для кеширования.

addChildJS() Функция регистрирует дочерний js-файл для кеширования.

addDeleteAction() Функция добавляет действие удаления в некоторую область внутри компонента.

addEditAction() Функция добавляет действие редактирования в некоторую область внутри компонента.

addEditButton() Функция добавляет кнопку для отображения.

addIncludeAreaIcon() Функция добавляет иконку в область компонента в режиме редактирования.

addIncludeAreaIcons() Функция заменяет иконки, отображаемые для компонента, коллекцией.

addViewTarget() Функция регистрирует новую цель представления для кеширования.

static clearComponentCache() Функция очищает весь кеш компонента.

clearResultCache() Функция удаляет ранее созданный кеш.

endResultCache() Функция завершает блок кеширования при выполнении компонента.

executeComponent() Функция вызывает __includeComponent для выполнения компонента.

getCacheID() Функция возвращает идентификатор кеша на основе параметров компонента и окружения.

getCachePath() Функция возвращает путь к кешу компонента.

getDefaultFrameMode()

getEditAreaId() Функция возвращает id области компонента для режима редактирования.

getFrameMode()

getIncludeAreaIcons() Функция возвращает коллекцию иконок, отображаемых для компонента.

getLanguageId()

getName() Функция возвращает имя компонента в виде bitrix:component.name.

getParent() Функция возвращает родительский компонент (если существует).

getPath() Функция возвращает путь к компоненту относительно DOCUMENT_ROOT веб-сервера в виде /bitrix/components/bitrix/component.name.

getRealFrameMode()

getRelativePath() Функция возвращает путь к компоненту в виде /bitrix/component.name.

getSignedParameters() Возвращает подписанные параметры.

getSiteId()

getSiteTemplateId()

getTemplate() Функция возвращает объект шаблона.

getTemplateCachedData() Функция возвращает css-файлы текущего шаблона или null, если шаблона нет.

getTemplateName() Функция возвращает имя шаблона.

getTemplatePage() Функция возвращает страницу шаблона, которая была задана через initComponentTemplate.

includeComponent() Функция выполняет компонент. Возвращает результат его выполнения.

static includeComponentClass() Функция подключает класс компонента по имени компонента bitrix:component.base.

includeComponentEpilog() Функция восстанавливает окружение эпилога компонента и выполняет его.

includeComponentLang() Функция подключает языковые файлы из каталога компонента.

includeComponentTemplate() Функция выполняет шаблон.

initComponent() Функция инициализирует компонент. Возвращает true при успехе.

initComponentTemplate() Функция инициализирует шаблон компонента. Возвращает true при успехе.

onIncludeComponentLang() Событие, вызываемое из includeComponent перед выполнением компонента.

onPrepareComponentParams() Событие, вызываемое из includeComponent перед выполнением компонента.

randString() Функция возвращает следующее псевдослучайное значение.

setFrameMode() Помечает компонент как поддерживающий композитный режим.

setLanguageId()

setResultCacheKeys() Функция помечает ключи arResult для сохранения в кеш. Точно так же, как это делает магический метод __sleep.

setSiteId()

setSiteTemplateId()

setTemplateCachedData() Функция применяет коллекцию css-файлов к текущему шаблону.

setTemplateEpilog() Функция сохраняет окружение эпилога компонента.

setTemplateName() Функция устанавливает имя шаблона. Возвращает true при успехе.

showComponentTemplate() Функция выполняет инициализированный шаблон компонента.

startResultCache() Функция запускает блок кеширования при выполнении компонента.

CBitrixComponent

Свойства

Методы (57)