phuongdev89/yii2-setting

Yii2 Setting for other application

dev-master 2024-09-18 04:56 UTC

Requires

• ext-json: *
• bower-asset/awesome-bootstrap-checkbox: @dev
• insolita/yii2-iconpicker: @dev
• kartik-v/yii2-editable: @dev
• kartik-v/yii2-grid: @dev
• kartik-v/yii2-password: @dev
• kartik-v/yii2-tabs-x: @dev
• kartik-v/yii2-widgets: @dev
• phuongdev89/yii2-base: @dev
• phuongdev89/yii2-roxymce: @dev

MIT

• Funson Lee
• Pawel Kania
• Phuong Dev

• extension
• yii2
• setting

README

Yii2 Setting for other application

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require phuongdev89/yii2-setting "*"

or add

"phuongdev89/yii2-setting": "*"

to the require section of your composer.json file.

Usage

Once the extension is installed, simply use it in your code by :

Migration

Migration run

yii migrate --migrationPath=@phuongdev89/setting/migrations

Config /common/config/main.php to use Yii::$app->setting

    'components' => [
        'setting' => [
            'class' => 'phuongdev89\setting\Setting',
        ],
    ],

Config backend modules in backend/config/main.php to manage settings

    'modules'    => [
   		'setting'  => [
			'class'               => 'phuongdev89\setting\Module',
			'controllerNamespace' => 'phuongdev89\setting\controllers',
			'enableMultiLanguage' => false,//set true if phuongdev89/yii2-multi-language installed and want to translate setting
   		],
   		'gridview' => [
            'class' => '\kartik\grid\Module',
   		],
   		'roxymce'  => [
            'class' => '\phuongdev89\roxymce\Module',
   		],
    ],

Config at backend

backend : http://you-domain/backend/web/setting ####Attention:

• Store Range required if type in (select, multiselect, checkbox, radio), supported string with comma, json, callback function.
  Example:
  - String: 1,2,3 or A,bcd,ef
  - Json: {"0" : "abc", "1" : "def"}
  - Callback: app\helpers\ArrayHelper::getItems()
  Just create simple static function named getItems in app\helpers\ArrayHelper

namespace app\helpers;

class ArrayHeper {

   public static function getItems(){
       return [
           0     => "abc",
           1     => "def",
           "ghi" => 2,
       ];
   }

}

Use Your Setting

Once you set the value at the backend. Simply access your setting by the following code (auto-suggest code worked):

echo Yii::$app->setting->get('siteName');
echo Yii::$app->setting->siteName;