Yii2 模块参数的正确配置与访问指南

namespace app\modules\payment;

use yii\base\Module;

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

        // 尝试加载一个外部配置
        // 这种方式可能导致参数无法按预期访问
        \Yii::configure($this, require __DIR__ . '/config/main.php');
    }
}

<?php

$params = [
    'data' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
    // 其他模块专属参数...
];

if (YII_ENV == 'dev') {
    // 在开发环境下合并公共参数和本地参数
    $params = array_merge(
        require __DIR__ . '/../../../../common/config/params.php',
        require __DIR__ . '/../../../../common/config/params-local.php',
        $params, // 将模块自身参数放在最后，确保优先级
        require __DIR__ . '/params.php' // 假设存在一个模块自己的params.php
    );
} else {
    // 生产环境下合并公共参数
    $params = array_merge(
        require __DIR__ . '/../../../../common/config/params.php',
        $params,
        require __DIR__ . '/params.php'
    );
}

return [
    'params' => $params,
];

namespace app\controllers;

use yii\web\Controller;
use Yii;

class SiteController extends Controller
{
    public function actionIndex()
    {
        // 尝试访问模块参数，可能报错 "Undefined array key "data""
        dd(Yii::$app->getModule('payment')->params['data']);
    }
}

namespace app\modules\payment;

use yii\base\Module;

class Module extends Module
{
    /**
     * @var array 模块的专属参数
     */
    public $params = []; // 声明一个公共属性用于存储模块参数

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

        // 在这里初始化或合并模块参数
        // 例如，直接赋值或加载配置文件并合并
        $this->params = [
            'data' => [
                'api_key' => 'your_module_api_key',
                'endpoint' => 'https://api.example.com/payment',
            ],
            'currency' => 'USD',
            // ... 其他模块参数
        ];

        // 示例：如果需要从外部文件加载并合并参数
        // 注意：这里加载的配置文件应该直接返回参数数组，而不是包裹在 ['params' => ...] 中
        $moduleSpecificParams = require __DIR__ . '/config/params.php'; // 假设这个文件直接返回参数数组
        $this->params = array_merge($this->params, $moduleSpecificParams);

        // 如果需要像应用级参数那样合并公共和环境参数
        // 这种合并逻辑应该放在 $this->params 赋值之前或合并到 $this->params 中
        $commonParams = require Yii::getAlias('@common/config/params.php');
        $localParams = file_exists(Yii::getAlias('@common/config/params-local.php')) ? require Yii::getAlias('@common/config/params-local.php') : [];

        $mergedParams = array_merge($commonParams, $localParams, $this->params);
        $this->params = $mergedParams; // 最终将合并后的参数赋值给模块的 $params 属性
    }
}

<?php
// 这个文件应该直接返回参数数组，而不是包裹在 ['params' => ...] 中
return [
    'setting1' => 'value1',
    'setting2' => 'value2',
    'data' => [
        'additional_info' => 'some_data'
    ]
];

namespace app\controllers;

use yii\web\Controller;
use Yii;

class SiteController extends Controller
{
    public function actionModuleParams()
    {
        // 获取 'payment' 模块实例
        $paymentModule = Yii::$app->getModule('payment');

        if ($paymentModule) {
            // 访问模块的 'data' 参数
            $moduleData = $paymentModule->params['data'];
            echo "Module API Key: " . $moduleData['api_key'] . "<br>";
            echo "Module Endpoint: " . $moduleData['endpoint'] . "<br>";
            echo "Module Currency: " . $paymentModule->params['currency'] . "<br>";
        } else {
            echo "Payment module not found.";
        }
        exit;
    }
}