Справочник API
SiteSettings
get()
SiteSettings::get(
string $type,
string $key,
?string $siteId = null,
?string $default = null
): mixed
Возвращает одно значение. Если сайт не передан, используется сайт по
умолчанию. Если запись отсутствует, возвращается $default.
all()
SiteSettings::all(string $type, ?string $siteId = null): array
Возвращает активные настройки типа как массив ключ => значение.
clearCache()
Очищает кеш фасада в рамках текущего PHP-запроса. Сервисный слой вызывает этот метод автоматически после изменения данных.
SettingsService
| Метод | Назначение |
|---|---|
getByKey($key, $type, $siteId) |
Строка настройки с метаданными или null |
getByType($type, $siteId) |
Активные настройки типа |
getAll() |
Все строки настроек |
getValue($type, $key, $siteId) |
Форматированное значение |
getValues($type, $siteId) |
Массив значений типа |
getValueWithCode($type, $key, $siteId) |
Подписи выбранных пунктов списка по кодам |
add($fields) |
Создать настройку |
updateById($id, $fields) |
Изменить поля настройки |
updateValue($id, $value) |
Изменить только значение |
deleteById($id) |
Удалить настройку |
deleteByKey($type, $key, $siteId) |
Удалить настройку по ключу |
deleteByTypeAndSite($type, $siteId) |
Удалить значения типа на сайте |
Изменяющие методы возвращают Bitrix\Main\Result.
SettingsTypesService
| Метод | Назначение |
|---|---|
getAll($siteId) |
Все типы или видимые типы сайта |
getVisibleForSite($siteId) |
Глобальные и локальные типы с учётом скрытых |
getByType($type, $siteId) |
Тип по коду |
add($fields) |
Создать тип |
updateByCode($code, $fields, $siteId) |
Изменить тип в заданной области |
deleteByCode($code, $siteId) |
Удалить тип в области или во всех областях |
hideGlobalTypeForSite($siteId, $code) |
Скрыть глобальный тип для сайта |
unhideTypeForSite($siteId, $code) |
Вернуть скрытый тип |
Совместимость
Глобальные классы DbSettings и DbSettingsTypes остаются оболочками над
сервисным слоем. Новый код следует писать через SiteSettings,
SettingsService и SettingsTypesService.