Configuration — конфигурация ядра и модулей

Пространство имен: Bitrix\Main\Config

Модуль: main — подключать отдельно не нужно

Когда использовать

Класс Configuration читает и меняет секции из .settings.php, общей конфигурации и файлов установленных модулей. Он подходит для параметров соединений, кеша, обработки ошибок и других настроек ядра.

Объект получают через getInstance или getInstanceByPath. Класс объявлен final и реализует ArrayAccess, Iterator и Countable. Операции с объектом меняют данные в памяти. Метод saveConfiguration записывает их в файл, а setValue объединяет изменение и сохранение.

Для параметров модулей в базе данных используют класс Option. Формат секций и сценарии настройки приведены в статье Конфигурация ядра.

Методы класса

Метод Описание С версии
getValue Возвращает значение секции
setValue Изменяет и сохраняет секцию
getInstance Возвращает объект конфигурации
getInstanceByPath Возвращает конфигурацию по пути
saveConfiguration Сохраняет конфигурацию
add Добавляет или изменяет секцию
addReadonly Добавляет защищенную секцию
isReadonly Проверяет, защищена ли секция
delete Удаляет секцию
get Возвращает значение секции объекта
offsetExists Проверяет наличие секции
offsetGet Возвращает значение через ArrayAccess
offsetSet Изменяет секцию через ArrayAccess
offsetUnset Удаляет секцию через ArrayAccess
current Возвращает текущее значение итератора
next Переходит к следующей секции
key Возвращает ключ текущей секции
valid Проверяет позицию итератора
rewind Возвращает итератор к началу
count Считает секции
wnc Переносит настройки классического API

Смотрите также