Bitrix - Описание компонента (.description.php)
Войти

Bitrix - Описание компонента (.description.php)

Bitrix - Описание компонента

.description.php - файл с описание компонента.

Это описание применяется для работы с компонентом из среды БУС (например, в визуальном редакторе), а так же при работе в режиме редактирования сайта. При работе самого компонента (при обращении к странице, на которой расположен компонент) описание не используется и файл .description.php не подключается.

Файл .description.php должен находиться в папке компонента. Языковой файл подключается автоматически (должен лежать в папке /lang/<язык>/.description.php относительно папки компонента).

Структура типичного файла .description.php такова:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 <?php 

if(!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true)die();
$arComponentDescription = array(
   "NAME" => GetMessage("COMP_NAME"),
   "DESCRIPTION" => GetMessage("COMP_DESCR"),
   "ICON" => "/images/icon.gif",
   "PATH" => array(
      "ID" => "content",
      "CHILD" => array(
         "ID" => "catalog",
         "NAME" => "Каталог товаров"
      )
   ),
   "AREA_BUTTONS" => array(
      array(
         'URL' => "javascript:alert('Это кнопка!!!');",
         'SRC' => '/images/button.jpg',
         'TITLE' => "Это кнопка!"
      ),
   ),
   "CACHE_PATH" => "Y",
   "COMPLEX" => "Y"
);

?>

То есть в файле определяется массив $arComponentDescription, который описывает компонент. Этот массив может иметь следующие ключи:

"NAME" - название компонента;

"DESCRIPTION" - описание компонента;

"ICON" - путь к иконке компонента относительно папки компонента. Иконка компонента используется в среде БУС (например, в визуальном редакторе);

"PATH" - расположение компонента в виртуальном дереве компонента в визуальном редакторе. Значением этого элемента должен быть массив, имеющий ключи "ID" (код ветки дерева), "NAME" (название ветки дерева), "CHILD" (ветка - ребенок / подчиненная ветка). В элементе с ключем "CHILD" может быть задана подчиненная ветка дерева с той же структурой, что и родительская ветка. Дерево ограничено тремя уровнями. Как правило строится двухуровневое дерево и компоненты распологаются на втором уровне. Названия первого уровня "content" (контент), "service" (сервисы), "communication" (общение), "e-store" (магазин), "utility" (служебные) стандартизованы и их задавать не следует. Если ключ "PATH" не задан, то компонент не будет присутствовать в визуальном редакторе;

"AREA_BUTTONS" - пользовательские кнопки, которые показываются для компонента в режиме редактирования сайта;

"CACHE_PATH" - если значение равно "Y", то показывать кнопку очистки кеша компонента в режиме редактирования сайта (предполагается, что кеш лежит по стандартному пути /<код сайта>/<относительный путь к компоненту>). Если равно не пустой отличной от "Y" строке, то показывать кнопку очистки кеша компонента в режиме редактирования сайта (кеш лежит по пути, равному значению с ключем "CACHE_PATH" - для не стандартных путей);

"COMPLEX" - элемент должен иметь значение "Y" для комплексного компонента, для простых компонентов не имеет значения.

Теги:
php