Получить параметры модуля Option::getForModule
Модуль: main — подключать отдельно не нужно
Метод Option::getForModule возвращает набор сохраненных параметров модуля. Значения выбранного сайта заменяют одноименные общие значения. Параметры из файла default_option.php в результат не входят.
Сигнатура метода в классе Bitrix\Main\Config\Option:
public static function getForModule($moduleId, $siteId = false)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| moduleId* | string |
Задает идентификатор модуля без учета регистра |
| siteId | string, bool |
Выбирает сайт. По умолчанию — false, то есть сайт из текущего контекста. Пустая строка выбирает только общие параметры |
Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их типы.
Возвращаемое значение
Метод возвращает ассоциативный массив параметров. Если у модуля нет сохраненных параметров, результат — [].
|
Элемент массива |
Описание |
|
Ключ |
Содержит имя параметра в нижнем регистре |
|
Значение |
Содержит сохраненное значение. Параметр сайта имеет приоритет над общим, включая пустую строку |
Метод кеширует загруженные параметры модуля. Вызовы set и delete сбрасывают этот кеш для модуля.
Исключения
| Исключение | Когда возникает |
|---|---|
Bitrix\Main\ArgumentNullException |
Аргумент moduleId равен пустой строке |
Bitrix\Main\DB\ConnectionException |
Не удалось установить соединение с базой данных |
Bitrix\Main\DB\SqlQueryException |
Не удалось прочитать общие параметры из базы данных |
Примеры
Пример. Код получает только общие параметры модуля main:
<?php
use Bitrix\Main\Config\Option;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$options = Option::getForModule('main', '');
var_dump(count($options));