Файл .parameters.php в 1C-Битрикс отвечает за описание параметров компонента, которые доступны разработчику или администратору при добавлении компонента на страницу через визуальный редактор или административную панель.
Краткий ответ
Файл .parameters.php используется для определения настроек компонента, таких как кеширование, выбор инфоблока, фильтры и другие пользовательские параметры.
$arComponentParameters = [
"PARAMETERS" => [
"CACHE_TIME" => [
"DEFAULT" => 3600
]
]
];
Где находится .parameters.php
Файл располагается в корне компонента:
/local/components/vendor/component.name/
component.php
.parameters.php
.description.php
Структура .parameters.php
Основная структура файла выглядит следующим образом:
<?php
if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED !== true)
{
die();
}
$arComponentParameters = [
"PARAMETERS" => [
// параметры компонента
]
];
Основные элементы параметров
1. TEXT — текстовое поле
"TITLE" => [
"PARENT" => "BASE",
"NAME" => "Заголовок",
"TYPE" => "STRING",
"DEFAULT" => "Пример заголовка"
]
2. CHECKBOX — булево значение
"SHOW_TITLE" => [
"PARENT" => "BASE",
"NAME" => "Показывать заголовок",
"TYPE" => "CHECKBOX",
"DEFAULT" => "Y"
]
3. LIST — выпадающий список
"VIEW_MODE" => [
"PARENT" => "BASE",
"NAME" => "Режим отображения",
"TYPE" => "LIST",
"VALUES" => [
"grid" => "Сетка",
"list" => "Список"
],
"DEFAULT" => "grid"
]
4. STRING — строка
"LIMIT" => [
"PARENT" => "BASE",
"NAME" => "Количество элементов",
"TYPE" => "STRING",
"DEFAULT" => "10"
]
Группы параметров (GROUPS)
Для удобства параметры можно группировать:
"GROUPS" => [
"SETTINGS" => [
"NAME" => "Основные настройки"
],
"CACHE" => [
"NAME" => "Кеширование"
]
]
Пример полного .parameters.php
<?php
if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED !== true)
{
die();
}
$arComponentParameters = [
"GROUPS" => [
"SETTINGS" => [
"NAME" => "Основные настройки"
]
],
"PARAMETERS" => [
"TITLE" => [
"PARENT" => "SETTINGS",
"NAME" => "Заголовок",
"TYPE" => "STRING",
"DEFAULT" => "Новости"
],
"SHOW_TITLE" => [
"PARENT" => "SETTINGS",
"NAME" => "Показывать заголовок",
"TYPE" => "CHECKBOX",
"DEFAULT" => "Y"
],
"CACHE_TIME" => [
"DEFAULT" => 3600
]
]
];
Подключение параметров в component.php
Все параметры доступны в массиве $arParams:
<?php
if ($arParams["SHOW_TITLE"] === "Y")
{
echo "<h1>" . $arParams["TITLE"] . "</h1>";
}
Типичные ошибки
1. Отсутствие проверки ядра
if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED !== true)
{
die();
}
2. Неправильный ключ PARAMETERS
Все параметры должны находиться внутри массива PARAMETERS.
3. Использование неизвестных TYPE
Битрикс поддерживает ограниченный набор типов: STRING, CHECKBOX, LIST, FILE, CUSTOM и др.
4. Игнорирование GROUPS
Без групп параметры становятся неудобными в админке.
5. Отсутствие DEFAULT значений
Это приводит к ошибкам при первом подключении компонента.
Лучшие практики
- Группируйте параметры через GROUPS
- Всегда задавайте DEFAULT значения
- Используйте понятные NAME для админки
- Не перегружайте параметры логикой
- Разделяйте настройки и кеширование
FAQ
Что делает .parameters.php?
Он описывает настройки компонента, доступные в визуальном редакторе Битрикс.
Можно ли использовать свои типы параметров?
Да, через TYPE => "CUSTOM" можно реализовать кастомную логику.
Где доступны параметры компонента?
Внутри component.php они доступны через массив $arParams.
Обязательно ли использовать .parameters.php?
Нет, но без него компонент не будет иметь настраиваемого интерфейса.
Заключение
Файл .parameters.php — важная часть архитектуры компонента Битрикс. Он делает компонент гибким, настраиваемым и удобным для интеграции в проекты любой сложности.
