Yii - 配置

配置用于创建新对象或初始化现有对象。配置通常包括类名和初始值列表。它们还可能包括事件处理程序和行为列表。

以下是数据库配置的示例 −

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

Yii::createObject() 方法接受一个配置数组，并根据配置中指定的类创建一个对象。

配置的格式 −

[
    //正在创建对象的完全限定类名
    'class' => 'ClassName',
    //命名属性的初始值
    'propertyName' => 'propertyValue',
    //指定应将哪些处理程序附加到对象的事件
    'on eventName' => $eventHandler,
    //指定应将哪些行为附加到对象
    'as behaviorName' => $behaviorConfig,
]

基本应用程序模板的配置文件是最复杂的配置文件之一 −

<?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',
            // 默认将所有邮件发送到一个文件。您必须设置
            // 'useFileTransport' 为 false 并配置传输
            // 以便邮件程序发送真实的电子邮件。
            '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) {
      // 针对"dev"环境的配置调整
      $config['bootstrap'][] = 'debug';
      $config['modules']['debug'] = [
         'class' => 'yii\debug\Module',
      ];
      $config['bootstrap'][] = 'gii';
      $config['modules']['gii'] = [
         'class' => 'yii\gii\Module',
      ];
   }
   return $config;
?>

在上面的配置文件中，我们没有定义类名。这是因为我们已经在 index.php 文件中定义了它 −

<?php
    //定义全局常量
    defined('YII_DEBUG') or define('YII_DEBUG', true);
    defined('YII_ENV') or define('YII_ENV', 'dev');
    //注册 composer 自动加载器
    require(__DIR__ . '/../vendor/autoload.php');
    //包含 yii 文件
    require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');
    //加载应用程序配置
    $config = require(__DIR__ . '/../config/web.php');
    //创建、配置和处理请求
    (new yii\web\Application($config))->run();
?>

许多小部件也使用配置，如以下代码所示。

<?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();
?>

当配置过于复杂时，常见的做法是创建一个 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() 方法指定默认配置。它允许您在通过 Yii::createObject() 方法调用指定类的所有实例时应用默认配置。

例如，要自定义 yii\widgets\LinkPager 类，以便所有链接分页器最多显示三个按钮，您可以使用以下代码。

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