alhimik1986/yii2_settings_module

Module, allowing get and set your settings, and having access throw the web page.

yii2 settings module

Модуль для хранения и получения системных настроек приложения. Является аналогом Yii::$app->params, только его можно править через веб-интерфейс., _(*1)

Для чего нужен:

В системных настройках можно хранить параметры подключения к базе данных и менять их через веб-интерфейс. Это удобно. Особенно это бывает необходимо, если код обфусцирован и в нем нельзя задавать настройки. Конечно, можно вынести настройки в отдельный файл, но пользователям вряд ли понравится искать этот файл в дебрях папок и что-то править, согласно дурацким правилам json-, xml-, yaml- или ini-формата. Куда интереснее это будет править настройки через красивый веб-интерфейс., _(*2)

Демонстрация

, _(*3)

УСТАНОВКА:

Скачивается с помощью composer. В папке приложения в файле composer.json дописать строчку:, _(*4)

    "require": {
        "alhimik1986/yii2_settings_module": "1.0"
    },

или в командой строке ввести:, _(*5)

$ composer require alhimik1986/yii2_settings_module

В файле config/web.php прописать настройки:, _(*6)

$config = [
    'components' => [
        ...........
        'settings' => ['class' => 'alhimik1986\yii2_settings_module\components\Settings'], // Для доступа к настройкам
    ],

    // Для доступа на странцу редактирования настроек
    'modules' => [
        ...........
        'settings' => [
            'class' => 'alhimik1986\yii2_settings_module\Module',
            // Необязательные параметры
            'password' => '123', // Пароль для в входа на страницу редактирования настроек. По умолчанию 123, если указать пустой, то вход без авторизации
            'password_in_settings' => false, // Если указать true, то брать и проверять пароль в настройках (settings.json), а не в web.config-файле.
            'allowedIPs' => ['127.0.0.1', '::1'], // Доступ по IP-адресам
            //'l18n_base_path' => realpath(__DIR__ .'/../messages/alhimik1986/yii2_settings_module'); // Папка, в которой содержатся переводы на другие языки
        ],
    ],
];

// Или так:, _(*7)

$config['components']['settings']['class'] = 'alhimik1986\yii2_settings_module\components\Settings'; // Для доступа к настройкам
$config['modules']['settings']['class']    = 'alhimik1986\yii2_settings_module\Module';              // Для доступа на странцу редактирования настроек

Адрес для входа в настройки:

http://localhost/index.php?r=settings
Пароль: 123, _(*8)

Все эти настройки, находится в файле vendor/alhimik1986/yii2_settings_module/settings/settings.json, _(*9)

Пример доступа к настройкам:

$db = Yii::$app->settings->param['db']; // Здесь хранятся кэшированные данные
$db = Yii::$app->settings->get('db');   // То же самое, тольк данные не кэшируются, но быстродействие от этого практически не пострадает
Yii::$app->settings->set('password', '1234243'); // Меняем значение настройки "password"

В переменной $db ключи value, label, description исключены, так как они не нужны. Берется только name (ключ настройки) и значение value (значенние настройки). Т.е., если в settings.json было:, _(*10)

{
    "db": {
        "value": {
            "connectionString": "sqlite:@app\/data\/database.s3db",
            "username": "",
            "password": "",
            "tablePrefix": "",
            "class": "yii\\db\\Connection"
        },
        "label": "Настройки подключения к базе данных.",
        "description": ""
    },
}

То $db будет равен:, _(*11)

[
    'connectionString' => 'sqlite:@app/data/database.s3db',
    'username'         => '',
    'password'         => '',
    'tablePrefix'      => '',
    'class'            => 'yii\db\Connection',
]

Пример использования этого модуля в файле web.php для установки параметров подключения к базе данных:

require_once(realpath(__DIR__.'/../vendor/alhimik1986/yii2_settings_module/models/SettingsModel.php'));
$config['components']['db'] = alhimik1986\yii2_settings_module\models\SettingsModel::getSetting('db');

Подписи параметров настроек

Подписи параметров настроек находятся в папке модуля модуля в файле messages/[language]/settings_messages.php Править переводы в папке vendor не совсем правильно. Поэтому лучше в настройках прописать путь к папке переводов, например, в [папка_приложения]/messages/alhimik1986/yii2_settings_module. B скопировать туда содержимое папки messages нашего модуля., _(*12)

$config['modules']['settings']['l18n_base_path'] = realpath(__DIR__ .'/../messages/alhimik1986/yii2_settings_module');

То же самое касается и файла settings.json. Его расположение также можно задать в настройках:, _(*13)

$settings_path = realpath(__DIR__ .'/../config').'/settings.json';
require_once(realpath(__DIR__.'/../vendor/alhimik1986/yii2_settings_module/models/SettingsModel.php'));
alhimik1986\yii2_settings_module\models\SettingsModel::set_custom_settings_json_file_path($settings_path);
$config['components']['db'] = alhimik1986\yii2_settings_module\models\SettingsModel::getSetting('db');

Суммарно типичные настройки выглядят вот так:

// Модуль настроек
$config['modules']['settings']['class'] = 'alhimik1986\yii2_settings_module\Module';
//$config['modules']['settings']['password'] = '123'; // Пароль для в входа на страницу редактирования настроек. По умолчанию 123, если указать пустой, то вход без авторизации
$config['modules']['settings']['password_in_settings'] = true; // Если указать true, то брать и проверять пароль в настройках (settings.json), а не в web.config-файле.
$config['modules']['settings']['allowedIPs'] = ['127.0.0.1', '::1']; // Доступ по IP-адресам
//$config['modules']['settings']['l18n_base_path' = realpath(__DIR__ .'/../messages/alhimik1986/yii2_settings_module'); // Папка, в которой содержатся переводы на другие языки
$config['modules']['settings']['settings_json_file'] = realpath(__DIR__ .'/../config').'/settings.json';

// Для доступа к настройкам
$config['components']['settings']['class'] = 'alhimik1986\yii2_settings_module\components\Settings';

// Подключение к базе данных через настройки
$settings_path = realpath(__DIR__ .'/../config').'/settings.json';
require_once(realpath(__DIR__.'/../vendor/alhimik1986/yii2_settings_module/models/SettingsModel.php'));
alhimik1986\yii2_settings_module\models\SettingsModel::set_custom_settings_json_file_path($settings_path);
$config['components']['db'] = alhimik1986\yii2_settings_module\models\SettingsModel::getSetting('db');