Yii2.0源码分析之——主题(Theme)

主题功能大家并不陌生，在Yii中同样也提供了主题功能。

原文链接：
首先看看主要的配置方式：

'components' => [
    'view' => [
        'theme' => [
            'pathMap' => ['@app/views' => '@app/themes/basic'],
            'baseUrl' => '@web/themes/basic',
        ],
    ],
],

Yii中的主题功能主要由yii\base\Theme类来实现，它的主要思想是：先定义好一个一一对应的字符串映射数组，然后对给定的字符串按照数组中的映射关系进行字符串替换。
有如下映射：

$pathMap=[
        '@app/a' => '@app/aaa',
        '@app/b' => '@app/bbb',
        '@app/c' => [
                '@app/ccc/xxx',
                '@app/ccc/yyy',
            ],
];

对字符串 @app/a/site/index.php，由上面的映射关系可知会把@app/a替换为@app/aaa，生成结果为@app/aaa/site/index.php。
但要注意，这个还不是最终的结果。由于在Yii中是对文件路径的操作，所以如果@app/aaa/site/index.php这个文件存在的话，则会返回这个路径，否则返回原路径即：@app/a/site/index.php

如果有字符串@app/c/site/index.php，由于上面的映射知道@app/c对应2个替换项，Yii会从前开始依次替换，先生成@app/ccc/xxx/site/index.php，如果这个文件存在，则返回这个路径，否则继续替换。
如果所有的替换结果都不存在对应的文件，那么最后返回原路径。

同时写多个替换的目标值有这么一个好处：实现主题的继承。
现在有一套默认的主题default，如果现在要增加一套黑色的主题，有两个办法可以实现。

• 第一种：把所有的default中的视图全部复制一份到blank目录中。
• 第二种：只复制一份layout布局文件到blank目录中，然后在布局文件中修改整体颜色。然后设置为
  

  $pathMap=[
          '@app/c' => [
                  '@app/ccc/blank',
                  '@app/ccc/default',
              ],
  ];

  
  

主题中的属性：

• $pathMap：这个就是用来设置替换映射关系的。
  1. 'pathMap' =>[
     
  2.         '@app/views' => [
     
  3.                 '@app/themes/blank',
     
  4.                 '@app/themes/default',
     
  5.         ],
     
  6.         '@app/modules' => '@app/themes/default/modules',
     
  7.         '@app/widgets' => '@app/themes/default/widgets'
     
  8. ],

  复制代码
  这三个分别对views、modules和widgets应用主题。
• $baseUrl：这个用来设置要访问的资源的url（结尾不加“/”）
• $basePath：设置资源所在的文件目录

主题中的方法：

public function init()

$pathMap=[
        '@app/a' => '@app/aaa',
        '@app/b' => '@app/bbb',
        '@app/c' => [
                '@app/ccc/xxx',
                '@app/ccc/yyy',
            ],
];

public function init()
{
        parent::init();

        //如果没有设置$pathMap映射，则使用$basePath，
        if (empty($this->pathMap)) {
                /*
                 * 如果$basePath也没有设置，则出异常。
                 * 也就是说 $pathMap和$basePath至少要设置一个，如果两个都设置了，优先使用$pathMap
                 */
            if (($basePath = $this->getBasePath()) === null) {
                throw new InvalidConfigException('The "basePath" property must be set.');
            }
            //设置当前模块的路径和$basePath的映射关系
            $this->pathMap = [Yii::$app->getBasePath() => [$basePath]];
        }
}

public function applyTo($path)

//这个就是按照 $pathMap中的定义的映射关系来对$path进行替换字符串的
public function applyTo($path)
{
        //对路径中的"/"、“\”进行统一替换
        $path = FileHelper::normalizePath($path);
        foreach ($this->pathMap as $from => $tos) {

             //映射数组中的来源（旧值）
            $from = FileHelper::normalizePath(Yii::getAlias($from)) . DIRECTORY_SEPARATOR;

            //如果在$path中有可替换的旧值
            if (strpos($path, $from) === 0) {
                $n = strlen($from);

                //对目标值循环，
                foreach ((array) $tos as $to) {
                    $to = FileHelper::normalizePath(Yii::getAlias($to)) . DIRECTORY_SEPARATOR;
                    //把$path中的$from替换为$to
                    $file = $to . substr($path, $n);

                    //如果是文件，直接返回
                    if (is_file($file)) {
                        return $file;
                    }
                }
            }
        }

        return $path;
}