Перейти к содержанию

Настройки

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

Выделение места в IPS\Settings

\IPS\Settings является хранилищем для пар данных key/value - оно делится между всеми приложениями и плагинами и доступен отовсюду. Есть также ярлыки для быстрого доступа к его содержимому, которое находится в шаблонах. Его основная цель предназначена для хранения настроек, которые задает администратор в админцентре.

Для того, чтобы использовать это, необходимо ввести ключи, которые вы хотите выделить для вашего плагина и значения по умолчанию в Plugin Developer Center. Ключи не находятся в пространстве имен, поэтому рекомендуется выбирать ключи, которые вряд ли будут использоваться другими приложениями или плагинами.

Создание страницы настроек

Ваш плагин может иметь одну страницу настроек, которая будет отображаться когда администратор нажимает на кнопку "изменить" рядом с плагином. В большинстве случаев это будет просто обычная форма которая создается с помощью помощника форм. Несмотря на то, что помощник очень гибкий (может создавать вкладки, боковые панели и широкий спектр типов ввода), вы не ограничены им и можете отображать настройки, как вам нравится.

В каталоге  /plugins/<ваш_плагин> вы найдете файл под названием "settings.rename.php" – переименуйте его в "settings.php". В нем будет содержаться код, который запускается, когда пользователь открывает вашу страницу настроек. Файл-пример создан помощником, и все что вам нужно сделать для его использования, это добавить дополнительные поля ввода. Если вы хотите использовать кастомный интерфейс, вам просто нужно возвращать либо строку (с контентом для отображения) или TRUE, для пропуска страницы настроек. Ваш код будет обработан и, поэтому, вам не нужно использовать <?PHP тег  - включите его в начальный файл чтобы подсветка синтаксиса работала как нужно, но нельзя забывать что он должен быть закомментирован.




×
×
  • Создать...

Важная информация

Используя наш сайт вы соглашаетесь с нашей Политикой конфиденциальности