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

Вставка включаемой области

Компонент располагается в шаблоне дизайна сайта и определяет место расположения включаемых областей страниц и разделов. Также компонент может выводить содержимое произвольного файла (например, информацию об авторских правах, название компании и т.д.). Настройки компонента позволяют определить суффикс имени файла включаемой области, указать режим редактирования включаемой области по умолчанию, шаблон области по умолчанию. Компонент является стандартным и входит в дистрибутив модуля.

В визуальном редакторе компонент расположен по пути: Служебные > Включаемые области > Вставка включаемой области.

Компонент относится к Главному модулю.

Пример вызова компонента main.include

Описание параметров

Поле Параметр Описание
Параметры компонента
Показывать включаемую область AREA_FILE_SHOW Возможные значения:
  • sect: показывать для раздела, область будет являться включаемой для всего раздела;
  • page: показывать для страницы, область будет являться включаемой только для текущей страницы;
  • file: показывать информацию из файла. Если компонент расположить в шаблоне дизайна сайта, то информация из файла будет выводиться на всем сайте. Установка параметра доступна только пользователю с правами edit_php.
Путь к файлу области PATH Поле доступно, если выбрано Показывать включаемую область из файла. Задается полный путь от корня сайта к файлу с информацией, которую надо вывести в этой части сайта.
Суффикс имени файла включаемой области AREA_FILE_SUFFIX Поле предназначено для указания суффикса, который будет добавляться к именам файлов включаемых областей. Страницы с таким суффиксом будут восприниматься как включаемые области.
Рекурсивное подключение включаемых областей разделов AREA_FILE_RECURSIVE [Y|N] Настройка доступна при отмеченной области Показывать включаемую область (AREA_FILE_SHOW) в значение для раздела (sect). При отмеченной опции включаемые области разделов будут подключаться рекурсивно, т.е. если в папке более низкого уровня есть своя включаемая область, то она будет показана. Если же текущий раздел не имеет своей включаемой области, то рекурсивно до корня сайта будут проверяться все разделы до самого верхнего и будет выведена первая встретившаяся включаемая область.
Шаблон области по умолчанию EDIT_TEMPLATE Доступны все шаблоны страниц, созданные в системе. Они располагаются в разделе /bitrix/templates/.default/page_templates/. В данном поле можно указать любой другой файл в системе, указав полный путь к файлу-шаблону.

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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
Алена Манчукова
Для примера:

<?$APPLICATION->IncludeComponent("bitrix:main.include","",Array(
       "AREA_FILE_SHOW" => "page",
       "AREA_FILE_SUFFIX" => "example",
       "EDIT_TEMPLATE" => ""
   )
);?>

Это означает, что для определенной страницы "page" будет показан файл с названием "index_example.php" (index в названии файла обязателен, т.к. компонент не будет находить файл )
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх