Настройки сайта 2.0.0
Модуль kokhanenko.settings позволяет хранить параметры сайта в одном месте и изменять их в административной панели 1С-Битрикс. Например, контент-менеджер может поменять телефон, подпись кнопки или текст на странице, не редактируя файлы шаблона.
Разработчик выбирает, какие параметры нужны сайту, создаёт для них настройки и подключает их в PHP-коде. После этого менеджер работает с готовыми полями в админке.
Возможности модуля
- Разделы и группы. Настройки можно объединить по назначению: контакты, шапка сайта, подвал или другие разделы.
- Разные поля ввода. Для текста доступны обычное и многострочное поля, для переключателя — флажок, для выбора вариантов — список. Также поддерживаются дата и время.
- Подсказки и зависимые поля. Рядом с полем можно разместить инструкцию, а связанные поля показывать при включении родительского переключателя.
- Несколько сайтов. Один и тот же параметр может иметь разные значения на разных сайтах Битрикса.
- Чтение из PHP. Разработчик получает значения через класс
Settings: текст — строкой, переключатель — логическим значением, множественный выбор — массивом кодов.
note
Создание настройки не добавляет её на публичную страницу автоматически. Например, чтобы телефон из админки появился в шапке сайта, разработчик должен сначала подключить его вывод в шаблоне. После этого менеджер сможет менять номер без правки кода.
Как пользоваться документацией
| Что вы хотите сделать | Что прочитать |
|---|---|
| Установить модуль и попробовать его на сайте | Установка и быстрый старт — пример подключения кнопки и изменения её подписи |
| Изменить текст, телефон или выбранный вариант | Для контент-менеджера — как найти поле, сохранить значение и проверить результат |
| Создать настройку или изменить её параметры | Работа в административной панели — разделы, группы, списки и зависимости |
| Подключить настройки в PHP-шаблоне | Подключение в коде и практические рецепты |
| Разобраться в типах значений и методах чтения | Модель настроек и справочник API |
| Обновить ранее установленный модуль | Обновление с 1.1.3 — резервное копирование, изменения в коде и проверка результата |
| Удалить модуль или восстановить его работу | Удаление и переустановка и решение проблем |
Если модуль уже установлен
Если у вас уже установлен модуль версии 1.1.3 или более ранней, перед переходом на 2.0.0 ознакомьтесь с инструкцией обновления. В ней разобран переход с 1.1.3. Для более ранней версии сначала проверьте доступную последовательность обновлений в штатном клиенте Битрикса.
warning
В версии 2.0.0 изменился PHP API: класс SiteSettings заменён на Settings, а значения некоторых типов теперь возвращаются в другом формате. Старый код шаблонов может перестать работать после обновления.
До установки обновления на рабочем сайте найдите обращения к SiteSettings в шаблонах и собственных скриптах, подготовьте замену на Settings и поправьте обработку значений. Например, переключатель теперь возвращает true или false, а не строки '1' и '0'. Перенос настроек в БД не изменяет PHP-код вашего сайта.
Проверьте обновлённые шаблоны вместе с модулем 2.0.0 на тестовой копии. На рабочем сайте обновляйте модуль и подготовленный код согласованно, после создания резервной копии файлов и БД. Таблица замен и порядок проверки.