Theme 类,即一个应用的主题,主要通过替换路径实现主题的应用,里边的方法为获取根路径和根链接,以及应用主题的方法:

 namespace yii\base;

 use Yii;
 use yii\helpers\FileHelper;

 /**
  * Theme represents an application theme.
  * Theme 类,即一个应用的主题
  *
  * When [[View]] renders a view file, it will check the [[View::theme|active theme]]
  * to see if there is a themed version of the view file exists. If so, the themed version will be rendered instead.
  * 视图对象[[View]]渲染视图文件的时候,会检查视图的主题[[View::theme|active theme]]是否存在,如果存在则渲染主题取代默认样式
  *
  * A theme is a directory consisting of view files which are meant to replace their non-themed counterparts.
  *
  * Theme uses [[pathMap]] to achieve the view file replacement:
  * Theme 通过[[pathMap]]来实现视图文件替换:
  *
  * 1. It first looks for a key in [[pathMap]] that is a substring of the given view file path;
  *    首先在[[pathMap]] 中查找关键字,该关键字是一个给定的视图路径的子字符串
  * 2. If such a key exists, the corresponding value will be used to replace the corresponding part
  *    in the view file path;
  *    如果该关键字存在,则用对应得值替换给定的视图文件路径中对应的部分
  * 3. It will then check if the updated view file exists or not. If so, that file will be used
  *    to replace the original view file.
  *    然后检查替换后的路径对应的文件是否存在,如果存在就替换原来的文件
  * 4. If Step 2 or 3 fails, the original view file will be used.
  *    如果2和3失败的话,就返回原来的路径
  *
  * For example, if [[pathMap]] is `['@app/views' => '@app/themes/basic']`,
  * then the themed version for a view file `@app/views/site/index.php` will be
  * `@app/themes/basic/site/index.php`.
  *
  * It is possible to map a single path to multiple paths. For example,
  *
  * ```php
  * 'pathMap' => [
  *     '@app/views' => [
  *         '@app/themes/christmas',
  *         '@app/themes/basic',
  *     ],
  * ]
  * ```
  *
  * In this case, the themed version could be either `@app/themes/christmas/site/index.php` or
  * `@app/themes/basic/site/index.php`. The former has precedence over the latter if both files exist.
  *  主题的对应关系可以是一个视图文件对应多个主题文件
  *
  * To use a theme, you should configure the [[View::theme|theme]] property of the "view" application
  * component like the following:
  *
  * ```php
  * 'view' => [
  *     'theme' => [
  *         'basePath' => '@app/themes/basic',
  *         'baseUrl' => '@web/themes/basic',
  *     ],
  * ],
  * ```
  *
  * The above configuration specifies a theme located under the "themes/basic" directory of the Web folder
  * that contains the entry script of the application. If your theme is designed to handle modules,
  * you may configure the [[pathMap]] property like described above.
  *
  * @property string $basePath The root path of this theme. All resources of this theme are located under this
  * directory.
  * @property string $baseUrl The base URL (without ending slash) for this theme. All resources of this theme
  * are considered to be under this base URL.
  *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
  */
 class Theme extends Component
 {
     /**
      * @var array the mapping between view directories and their corresponding themed versions.
      * This property is used by [[applyTo()]] when a view is trying to apply the theme.
      * Path aliases can be used when specifying directories.
      * If this property is empty or not set, a mapping [[Application::basePath]] to [[basePath]] will be used.
      * 路径映射属性--用来设置替换映射关系的
      */
     public $pathMap;
     /**
      * @var 设置要访问的资源的url,没有结尾的斜线(without ending slash)
      */
     private $_baseUrl;

     /**
      * @return string the base URL (without ending slash) for this theme. All resources of this theme are considered
      * to be under this base URL.
      * @return string 返回值为当前主题的基础链接,即访问链接,其他的资源都在该链接下
      */
     public function getBaseUrl()
     {
         return $this->_baseUrl;
     }

     /**
      * @param string $url the base URL or path alias for this theme. All resources of this theme are considered
      * to be under this base URL.
      * 设置基础访问链接
      */
     public function setBaseUrl($url)
     {
         $this->_baseUrl = rtrim(Yii::getAlias($url), '/');
     }
     /**
      * @var array 当前主题的根路径,该主题的资源都在该目录下
      */
     private $_basePath;

     /**
      * @return string the root path of this theme. All resources of this theme are located under this directory.
      * @return string 返回当前主题的根路径,该主题的资源都在该目录下
      * @see pathMap
      */
     public function getBasePath()
     {
         return $this->_basePath;
     }

     /**
      * @param string $path the root path or path alias of this theme. All resources of this theme are located
      * under this directory.
      * 设置当前主题的根路径
      * @see pathMap
      */
     public function setBasePath($path)
     {
         $this->_basePath = Yii::getAlias($path);
     }

     /**
      * Converts a file to a themed file if possible.
      * 将一个文件替换为允许替换的主题文件---主题的应用原理
      * If there is no corresponding themed file, the original file will be returned.
      * 如果没有对应的主题文件,将返回源文件
      * @param string $path the file to be themed
      * @return string the themed file, or the original file if the themed version is not available.
      * @throws InvalidConfigException if [[basePath]] is not set
      */
     public function applyTo($path)
     {
         $pathMap = $this->pathMap;//取得路径映射[[pathMap]]的值
         if (empty($pathMap)) {//如果[[pathMap]]没有设置值,则取当前主题的根路径,否则抛出异常
             if (($basePath = $this->getBasePath()) === null) {
                 throw new InvalidConfigException('The "basePath" property must be set.');
             }
             $pathMap = [Yii::$app->getBasePath() => [$basePath]];//设置$pathMap的值为[模块根路径=>主题根路径]的形式
         }
         //对路径中的"/"、“\”进行统一替换
         $path = FileHelper::normalizePath($path);

         foreach ($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;
     }

     /**
      * Converts a relative URL into an absolute URL using [[baseUrl]].
      * 将一个相对URL替换为绝对URL
      * @param string $url the relative URL to be converted.
      * @return string the absolute URL
      * @throws InvalidConfigException if [[baseUrl]] is not set
      */
     public function getUrl($url)
     {
         if (($baseUrl = $this->getBaseUrl()) !== null) {
             return $baseUrl . '/' . ltrim($url, '/');//通过取得[[baseUrl]]的值拼接出当前主题的绝对URL
         } else {
             throw new InvalidConfigException('The "baseUrl" property must be set.');
         }
     }

     /**
      * Converts a relative file path into an absolute one using [[basePath]].
      * 通过相对路径生成绝对路径
      * @param string $path the relative file path to be converted.
      * @return string the absolute file path
      * @throws InvalidConfigException if [[basePath]] is not set
      */
     public function getPath($path)
     {
         if (($basePath = $this->getBasePath()) !== null) {
             return $basePath . DIRECTORY_SEPARATOR . ltrim($path, '/\\');//通过取得[[basePath]]的值拼接出当前主题的绝对路径
         } else {
             throw new InvalidConfigException('The "basePath" property must be set.');
         }
     }
 }

Yii源码阅读笔记(二十七)的更多相关文章

  1. Yii源码阅读笔记(十七)

    View.php,继承了component,用于渲染视图文件: namespace yii\base; use Yii; use yii\helpers\FileHelper; use yii\wid ...

  2. Yii源码阅读笔记(一)

    今天开始阅读yii2的源码,想深入了解一下yii框架的工作原理,同时学习一下优秀的编码规范和风格.在此记录一下阅读中的小心得. 每个框架都有一个入口文件,首先从入口文件开始,yii2的入口文件位于we ...

  3. werkzeug源码阅读笔记(二) 下

    wsgi.py----第二部分 pop_path_info()函数 先测试一下这个函数的作用: >>> from werkzeug.wsgi import pop_path_info ...

  4. werkzeug源码阅读笔记(二) 上

    因为第一部分是关于初始化的部分的,我就没有发布出来~ wsgi.py----第一部分 在分析这个模块之前, 需要了解一下WSGI, 大致了解了之后再继续~ get_current_url()函数 很明 ...

  5. Detectron2源码阅读笔记-(二)Registry&build_*方法

    ​ Trainer解析 我们继续Detectron2代码阅读笔记-(一)中的内容. 上图画出了detectron2文件夹中的三个子文件夹(tools,config,engine)之间的关系.那么剩下的 ...

  6. Yii源码阅读笔记(二)

    接下来阅读BaseYii.php vendor/yiisoft/yii2/BaseYii.php—— namespace yii; use yii\base\InvalidConfigExceptio ...

  7. Yii源码阅读笔记(三十二)

    web/Application类的注释,继承base/Application类,针对web应用的一些处理: namespace yii\web; use Yii; use yii\base\Inval ...

  8. Yii源码阅读笔记(二十九)

    动态模型DynamicModel类,用于实现模型内数据验证: namespace yii\base; use yii\validators\Validator; /** * DynamicModel ...

  9. Yii源码阅读笔记(二十八)

    Yii/web中的Controller类,实现参数绑定,启动csrf验证功能,重定向页面功能: namespace yii\web; use Yii; use yii\base\InlineActio ...

随机推荐

  1. 如何让Ue4画面产生振动效果

    可以使用CameraShake蓝图类,对应的C++类为UCameraShake. 这个类是通过修改PlayerController来达到效果

  2. tomcat 部署spring工程乱码解决方案

    tomcat的server.xml文件,Connector标签增加useBodyEncodingForURI="true"属性 web.xml如下配置 <filter> ...

  3. memcache/redis 缓存学习笔记

    0.redis和memcache的区别 a.redis可以存储除了string之外的对象,如list,hash等 b.服务器宕机以后,redis会把内存的数据持久化到磁盘上,而memcache则不会 ...

  4. checkbox属性checked="checked"通过js已设置,但是不勾选

    1.通过 attr('checked','checked') 来设置checkbox时,重复点击,虽然checked属性设置正确,但是checkbox没有被勾选 ,如下代码:(代码是全选功能) $(' ...

  5. HDU 2818 (矢量并查集)

    题目链接: http://acm.hdu.edu.cn/showproblem.php?pid=2818 题目大意:每次指定一块砖头,移动砖头所在堆到另一堆.查询指定砖头下面有几块砖头. 解题思路: ...

  6. POJ 2456 (二分)

    题目链接: http://poj.org/problem?id=2456 题目大意:n个房子,m头牛,房子有一个横坐标,问将m头牛塞进房子,每两头牛之间的最大间隔是多少. 解题思路: 不难看出应该二分 ...

  7. 【POJ】3678 Katu Puzzle

    http://poj.org/problem?id=3678 题意:很幼稚的题目直接看英文题面= = #include <cstdio> #include <cstring> ...

  8. URAL 1658. Sum of Digits(DP)

    题目链接 隔了一年零三个月,重新刷URAL,这题挺麻烦的输出路径.输出路径挺扯的,乱写了写乱改改就A了...我本来想用很靠谱,记录每一条路径的,然后输出最小的,结果Tle,然后我使劲水水又过了一组,发 ...

  9. 【noiOJ】p7939

    09:膨胀的木棍 查看 提交 统计 提问 总时间限制:  1000ms 内存限制:  65536kB 描述 当长度为L的一根细木棍的温度升高n度,它会膨胀到新的长度L'=(1+n*C)*L,其中C是热 ...

  10. Java中UIManager的几种外观的详细讲解

    Java'中的几种Look and Feel 1.Metal风格 (默认) String lookAndFeel = "javax.swing.plaf.metal.MetalLookAnd ...