Yii2主題(Theme)用法詳解

本文實例講述了Yii2主題(Theme)用法。分享給大家供大家參考，具體如下：

首先看看主要的配置方式：

'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',
      ],
];

好處看到了吧，如果在blank中沒有找到文件，會從default中來查找，也就是說blank中的文件會覆蓋default中存在的文件，從而實現了主題的繼承。

主題中的屬性：

$pathMap：這個就是用來設置替換映射關系的。

'pathMap' =>[
    '@app/views' => [
        '@app/themes/blank',
        '@app/themes/default',
    ],
    '@app/modules' => '@app/themes/default/modules',
    '@app/widgets' => '@app/themes/default/widgets'
],

這三個分別對views、modules和widgets應用主題。

$baseUrl：這個用來設置要訪問的資源的url（結尾不加“/”）

$basePath：設置資源所在的文件目錄

主題中的方法：

public function init()

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;
}

更多關於Yii相關內容感興趣的讀者可查看本站專題：《Yii框架入門及常用技巧總結》、《php優秀開發框架總結》、《smarty模板入門基礎教程》、《php面向對象程序設計入門教程》、《php字符串(string)用法總結》、《php+mysql數據庫操作入門教程》及《php常見數據庫操作技巧匯總》

希望本文所述對大家基於Yii框架的PHP程序設計有所幫助。