Yii2主題(Theme)用法詳解

字號:


    本文實例講述了Yii2主題(Theme)用法。分享給大家供大家參考,具體如下:
    首先看看主要的配置方式:
    'components' => [
      'view' => [
        'theme' => [
          'pathMap' => ['@app/views' => '@app/themes/basic'],
          'baseUrl' => '@web/themes/basic',
        ],
      ],
    ],
    Yii中的主題功能主要由yii\base\Theme類來實現(xiàn),它的主要思想是:先定義好一個一一對應(yīng)的字符串映射數(shù)組,然后對給定的字符串按照數(shù)組中的映射關(guān)系進行字符串替換。
    有如下映射:
    $pathMap=[
        '@app/a' => '@app/aaa',
        '@app/b' => '@app/bbb',
        '@app/c' => [
            '@app/ccc/xxx',
            '@app/ccc/yyy',
          ],
    ];
    對字符串 @app/a/site/index.php,由上面的映射關(guān)系可知會把@app/a替換為@app/aaa,生成結(jié)果為@app/aaa/site/index.php。
    但要注意,這個還不是最終的結(jié)果。由于在Yii中是對文件路徑的操作,所以如果@app/aaa/site/index.php這個文件存在的話,則會返回這個路徑,否則返回原路徑即:@app/a/site/index.php
    如果有字符串@app/c/site/index.php,由于上面的映射知道@app/c對應(yīng)2個替換項,Yii會從前開始依次替換,先生成@app/ccc/xxx/site/index.php,如果這個文件存在,則返回這個路徑,否則繼續(xù)替換。
    如果所有的替換結(jié)果都不存在對應(yīng)的文件,那么最后返回原路徑。
    同時寫多個替換的目標值有這么一個好處:實現(xiàn)主題的繼承。
    現(xiàn)在有一套默認的主題default,如果現(xiàn)在要增加一套黑色的主題,有兩個辦法可以實現(xiàn)。
    第一種:把所有的default中的視圖全部復(fù)制一份到blank目錄中。
    第二種:只復(fù)制一份layout布局文件到blank目錄中,然后在布局文件中修改整體顏色。然后設(shè)置為:
    $pathMap=[
        '@app/c' => [
            '@app/ccc/blank',
            '@app/ccc/default',
          ],
    ];
    好處看到了吧,如果在blank中沒有找到文件,會從default中來查找,也就是說blank中的文件會覆蓋default中存在的文件,從而實現(xiàn)了主題的繼承。
    主題中的屬性:
    $pathMap:這個就是用來設(shè)置替換映射關(guān)系的。
    'pathMap' =>[
        '@app/views' => [
            '@app/themes/blank',
            '@app/themes/default',
        ],
        '@app/modules' => '@app/themes/default/modules',
        '@app/widgets' => '@app/themes/default/widgets'
    ],
    這三個分別對views、modules和widgets應(yīng)用主題。
    $baseUrl:這個用來設(shè)置要訪問的資源的url(結(jié)尾不加“/”)
    $basePath:設(shè)置資源所在的文件目錄
    主題中的方法:
    public function init()
    {
        parent::init();
        //如果沒有設(shè)置$pathMap映射,則使用$basePath,
        if (empty($this->pathMap)) {
            /*
             * 如果$basePath也沒有設(shè)置,則出異常。
             * 也就是說 $pathMap和$basePath至少要設(shè)置一個,如果兩個都設(shè)置了,優(yōu)先使用$pathMap
             */
          if (($basePath = $this->getBasePath()) === null) {
            throw new InvalidConfigException('The "basePath" property must be set.');
          }
          //設(shè)置當前模塊的路徑和$basePath的映射關(guān)系
          $this->pathMap = [Yii::$app->getBasePath() => [$basePath]];
        }
    }
    public function applyTo($path)
    //這個就是按照 $pathMap中的定義的映射關(guān)系來對$path進行替換字符串的
    public function applyTo($path)
    {
        //對路徑中的"/"、“\”進行統(tǒng)一替換
        $path = FileHelper::normalizePath($path);
        foreach ($this->pathMap as $from => $tos) {
           //映射數(shù)組中的來源(舊值)
          $from = FileHelper::normalizePath(Yii::getAlias($from)) . DIRECTORY_SEPARATOR;
          //如果在$path中有可替換的舊值
          if (strpos($path, $from) === 0) {
            $n = strlen($from);
            //對目標值循環(huán),
            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;
    }
    希望本文所述對大家基于Yii框架的PHP程序設(shè)計有所幫助。