Yii2模块参数配置指南：正确声明与访问模块级配置

// modules/your_module/config/main.php (错误的用法示例)
$params = [
    'data' => [
        'item1' => 'value1',
        'item2' => 'value2',
    ],
    // ... 其他模块参数
];

// 根据环境合并通用参数
if (YII_ENV == 'dev') {
    $params = array_merge(
        require __DIR__ . '/../../../../common/config/params.php',
        require __DIR__ . '/../../../../common/config/params-local.php',
        $params // 将模块特定参数合并到 $params 变量
    );
} else {
    $params = array_merge(
        require __DIR__ . '/../../../../common/config/params.php',
        $params
    );
}

return [
    'params' => $params, // 这里的 'params' 键是问题所在
];

// modules/your_module/Module.php
namespace app\modules\your_module;

class Module extends \yii\base\Module
{
    /**
     * {@inheritdoc}
     */
    public function init()
    {
        parent::init();

        // 尝试加载配置
        \Yii::configure($this, require __DIR__ . '/config/main.php');
    }
}

// app/controllers/SiteController.php (或模块内控制器)
namespace app\controllers;

use Yii;
use yii\web\Controller;

class SiteController extends Controller
{
    public function actionIndex()
    {
        // 尝试访问模块参数，假设模块ID是 'payment'
        dd(Yii::$app->getModule('payment')->params['data']);
        // 此时会抛出 "Undefined array key "data"" 错误
    }
}

// modules/your_module/Module.php
namespace app\modules\your_module;

class Module extends \yii\base\Module
{
    /**
     * 模块特有的参数数组
     * @var array
     */
    public $params = []; // 声明公共 $params 属性

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

        // 加载模块参数配置文件
        // 确保配置文件直接返回参数数组
        $moduleParams = require __DIR__ . '/config/params.php';

        // 将加载的参数合并到模块的 $params 属性中
        $this->params = array_merge($this->params, $moduleParams);

        // 或者，如果配置文件本身就返回一个完整的配置数组，
        // 并且其中包含 'params' 键，可以这样：
        // Yii::configure($this, ['params' => $moduleParams]);
        // 但为了避免混淆，直接将 $moduleParams 合并到 $this->params 更清晰。
    }
}

// modules/your_module/config/params.php
$moduleParams = [
    'data' => [
        'api_key' => 'your_module_api_key',
        'endpoint' => 'https://api.yourmodule.com',
    ],
    'setting_a' => 'value_a',
];

// 可以根据环境合并通用参数或本地参数
if (YII_ENV == 'dev') {
    $moduleParams = array_merge(
        require __DIR__ . '/../../../../common/config/params.php', // 通用参数
        require __DIR__ . '/../../../../common/config/params-local.php', // 本地通用参数
        $moduleParams // 模块特定参数放在最后，以覆盖同名键
    );
} else {
    $moduleParams = array_merge(
        require __DIR__ . '/../../../../common/config/params.php',
        $moduleParams
    );
}

return $moduleParams; // 直接返回参数数组

// 控制器中
namespace app\controllers;

use Yii;
use yii\web\Controller;

class SiteController extends Controller
{
    public function actionIndex()
    {
        $paymentModule = Yii::$app->getModule('payment'); // 假设你的模块ID是 'payment'
        if ($paymentModule) {
            $apiKey = $paymentModule->params['data']['api_key'];
            $endpoint = $paymentModule->params['data']['endpoint'];
            echo "API Key: " . $apiKey . "<br>";
            echo "Endpoint: " . $endpoint . "<br>";