solutosoft / yii-settings
The Shared Database used by all tenants
Installs: 1 748
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Type:yii-extension
Requires
- yiisoft/yii2: ~2.0.16
Requires (Dev)
- phpunit/phpunit: ~4.4
This package is auto-updated.
Last update: 2024-09-27 19:37:38 UTC
README
This extension provides support for persistent settings for Yii2.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist solutosoft/yii-settings
or add
"solutosoft/yii-settings": "*"
Configuration
To use the Setting Component, you need to configure the components array in your application configuration:
'components' => [ 'settings' => [ 'class' => 'solutosoft\settings\Settings', ], ],
Usage
$settings = Yii::$app->settings; $settings->set('key'); $settings->set('section.key'); // Checking existence of setting $settings->exists('key'); // Removes a setting $settings->remove('key'); // Removes all settings $settings->removeAll();
Events
You can use beforeExecute
event to store extra values and apply extra conditions on command execution
<?php 'components' => [ 'settings' => [ 'class' => 'solutosoft\settings\Settings', 'on beforeExecute' => function ($event) { $event->data = ['user_id' => Yii::$app->user->id]; } ], ], $settings = Yii::$app->settings; //INSERT (`key`,`value`, `user_id`) INTO `setting` VALUES ('website', 'http://example.org', 1) $settings->set('website', 'http://example.org'); //SELECT `value` FROM `setting` WHER (`settings`.`key` = 'website' and `settings`.`user_id` = 1) $settings->get('website', 'http://example.org');