Option — параметры модулей
Пространство имен: Bitrix\Main\Config
Модуль: main — подключать отдельно не нужно. Для выполнения примеров нужен пролог сайта.
Когда использовать
Класс Option хранит параметры модулей в базе данных, общие для всех сайтов или отдельные для конкретного сайта. Его методы вызывают статически, без создания объекта.
Метод get возвращает параметр с учетом общих значений и значений по умолчанию. Метод getRealValue проверяет, сохранен ли параметр именно для выбранного сайта или в общих параметрах. Метод getForModule возвращает набор сохраненных параметров модуля.
Класс COption помечен устаревшим. Его методы продолжают работать через Option. Для нового кода используйте Option.
Методы класса
| Метод | Описание | С версии |
|---|---|---|
| get | Возвращает значение параметра с учетом общих значений и значений по умолчанию | |
| getRealValue | Возвращает сохраненное значение для выбранного сайта или общих параметров | |
| getDefaults | Возвращает значения по умолчанию из файла модуля | |
| getForModule | Возвращает сохраненные параметры модуля с учетом выбранного сайта | |
| set | Сохраняет значение параметра и отправляет события | |
| delete | Удаляет сохраненные параметры по фильтру |
Была ли статья полезна?
Предыдущая
Следующая