├── AutoloadExample.php
├── Bootstrap.php
├── Module.php
├── README.md
├── Setting.php
├── composer.json
├── controllers
    └── DefaultController.php
├── messages
    ├── en
    │   └── setting.php
    └── zh-CN
    │   └── setting.php
├── migrations
    └── m141208_201488_setting_init.php
├── models
    └── Setting.php
├── views
    └── default
    │   └── index.php
└── yii2-setting-preview.png


/AutoloadExample.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace funson86\setting;
 4 | 
 5 | /**
 6 |  * This is just an example.
 7 |  */
 8 | class AutoloadExample extends \yii\base\Widget
 9 | {
10 |     public function run()
11 |     {
12 |         return "Hello!";
13 |     }
14 | }
15 | 


--------------------------------------------------------------------------------
/Bootstrap.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace funson86\setting;
 4 | 
 5 | use yii\base\BootstrapInterface;
 6 | 
 7 | /**
 8 |  * Blogs module bootstrap class.
 9 |  */
10 | class Bootstrap implements BootstrapInterface
11 | {
12 |     /**
13 |      * @inheritdoc
14 |      */
15 |     public function bootstrap($app)
16 |     {
17 |         // Add module URL rules.
18 |         /*$app->getUrlManager()->addRules(
19 |             [
20 |                 'POST <_m:blogs>' => '<_m>/user/create',
21 |                 '<_m:blogs>' => '<_m>/default/index',
22 |                 '<_m:blogs>/<id:\d+>-<alias:[a-zA-Z0-9_-]{1,100}+>' => '<_m>/default/view',
23 |             ]
24 |         )*/;
25 | 
26 |         // Add module I18N category.
27 |         if (!isset($app->i18n->translations['funson86/setting']) && !isset($app->i18n->translations['funson86/*'])) {
28 |             $app->i18n->translations['funson86/setting'] = [
29 |                 'class' => 'yii\i18n\PhpMessageSource',
30 |                 'basePath' => '@funson86/setting/messages',
31 |                 'forceTranslation' => true,
32 |                 'fileMap' => [
33 |                     'funson86/setting' => 'setting.php',
34 |                 ]
35 |             ];
36 |         }
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/Module.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace funson86\setting;
 4 | use Yii;
 5 | 
 6 | class Module extends \yii\base\Module
 7 | {
 8 |     public $controllerNamespace = 'funson86\setting\controllers\frontend';
 9 | 
10 |     protected $_isBackend;
11 | 
12 |     public function init()
13 |     {
14 |         parent::init();
15 | 
16 |         $this->setViewPath('@funson86/setting/views');
17 |     }
18 | 
19 |     /**
20 |      * Translates a message to the specified language.
21 |      *
22 |      * This is a shortcut method of [[\yii\i18n\I18N::translate()]].
23 |      *
24 |      * The translation will be conducted according to the message category and the target language will be used.
25 |      *
26 |      * You can add parameters to a translation message that will be substituted with the corresponding value after
27 |      * translation. The format for this is to use curly brackets around the parameter name as you can see in the following example:
28 |      *
29 |      * ```php
30 |      * $username = 'Alexander';
31 |      * echo \Yii::t('app', 'Hello, {username}!', ['username' => $username]);
32 |      * ```
33 |      *
34 |      * Further formatting of message parameters is supported using the [PHP intl extensions](http://www.php.net/manual/en/intro.intl.php)
35 |      * message formatter. See [[\yii\i18n\I18N::translate()]] for more details.
36 |      *
37 |      * @param string $category the message category.
38 |      * @param string $message the message to be translated.
39 |      * @param array $params the parameters that will be used to replace the corresponding placeholders in the message.
40 |      * @param string $language the language code (e.g. `en-US`, `en`). If this is null, the current
41 |      * [[\yii\base\Application::language|application language]] will be used.
42 |      *
43 |      * @return string the translated message.
44 |      */
45 |     public static function t($category, $message, $params = [], $language = null)
46 |     {
47 |         return Yii::t('funson86/' . $category, $message, $params, $language);
48 |     }
49 | 
50 |     /**
51 |      * Check if module is used for backend application.
52 |      *
53 |      * @return boolean true if it's used for backend application
54 |      */
55 |     public function getIsBackend()
56 |     {
57 |         if ($this->_isBackend === null) {
58 |             $this->_isBackend = strpos($this->controllerNamespace, 'backend') === false ? false : true;
59 |         }
60 | 
61 |         return $this->_isBackend;
62 |     }
63 | }
64 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Yii2 Setting
 2 | =========
 3 | Yii2 Setting for other application, especially for [Yii2 Adminlte](https://github.com/funson86/yii2-adminlte)
 4 | 
 5 | Installation
 6 | ------------
 7 | 
 8 | The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
 9 | 
10 | Either run
11 | 
12 | ```
13 | php composer.phar require funson86/yii2-setting "*"
14 | ```
15 | 
16 | or add
17 | 
18 | ```
19 | "funson86/yii2-setting": "*"
20 | ```
21 | 
22 | to the require section of your `composer.json` file.
23 | 
24 | 
25 | Usage
26 | -----
27 | 
28 | Once the extension is installed, simply use it in your code by  :
29 | 
30 | ### Migration
31 | 
32 | Migration run
33 | 
34 | ```php
35 | yii migrate --migrationPath=@funson86/setting/migrations
36 | ```
37 | 
38 | ### Config /common/config/main.php to use Yii::$app->setting
39 | ```php
40 |     'components' => [
41 |         'setting' => [
42 |             'class' => 'funson86\setting\Setting',
43 |         ],
44 |     ],
45 | ```
46 | 
47 | ### Config backend modules in backend/config/main.php to manage settings
48 | 
49 | ```php
50 |     'modules' => [
51 |         'setting' => [
52 |             'class' => 'funson86\setting\Module',
53 |             'controllerNamespace' => 'funson86\setting\controllers'
54 |         ],
55 |     ],
56 | ```
57 | 
58 | 
59 | ### Config at backend
60 | backend : http://you-domain/backend/web/setting
61 | 
62 | ### Add Your Setting
63 | Setting support 3 type of setting: text, password, select.
64 | You could add your setting by migration or insert to table `setting` manually.
65 | ```php
66 | INSERT INTO `setting` (`id`, `parent_id`, `code`, `type`, `store_range`, `store_dir`, `value`, `sort_order`) VALUES
67 | (11, 0, 'info', 'group', '', '', '', '50'),
68 | (21, 0, 'basic', 'group', '', '', '', '50'),
69 | (31, 0, 'smtp', 'group', '', '', '', '50'),
70 | (1111, 11, 'siteName', 'text', '', '', 'Your Site', '50'),
71 | (1112, 11, 'siteTitle', 'text', '', '', 'Your Site Title', '50'),
72 | (1113, 11, 'siteKeyword', 'text', '', '', 'Your Site Keyword', '50'),
73 | (2111, 21, 'timezone', 'select', '-12,-11,-10,-9,-8,-7,-6,-5,-4,-3.5,-3,-2,-1,0,1,2,3,3.5,4,4.5,5,5.5,5.75,6,6.5,7,8,9,9.5,10,11,12', '', '8', '50'),
74 | (2112, 21, 'commentCheck', 'select', '0,1', '', '1', '50'),
75 | (3111, 31, 'smtpHost', 'text', '', '', 'localhost', '50'),
76 | (3112, 31, 'smtpPort', 'text', '', '', '', '50'),
77 | (3113, 31, 'smtpUser', 'text', '', '', '', '50'),
78 | (3114, 31, 'smtpPassword', 'password', '', '', '', '50'),
79 | (3115, 31, 'smtpMail', 'text', '', '', '', '50');
80 | ```
81 | 
82 | ### Use Your Setting
83 | Once you set the value at the backend. Simply access your setting by the following code:
84 | 
85 | ```php
86 | echo Yii::$app->setting->get('siteName');
87 | ```
88 | 
89 | Preview:
90 | -------
91 | ![Yii2-Setting](yii2-setting-preview.png)
92 | 


--------------------------------------------------------------------------------
/Setting.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace funson86\setting;
 4 | use Yii;
 5 | 
 6 | class Setting extends \yii\base\Component
 7 | {
 8 |     public function get($code)
 9 |     {
10 |         if(!$code) return ;
11 | 
12 |         $setting = \funson86\setting\models\Setting::find()->where(['code' => $code])->one();
13 | 
14 |         if($setting)
15 |             return $setting->value;
16 |         else
17 |             return ;
18 |     }
19 | 
20 | }
21 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "funson86/yii2-setting",
 3 |     "description": "Yii2 Setting for other application",
 4 |     "type": "yii2-extension",
 5 |     "keywords": ["yii2","extension","setting"],
 6 |     "license": "Apache-2.0",
 7 |     "authors": [
 8 |         {
 9 |             "name": "Funson Lee",
10 |             "email": "funson86@gmail.com"
11 |         }
12 |     ],
13 |     "require": {
14 |         "yiisoft/yii2": "*"
15 |     },
16 |     "autoload": {
17 |         "psr-4": {
18 |             "funson86\\setting\\": ""
19 |         }
20 |     },
21 |     "extra": {
22 |         "bootstrap": "funson86\\setting\\Bootstrap"
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------
/controllers/DefaultController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace funson86\setting\controllers;
 4 | 
 5 | use funson86\setting\models\Setting;
 6 | use yii\filters\VerbFilter;
 7 | use yii\filters\AccessControl;
 8 | use yii\web\Controller;
 9 | use Yii;
10 | 
11 | class DefaultController extends Controller
12 | {
13 |     public function behaviors()
14 |     {
15 |         return [
16 |             'verbs' => [
17 |                 'class' => VerbFilter::className(),
18 |                 'actions' => [
19 |                     'delete' => ['post'],
20 |                 ],
21 |             ],
22 |             'access' => [
23 |                 'class' => AccessControl::className(),
24 |                 'rules' => [
25 |                     [
26 |                         'allow' => true,
27 |                         'roles' => ['@']
28 |                     ]
29 |                 ]
30 |             ],
31 |         ];
32 |     }
33 | 
34 |     public function actionIndex()
35 |     {
36 |         //if(!Yii::$app->user->can('readPost')) throw new HttpException(403, 'No Auth');
37 | 
38 |         if(Yii::$app->request->isPost)
39 |         {
40 |             $setting = Yii::$app->request->post('Setting');
41 |             foreach($setting as $key => $value) {
42 |                 Setting::updateAll(['value' => $value], ['code' => $key]);
43 |             }
44 |         }
45 | 
46 |         $settingParent = Setting::find()->where(['parent_id' => 0])->orderBy(['sort_order' => SORT_ASC])->all();
47 |         return $this->render('index', [
48 |             'settingParent' => $settingParent,
49 |         ]);
50 |     }
51 | }
52 | 


--------------------------------------------------------------------------------
/messages/en/setting.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 |     'Create ' => 'Create ',
 5 |     'Create' => 'Create',
 6 |     'Update ' => 'Update ',
 7 |     'Update' => 'Update',
 8 |     'Delete' => 'Delete',
 9 | 
10 |     'Setting' => 'Setting',
11 | 
12 |     'info' => 'Info',
13 |     'basic' => 'Basic',
14 |     'smtp' => 'SMTP',
15 | 
16 |     'siteName' => 'Site Name',
17 |     'siteTitle' => 'Site Title',
18 |     'siteKeyword' => 'Site Keyword',
19 | 
20 |     'timezone' => 'Time Zone',
21 |     'commentCheck' => 'Comment Check',
22 | 
23 |     'smtpHost' => 'SMTP Host',
24 |     'smtpPort' => 'SMTP Port',
25 |     'smtpUser' => 'SMTP User',
26 |     'smtpPassword' => 'SMTP Password',
27 |     'smtpMail' => 'SMTP Mail',
28 | 
29 | ];
30 | 


--------------------------------------------------------------------------------
/messages/zh-CN/setting.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 |     'Create ' => '创建',
 5 |     'Create' => '创建',
 6 |     'Update ' => '更新',
 7 |     'Update' => '更新',
 8 |     'Delete' => '删除',
 9 | 
10 |     'Setting' => '设置',
11 | 
12 |     'info' => '站点',
13 |     'basic' => '基本',
14 |     'smtp' => 'SMTP',
15 | 
16 |     'siteName' => '站点名称',
17 |     'siteTitle' => '站点标题',
18 |     'siteKeyword' => '站点关键字',
19 | 
20 |     'timezone' => '时区',
21 |     'commentCheck' => '评论审核',
22 | 
23 |     'smtpHost' => '服务器',
24 |     'smtpPort' => '端口',
25 |     'smtpUser' => '用户名',
26 |     'smtpPassword' => '密码',
27 |     'smtpMail' => '显示地址',
28 | 
29 | ];
30 | 


--------------------------------------------------------------------------------
/migrations/m141208_201488_setting_init.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use yii\db\Migration;
 4 | use yii\db\Schema;
 5 | 
 6 | /**
 7 |  * CLass m141208_201480_blog_init
 8 |  * @package funson86\blog\migrations
 9 |  *
10 |  * Create blog tables.
11 |  *
12 |  * Will be created 4 tables:
13 |  * - `{{%blog_catalog}}` - Blog catalog
14 |  * - `{{%blog_post}}` -
15 |  * - `{{%blog_comment}}` -
16 |  * - `{{%blog_tag}}` -
17 |  */
18 | class m141208_201488_setting_init extends Migration
19 | {
20 |     /**
21 |      * @inheritdoc
22 |      */
23 |     public function up()
24 |     {
25 |         // MySql table options
26 |         $tableOptions = 'CHARACTER SET utf8 COLLATE utf8_general_ci ENGINE=InnoDB';
27 | 
28 |         // table blog_catalog
29 |         $this->createTable(
30 |             '{{%setting}}',
31 |             [
32 |                 'id' => Schema::TYPE_PK,
33 |                 'parent_id' => Schema::TYPE_INTEGER . ' NOT NULL DEFAULT 0',
34 |                 'code' => Schema::TYPE_STRING . '(32) NOT NULL',
35 |                 'type' => Schema::TYPE_STRING . '(32) NOT NULL',
36 |                 'store_range' => Schema::TYPE_STRING . '(255)',
37 |                 'store_dir' => Schema::TYPE_STRING . '(255)',
38 |                 'value' => Schema::TYPE_TEXT . '',
39 |                 'sort_order' => Schema::TYPE_INTEGER . ' NOT NULL DEFAULT 50',
40 |             ],
41 |             $tableOptions
42 |         );
43 | 
44 |         // Indexes
45 |         $this->createIndex('parent_id', '{{%setting}}', 'parent_id');
46 |         $this->createIndex('code', '{{%setting}}', 'code');
47 |         $this->createIndex('sort_order', '{{%setting}}', 'sort_order');
48 | 
49 |         // Add default setting
50 |         $this->execute($this->getSettingSql());
51 |     }
52 | 
53 |     /**
54 |      * @return string SQL to insert first user
55 |      */
56 |     private function getSettingSql()
57 |     {
58 |         return "INSERT INTO {{%setting}} (`id`, `parent_id`, `code`, `type`, `store_range`, `store_dir`, `value`, `sort_order`) VALUES
59 |                 (11, 0, 'info', 'group', '', '', '', '50'),
60 |                 (21, 0, 'basic', 'group', '', '', '', '50'),
61 |                 (31, 0, 'smtp', 'group', '', '', '', '50'),
62 |                 (1111, 11, 'siteName', 'text', '', '', 'Your Site', '50'),
63 |                 (1112, 11, 'siteTitle', 'text', '', '', 'Your Site Title', '50'),
64 |                 (1113, 11, 'siteKeyword', 'text', '', '', 'Your Site Keyword', '50'),
65 |                 (2111, 21, 'timezone', 'select', '-12,-11,-10,-9,-8,-7,-6,-5,-4,-3.5,-3,-2,-1,0,1,2,3,3.5,4,4.5,5,5.5,5.75,6,6.5,7,8,9,9.5,10,11,12', '', '8', '50'),
66 |                 (2112, 21, 'commentCheck', 'select', '0,1', '', '1', '50'),
67 |                 (3111, 31, 'smtpHost', 'text', '', '', 'localhost', '50'),
68 |                 (3112, 31, 'smtpPort', 'text', '', '', '', '50'),
69 |                 (3113, 31, 'smtpUser', 'text', '', '', '', '50'),
70 |                 (3114, 31, 'smtpPassword', 'password', '', '', '', '50'),
71 |                 (3115, 31, 'smtpMail', 'text', '', '', '', '50')
72 |                 ";
73 |     }
74 | 
75 |     /**
76 |      * @inheritdoc
77 |      */
78 |     public function down()
79 |     {
80 |         $this->dropTable('{{%setting}}');
81 |     }
82 | }
83 | 


--------------------------------------------------------------------------------
/models/Setting.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace funson86\setting\models;
 4 | 
 5 | use Yii;
 6 | use funson86\setting\Module;
 7 | 
 8 | /**
 9 |  * This is the model class for table "setting".
10 |  *
11 |  * @property integer $id
12 |  * @property integer $parent_id
13 |  * @property string $code
14 |  * @property string $type
15 |  * @property string $store_range
16 |  * @property string $store_dir
17 |  * @property string $value
18 |  * @property integer $sort_order
19 |  */
20 | class Setting extends \yii\db\ActiveRecord
21 | {
22 |     /**
23 |      * @inheritdoc
24 |      */
25 |     public static function tableName()
26 |     {
27 |         return '{{%setting}}';
28 |     }
29 | 
30 |     /**
31 |      * @inheritdoc
32 |      */
33 |     public function rules()
34 |     {
35 |         return [
36 |             [['parent_id', 'sort_order'], 'integer'],
37 |             [['code', 'type'], 'required'],
38 |             [['value'], 'string'],
39 |             [['code', 'type'], 'string', 'max' => 32],
40 |             [['store_range', 'store_dir'], 'string', 'max' => 255]
41 |         ];
42 |     }
43 | 
44 |     /**
45 |      * @inheritdoc
46 |      */
47 |     public function attributeLabels()
48 |     {
49 |         return [
50 |             'id' => Module::t('setting', 'ID'),
51 |             'parent_id' => Module::t('setting', 'Parent ID'),
52 |             'code' => Module::t('setting', 'Code'),
53 |             'type' => Module::t('setting', 'Type'),
54 |             'store_range' => Module::t('setting', 'Store Range'),
55 |             'store_dir' => Module::t('setting', 'Store Dir'),
56 |             'value' => Module::t('setting', 'Value'),
57 |             'sort_order' => Module::t('setting', 'Sort Order'),
58 |         ];
59 |     }
60 | }
61 | 


--------------------------------------------------------------------------------
/views/default/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | use yii\helpers\Html;
 3 | use yii\widgets\ActiveForm;
 4 | use yii\helpers\ArrayHelper;
 5 | use funson86\setting\models\Setting;
 6 | use funson86\setting\Module;
 7 | 
 8 | $this->title = Module::t('setting', 'Setting');
 9 | $this->params['breadcrumbs'][] = $this->title;
10 | 
11 | $items = [];
12 | foreach ($settingParent as $parent) {
13 |     $item['label'] = Module::t('setting', $parent->code);
14 | 
15 |     $str = '';
16 |     $children = Setting::find()->where(['parent_id' => $parent->id])->orderBy(['sort_order' => SORT_ASC, 'id' => SORT_ASC])->all();
17 |     foreach ($children as $child) {
18 |         $str .= '<div class="form-group field-blogcatalog-parent_id"><label class="col-lg-2 control-label" for="blogcatalog-parent_id">' . Module::t('setting', $child->code) . '</label><div class="col-lg-3">';
19 | 
20 |         if ($child->type == 'text')
21 |             $str .= Html::textInput("Setting[$child->code]", $child->value, ["class" => "form-control"]);
22 |         elseif ($child->type == 'password')
23 |             $str .= Html::passwordInput("Setting[$child->code]", $child->value, ["class" => "form-control"]);
24 |         elseif ($child->type == 'select') {
25 |             $options = [];
26 |             $arrayOptions = explode(',', $child->store_range);
27 |             foreach ($arrayOptions as $option)
28 |                 $options[$option] = Module::t('setting', $option);
29 | 
30 |             $str .= Html::dropDownList("Setting[$child->code]", $child->value, $options, ["class" => "form-control"]);
31 |         }
32 | 
33 |         $str .= '</div></div>';
34 |     }
35 |     $item['content'] = $str;
36 | 
37 |     array_push($items, $item);
38 | }
39 | 
40 | ?>
41 | 
42 | <style>
43 | .tab-pane {padding-top: 20px;}
44 | </style>
45 | 
46 | <div class="setting-form">
47 |     <?php $form = ActiveForm::begin([
48 |         'id' => 'setting-form',
49 |         'options' => ['class' => 'form-horizontal'],
50 |         'fieldConfig' => [
51 |             'template' => "{label}\n<div class=\"col-lg-3\">{input}{hint}</div>\n<div class=\"col-lg-5\">{error}</div>",
52 |             'labelOptions' => ['class' => 'col-lg-2 control-label'],
53 |         ],
54 |     ]); ?>
55 | 
56 |     <?php
57 |     echo \yii\bootstrap\Tabs::widget([
58 |         'items' => $items,
59 |         'options' => ['tag' => 'div'],
60 |         'itemOptions' => ['tag' => 'div'],
61 |         'headerOptions' => ['class' => 'my-class'],
62 |         'clientOptions' => ['collapsible' => false],
63 |     ]);
64 |     ?>
65 | 
66 |     <div class="form-group">
67 |         <label class="col-lg-2 control-label" for="">&nbsp;</label>
68 |         <?= Html::submitButton(Module::t('setting', 'Update'), ['class' => 'btn btn-primary']) ?>
69 |     </div>
70 | 
71 |     <?php ActiveForm::end(); ?>
72 | 
73 | </div>
74 | 


--------------------------------------------------------------------------------
/yii2-setting-preview.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/funson86/yii2-setting/16ffd652e376a688718f465c090db461a1e1a8a0/yii2-setting-preview.png


--------------------------------------------------------------------------------