پیکربندی یا Configuration ها در فریمورک Yii

از Configuration ها یا پیکربندی ها، برای ایجاد اشیاء جدید یا مقداردهی اولیه (initializing) آن ها استفاده می شود. Configuration معمولاً شامل یک نام کلاس و یک لیستی از مقادیر اولیه است. آنها همچنین ممکن است شامل لیستی از event handler ها و behavior ها را نیز باشند.

در مثال زیر می توانید نمونه ای از پیکربندی پایگاه داده (database configuration) را مشاهده نمایید :

<?php
   $config = [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host = localhost;dbname = helloworld',
      'username' => 'vladimir',
      'password' => '12345',
      'charset' => 'utf8',
   ];
   $db = Yii::createObject($config);
?>

متد Yii::createObject() یک آرایه configuration را می گیرد و یک شی را بر اساس نام کلاس در  configurationایجاد می کند.

فرمت یک configuration :

[
   //a fully qualified class name for the object being created
   'class' => 'ClassName',
   //initial values for the named property
   'propertyName' => 'propertyValue',
   //specifies what handlers should be attached to the object's events
   'on eventName' => $eventHandler,
   //specifies what behaviors should be attached to the object
   'as behaviorName' => $behaviorConfig,
]

در یک قالبِ اپلیکیشنِ basic یا پایه، فایلِ configuration ، یکی از پیچیده ترین فایل هاست :

<?php
   $params = require(__DIR__ . '/params.php');
   $config = [
      'id' => 'basic',
      'basePath' => dirname(__DIR__),
      'bootstrap' => ['log'],
      'components' => [
         'request' => [
            // !!! insert a secret key in the following (if it is empty) - this 
               //is required by cookie validation
            'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO',
         ],
         'cache' => [
            'class' => 'yii\caching\FileCache',
         ],
         'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
         ],
         'errorHandler' => [
            'errorAction' => 'site/error',
         ],
         'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            // send all mails to a file by default. You have to set
            // 'useFileTransport' to false and configure a transport
            // for the mailer to send real emails.
            'useFileTransport' => true,
         ],
         'log' => [
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
               [
                  'class' => 'yii\log\FileTarget',
                  'levels' => ['error', 'warning'],
               ],
            ],
         ],
         'urlManager' => [
            //'showScriptName' => false,
            //'enablePrettyUrl' => true,
            //'enableStrictParsing' => true,
            //'suffix' => '/'
         ],
         'db' => require(__DIR__ . '/db.php'),
      ],
      'modules' => [
         'hello' => [
            'class' => 'app\modules\hello\Hello',
         ],
      ],
      'params' => $params,
   ];
   if (YII_ENV_DEV) {
      // configuration adjustments for 'dev' environment
      $config['bootstrap'][] = 'debug';
      $config['modules']['debug'] = [
         'class' => 'yii\debug\Module',
      ];
      $config['bootstrap'][] = 'gii';
      $config['modules']['gii'] = [
         'class' => 'yii\gii\Module',
      ];
   }
   return $config;
?>

همانطور که در فایل configuration فوق می بینید، نام کلاس را تعریف نکردیم. این به این دلیل است که ما قبلاً  آن را در فایل index.php تعریف نموده ایم :

<?php
   //defining global constans
   defined('YII_DEBUG') or define('YII_DEBUG', true);
   defined('YII_ENV') or define('YII_ENV', 'dev');
   //register composer autoloader
   require(__DIR__ . '/../vendor/autoload.php');
   //include yii files
   require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');
   //load application config
   $config = require(__DIR__ . '/../config/web.php');
   //create, config, and process request
   (new yii\web\Application($config))->run();
?>

همانطور که در کد زیر نشان داده شده است، بسیاری از widget ها از configurationها استفاده می کنند.

<?php
   NavBar::begin([
      'brandLabel' => 'My Company',
      'brandUrl' => Yii::$app->homeUrl,
      'options' => [
         'class' => 'navbar-inverse navbar-fixed-top',
      ],
   ]);
   echo Nav::widget([
      'options' => ['class' => 'navbar-nav navbar-right'],
      'items' => [
         ['label' => 'Home', 'url' => ['/site/index']],
         ['label' => 'About', 'url' => ['/site/about']],
         ['label' => 'Contact', 'url' => ['/site/contact']],
         Yii::$app->user->isGuest ?
         ['label' => 'Login', 'url' => ['/site/login']] :
         [
            'label' => 'Logout (' . Yii::$app->user->identity->username . ')',
            'url' => ['/site/logout'],
            'linkOptions' => ['data-method' => 'post']
         ],
      ],
   ]);
   NavBar::end();
?>

هنگامی که یک configuration بسیار پیچیده است، یک تمرین معمول، ساخت یک فایل php است که یک آرایه را بازگرداند. نگاهی به فایل پیکربندی config/console.php بیاندازید:

<?php
   Yii::setAlias('@tests', dirname(__DIR__) . '/tests');

 
   $params = require(__DIR__ . '/params.php');
   $db = require(__DIR__ . '/db.php');

 
   return [
      'id' => 'basic-console',
      'basePath' => dirname(__DIR__),
      'bootstrap' => ['log', 'gii'],
      'controllerNamespace' => 'app\commands',
      'modules' => [
         'gii' => 'yii\gii\Module',
      ],
      'components' => [
         'cache' => [
            'class' => 'yii\caching\FileCache',
         ],
         'log' => [
            'targets' => [
               [
                  'class' => 'yii\log\FileTarget',
                  'levels' => ['error', 'warning'],
               ],
            ],
         ],
         'db' => $db,
      ],
      'params' => $params,
   ];
?>

با فراخوانی متد Yii::$container->set() می توان، configurationهای پیش فرض را تعیین نمود. که به شما اجازه می دهد تا بتوانید configuration های پیش فرض را به تمام اشیاء ساخته شده از کلاس های معین، اعمال نمایید.البته این اتفاق زمانی می افتد که از طریق متد  Yii::createObject() فراخوانی شوند.

به عنوان مثال، برای سفارشی کردن کلاس yii\widgets\LinkPager ، به طوری که تمام لینکِ صفحات، در حداکثر سه Button نمایش داده شود، می توانید از کد زیر استفاده کنید.

\Yii::$container->set('yii\widgets\LinkPager', [
   'maxButtonCount' => 3,
]);