Bitrix - Параметры компонента (.parameters)
Войти

Bitrix - Параметры компонента (.parameters)

Bitrix - Параметры компонента (.parameters)

В файле .parameters.php содержится описание входных параметров компонента. Данные файла нужны исключительно для создания формы ввода свойств компонента в среде Bitrix Framework (например, в визуальном редакторе).

Это описание применяется для работы с компонентом, а также при работе в режиме редактирования сайта. При работе самого компонента (при обращении к странице, на которой расположен компонент) описание не используется и указанный файл не подключается. Для комплексного компонента в этом файле задаются параметры простых компонентов, входящих в состав комплексного. Также здесь будут задаваться и настройки ЧПУ.

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

В файле определяется массив $arComponentParameters, который описывает входные параметры компонента. Если необходимо, производится выборка каких-либо дополнительных данных. Например, для формирования выпадающего списка типов информационных блоков (входной параметр IBLOCK_TYPE_ID) выбираются все активные типы.

Структура типичного файла .parameters.php (на примере компонентов, работающих с модулем Информационные блоки):
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
 <?php 

CModule::IncludeModule("iblock");

$dbIBlockType = CIBlockType::GetList(
   array("sort" => "asc"),
   array("ACTIVE" => "Y")
);
while ($arIBlockType = $dbIBlockType->Fetch())
{
   if ($arIBlockTypeLang = CIBlockType::GetByIDLang($arIBlockType["ID"],
LANGUAGE_ID))
      $arIblockType[$arIBlockType["ID"]] = "[".$arIBlockType["ID"]."]
".$arIBlockTypeLang["NAME"];
}

?>

Опишем ключи массива $arComponentParameters подробнее.

GROUPS

Значением этого ключа является массив групп параметров компонента. Параметры в визуальных средствах среды Bitrix Framework (например, в визуальном редакторе) группируются. Группы в среде Bitrix Framework располагаются в том порядке, в котором заданы в файле. Массив групп параметров компонента состоит из элементов следующего вида:

Перечень стандартных групп:

  • ADDITIONAL_SETTINGS (сортировка - 700). Эта группа появляется, например, при указании параметра SET_TITLE.
  • CACHE_SETTINGS (сортировка - 600). Появляется при указании параметра CACHE_TIME.
  • SEF_MODE (сортировка 500). Группа для всех параметров, связанных с использованием ЧПУ.
  • URL_TEMPLATES (сортировка 400). Шаблоны ссылок
  • VISUAL (сортировка 300). Редко используемая группа. Сюда предполагается загонять параметры, отвечающие за внешний вид.
  • DATA_SOURCE (сортировка 200). Тип и ID инфоблока.
  • BASE (сортировка 100). Основные параметры.
  • AJAX_SETTINGS (сортировка 550). Все, что касается ajax.
    • Важно: Наиболее правильный вариант кастомизации компонента - скопировать его в отдельное пространство имен и работать уже с копией компонента. При этом нужно учитывать последствия:
    • Увеличивается общее количество компонентов, соответственно растет и количество выделяемых на их поддержку ресурсов.
    • Сложность в освоении новым разработчиком: сначала ему нужно будет найти в чем отличие от уже существующего стандартного компонента.
    Теги:
    php