API модуля
Подключение модуля
Для использования методов модуля в публичной части сайта, предварительно необходимо подключить модуль на странице.
\Bitrix\Main\Loader::includeModule('native.settings');Получение значения параметра
В случае отсутствия значения для параметра или невозможности отработки условий при получении значения - будет возвращено N.
// Название параметра: schedule
// Значение параметра по умолчанию: N
$value = \Native\Settings\Option::get('schedule', 'N');Установка значения параметра
На время отработки скрипта, если параметр не только для чтения - будет установлено значение Y.
// Название параметра: schedule
// Значение параметра: Y
\Native\Settings\Option::set('schedule', 'Y');Типы значений параметров
\Native\Settings\Option::getValueTypes();CRUD
Во всех методах доступны штатные параметры ORM.
//Поля параметра
\Native\Settings\OptionTable::getMap();
// Получить список параметров
\Native\Settings\Option::getList(['select' => ['*'], 'filter' => []]);
// Добавить параметр
\Native\Settings\Option::add($data);
// Обновить параметр
\Native\Settings\Option::update($primary, $data);
// Удалить параметр
\Native\Settings\Option::delete($primary);Крайне не рекомендуется манипулировать параметрами напрямую через таблицы базы данных.
Для манипуляции необходимо использовать описанные выше методы, так как при их отработке выполняются и другие сопутствующие действия.
Константы
\Native\Settings\Option::VALUE_TYPE_STRING; // Строка
\Native\Settings\Option::VALUE_TYPE_NUMBER; // Число
\Native\Settings\Option::VALUE_TYPE_ARRAY; // Массив
\Native\Settings\Option::VALUE_TYPE_JSON; // Json
\Native\Settings\Option::VALUE_TYPE_DATE; // Дата
\Native\Settings\Option::VALUE_TYPE_DATE_TIME; // Дата и время