Yii2 模块参数配置与访问深度指南

<?php

namespace app\modules\payment;

use yii\base\Module as BaseModule;

/**
 * payment module definition class
 */
class Module extends BaseModule
{
    /**
     * @var array 模块参数
     */
    public $params = [];

    /**
     * {@inheritdoc}
     */
    public function init()
    {
        parent::init();

        // 在这里定义或初始化模块参数
        $this->params = [
            'data' => [
                'apiKey' => 'your_payment_api_key',
                'gatewayUrl' => 'https://api.payment.com',
                'currency' => 'USD',
            ],
            'settings' => [
                'debugMode' => YII_ENV_DEV,
            ],
        ];

        // 可以在这里根据环境进一步调整参数
        if (YII_ENV_DEV) {
            $this->params['data']['testMode'] = true;
        }

        // custom initialization code goes here
    }
}

<?php

namespace app\modules\payment\controllers;

use yii\web\Controller;
use Yii;

class DefaultController extends Controller
{
    public function actionIndex()
    {
        // 访问 payment 模块的 'data' 参数
        $paymentData = Yii::$app->getModule('payment')->params['data'];

        // 访问其中的特定键
        $apiKey = $paymentData['apiKey']; // 'your_payment_api_key'

        // 打印所有 payment 模块参数
        // dd(Yii::$app->getModule('payment')->params);

        return $this->render('index', [
            'apiKey' => $apiKey,
            'paymentData' => $paymentData,
        ]);
    }
}

<?php

namespace app\modules\payment;

use yii\base\Module as BaseModule;
use Yii;

/**
 * payment module definition class
 */
class Module extends BaseModule
{
    /**
     * @var array 模块参数
     */
    public $params = []; // 声明公共属性，以便 \Yii::configure 可以设置它

    /**
     * {@inheritdoc}
     */
    public function init()
    {
        parent::init();

        // 加载模块的配置文件
        // 这里的配置文件应返回一个包含 'params' 键的数组，例如 ['params' => [...]]
        \Yii::configure($this, require __DIR__ . '/config/main.php');

        // custom initialization code goes here
    }
}

<?php
// modules/payment/config/main.php

// 定义模块专属参数
$moduleParams = require __DIR__ . '/params.php';

// 根据环境合并公共参数和模块专属参数
if (YII_ENV_DEV) {
    $commonParams = array_merge(
        require __DIR__ . '/../../../../common/config/params.php',
        require __DIR__ . '/../../../../common/config/params-local.php'
    );
} else {
    $commonParams = require __DIR__ . '/../../../../common/config/params.php';
}

// 合并公共参数和模块参数。
// 注意合并顺序：模块参数通常应在最后合并，以允许其覆盖公共参数中同名的配置。
$params = array_merge($commonParams, $moduleParams);

return [
    'params' => $params,
    // 这里还可以配置模块的其他属性，例如 components, controllerMap 等
    // 'components' => [
    //     'paymentService' => [
    //         'class' => 'app\modules\payment\components\PaymentService',
    //     ],
    // ],
];

<?php
// modules/payment/config/params.php

return [
    'data' => [
        'apiKey' => 'module_specific_api_key',
        'gatewayUrl' => 'https://module.payment.com',
        'currency' => 'EUR',
    ],
    'settings' => [
        'logRequests' => true,
        'timeout' => 30,
    ],
    // 其他模块专属参数...
];

// 示例合并顺序：
// 1. 公共参数 (common/config/params.php)
// 2. 本地公共参数 (common/config/params-local.php) - 仅开发环境
// 3. 模块专属参数 (modules/payment/config/params.php)
$params = array_merge(
    $commonParams, // 基础公共参数
    $moduleParams  // 模块专属参数，可以覆盖公共参数
);

// 在控制器中
public function actionViewPaymentConfig()
{
    $moduleParams = Yii::$app->getModule('payment')->params;
    // dd($moduleParams); // 调试查看所有参数

    $apiKey = $moduleParams['data']['apiKey']; // 'module_specific_api_key' (如果被模块自己的params.php覆盖)
    $currency = $moduleParams['data']['currency']; // 'EUR'
    $logRequests = $moduleParams['settings']['logRequests']; // true

    // ...
}