94  /  380
Справочник

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

Просмотров: 45955
Дата последнего изменения: 03.11.2023
Роберт Басыров
Сложность урока:
2 уровень - несложные понятия и действия, но не расслабляйтесь.
1
2
3
4
5
Недоступно в лицензиях:
Ограничений нет

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

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

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

<?
$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" - путь к пиктограмме относительно папки компонента. Значок компонента используется в разных частях системы, например: в визуальном редакторе. (Параметр устарел, его можно не использовать. При создании собственных компонентов можно создавать .descripton.php без ICON, несмотря на то, что во многих старых компонентах ICON присутствует.)
  • "PATH" - расположение компонента в виртуальном дереве компонентов в визуальном редакторе. Значением этого элемента должен быть массив, имеющий ключи:
    • "ID" - код ветки дерева. ID узла должен быть уникальным в пределах всего дерева компонентов (включая стандартные). Если у узлов будут два одинаковых ID, то оба не будут открываться. Например, для компонента собственной разработки выбран узел ID = "news", а такой ID уже есть для стандартных компонентов.
    • "NAME" - название ветки дерева. Необходимо обязательно указать. NAME берется из первого попавшегося компонента в узле. Если его не оказалось либо нет нужной языковой константы - в качестве NAME используется ID.
    • "CHILD" - дочерняя или подчиненная ветка. В элементе с ключом "CHILD" может быть задана подчиненная ветка дерева с той же структурой, что и родительская ветка.
    Дерево ограничено тремя уровнями. Как правило, строится двухуровневое дерево и компоненты располагаются на втором уровне. Следующие служебные названия первого уровня зарезервированы и не могут быть использованы: "content" (контент), "service" (сервисы), "communication" (общение), "e-store" (магазин), "utility" (служебные).

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

38
Курсы разработаны в компании «1С-Битрикс»

Если вы нашли неточность в тексте, непонятное объяснение, пожалуйста, сообщите нам об этом в комментариях.
Развернуть комментарии