Kokhanenko: Настройки сайта

2 000 i

Заказать

Оформление заказа

В наличии

Официальные лицензии

Описание

Установка

Поддержка

Kokhanenko: Настройки сайта

Единое место для управления настройками сайта на 1С-Битрикс.

Сайт разработчика · Подробная страница модуля

Модуль помогает вынести часто изменяемые параметры из PHP-шаблонов в административный интерфейс: телефоны, e-mail, подписи кнопок, заголовки, ссылки, переключатели блоков, даты, время и варианты списков.

После первоначального подключения настройки меняются в административной части без повторного редактирования шаблонов. Разработчик получает значения через простой типизированный PHP API.

Для каких задач подходит

хранение контактов и реквизитов сайта;
управление заголовками, подписями, ссылками и служебными текстами;
включение и отключение отдельных элементов или блоков;
хранение дат, времени и выбранных вариантов списков;
организация настроек по сайтам, разделам и смысловым группам;
единый доступ к параметрам из шаблонов и компонентов.

Возможности
Многосайтовость

Настройки привязываются к сайту и разделу, например base, header, footer или contacts. В одной установке можно вести отдельные наборы значений для разных сайтов.

Удобная структура

В административной части можно создавать и подключать разделы настроек, объединять параметры в группы, задавать названия, подсказки, сортировку и активность.

Типизированные значения

Версия 2.0 поддерживает пять типов данных:

string — строка;
boolean — логическое значение;
enum — один или несколько вариантов из списка;
date — дата;
time — время.

Тип данных отделён от элемента управления. Например, строку можно редактировать в однострочном или многострочном поле, а список — выбирать в одиночном или множественном режиме.

Связанные настройки

Логическую настройку можно назначить родительской. Зависимые поля отображаются только тогда, когда соответствующий переключатель включён. Модуль проверяет корректность связей и не допускает циклических зависимостей.

Безопасное хранение и проверка значений

Значения хранятся в строгом JSON-формате и проверяются в соответствии с выбранным типом. Даты, время, логические значения и варианты списков не смешиваются с произвольными строковыми форматами.

Кеширование

Чтение настроек кешируется средствами модуля и Битрикса. После изменения значений соответствующий кеш сбрасывается автоматически.

Для разработчика

Основной фасад версии 2.0 — Kokhanenko\Settings\Settings.

use Kokhanenko\Settings\Settings;



$siteName = Settings::get('base', 'siteName', 's1');

$footer = Settings::all('footer', 's1');

$phone = Settings::contacts('phone', 's1');

Метод get() возвращает значение в соответствии с его типом: строку, bool, массив вариантов либо нормализованную дату или время. Для проверки наличия настройки предусмотрен Settings::has(), для выбранных вариантов списка — Settings::selectedOptions().

Если идентификатор сайта не передан, используется сайт по умолчанию, настроенный в 1С-Битрикс.

Версия 2.0

Текущая версия 2.0 — крупное обновление внутренней модели: настройки получили строгие типы данных, JSON-хранение и новый типизированный PHP-фасад. Подробности выпуска приведены на вкладке «Что нового».

Важно

Модуль предназначен для небольших параметров сайта и не заменяет инфоблоки, highload-блоки, каталог или визуальный конструктор страниц. В версии 2.0 значения редактируются в административной части; публичное редактирование непосредственно на страницах сайта не входит в эту версию.

Подробнее о модуле · Сайт разработчика

Внимание!

Так как модуль использует для хранения настроек базу данных SQLite, при установке проверьте включены ли у вас в php.ini следующие строки:

extension=pdo_sqlite

extension=pdo

Установка и демонстрационные настройки

Модуль устанавливается стандартным способом.

После установки на сайт автоматически добавляются демонстрационные настройки и типы настроек. Вы можете их:

изменять,
удалять,
добавлять собственные.

Настройки доступны в административной панели.

Если у вас несколько сайтов, то при установке для каждого из них будут заданы настройки по умолчанию.

Файлы с дефолтными значениями

Типы настроек по умолчанию: /modules/kokhanenko.settings/install/defaultSettingsTypes.php
Настройки по умолчанию: /modules/kokhanenko.settings/install/defaultSettings.php.

Удаление модуля

При удалении модуля вам будет предложено:

Сохранить текущие настройки — в этом случае при повторной установке модуль не будет сбрасывать данные;
Удалить настройки — все значения будут очищены, и при новой установке применяться настройки по умолчанию.

Пример использования в проекте

Пример получения значений настроек расположен в файле:
/modules/kokhanenko.settings/example.php

use Kokhanenko\Settings\DbSettings;



$dbSettings = new DbSettings();      



$value = $dbSettings->getValue('base', 'selectIBlock');         

var_dump($value);   



$value2 = $dbSettings->getValueWithCode('base', 'selectIBlock');         

var_dump($value2);

Методы получения значений

getValue(string $type, string $key, string $siteId = '')

Получает значение настройки по типу и ключу. Если не указан siteId, используется текущий сайт.

getValueWithCode(string $type, string $key, string $siteId = '')

Используется для типов "Список" или "Множественный список", когда нужно получить не только ID, но и код (символьное значение) элемента.

❓ Обратная связь и поддержка

По вопросам работы модуля, а также предложениям по добавлению новой функциональности, вы можете обращаться по электронной почте:
info@kokhanenko.pro