领购物优惠券9块9包邮
首页 > 编程语言 > PHP教程

ThinkPHP 模板解析类Template分析

   2016-12-23 0
核心提示：本文是在 thinkphp 模板解析的流程 （http://blog.csdn.net/qq_16877261/article/details/53484671）文章基础上进行讲解的，没看过的同学可以先大致浏览一下。下面我就直接开始分析，对有必要的源码才会贴出，不必要的就不贴了。接着上一篇文章讲解 知道 模板

本文是在   thinkphp 模板解析的流程 （http://blog.csdn.net/qq_16877261/article/details/53484671）文章基础上进行讲解的，没看过的同学可以先大致浏览一下。

下面我就直接开始分析，对有必要的源码才会贴出，不必要的就不贴了。

接着上一篇文章讲解  知道  模板解析是该类中的fetch方法开始的，查看代码发现fetch方法调用了loadTemplate，而loadTemplate调用了compiler，compiler调用了parse函数

最后发现解析模板是从该类的parse函数开始的。

下面我重点对这个函数及相关的一些类进行讲解。

public function parse($content) {
    // 内容为空不解析
    if(empty($content)) return '';
    //标签库标签开始标记
    $begin      =   $this->config['taglib_begin'];//默认为   <
    $end        =   $this->config['taglib_end'];  // 默认为  >
    // 检查include语法
    $content    =   $this->parseInclude($content);
    // 检查PHP语法
    $content    =   $this->parsePhp($content);
    // 首先替换literal标签内容
    $content    =   preg_replace_callback('/'.$begin.'literal'.$end.'(.*?)'.$begin.'\/literal'.$end.'/is', array($this, 'parseLiteral'),$content);

    // 获取需要引入的标签库列表
    // 标签库只需要定义一次，允许引入多个一次
    // 一般放在文件的最前面
    // 格式：<taglib name="html,mytag..." />
    // 当TAGLIB_LOAD配置为true时才会进行检测
    if(C('TAGLIB_LOAD')) {
        $this->getIncludeTagLib($content);
        if(!empty($this->tagLib)) {
            // 对导入的TagLib进行解析
            foreach($this->tagLib as $tagLibName) {
                $this->parseTagLib($tagLibName,$content);
            }
        }
    }
    // 预先加载的标签库 无需在每个模板中使用taglib标签加载 但必须使用标签库XML前缀
    if(C('TAGLIB_PRE_LOAD')) {
        $tagLibs =  explode(',',C('TAGLIB_PRE_LOAD'));
        foreach ($tagLibs as $tag){
            $this->parseTagLib($tag,$content);
        }
    }
    // 内置标签库 无需使用taglib标签导入就可以使用 并且不需使用标签库XML前缀
    $tagLibs =  explode(',',C('TAGLIB_BUILD_IN'));
    foreach ($tagLibs as $tag){
        $this->parseTagLib($tag,$content,true);
    }
    //解析普通模板标签 {$tagName}
    $content = preg_replace_callback('/('.$this->config['tmpl_begin'].')([^\d\w\s'.$this->config['tmpl_begin'].$this->config['tmpl_end'].'].+?)('.$this->config['tmpl_end'].')/is', array($this, 'parseTag'),$content);
    return $content;
}

由代码可知需要查看parseInclude 函数

// 解析模板中的include标签
protected function parseInclude($content, $extend = true) {
    // 解析继承
    if($extend)
        $content    =   $this->parseExtend($content);
    // 解析布局
    $content    =   $this->parseLayout($content);
    // 读取模板中的include标签        $find  匹配的次数
    $find       =   preg_match_all('/'.$this->config['taglib_begin'].'include\s(.+?)\s*?\/'.$this->config['taglib_end'].'/is',$content,$matches);
    if($find) {
        for($i=0;$i<$find;$i++) {
            $include    =   $matches[1][$i];
            $array      =   $this->parseXmlAttrs($include);
            $file       =   $array['file'];
            unset($array['file']);
            $content    =   str_replace($matches[0][$i],$this->parseIncludeItem($file,$array,$extend),$content);
        }
    }
    return $content;
}

由于我暂时模板中用不到继承和布局，所以暂时略过下面这两行代码，有兴趣的同学可以研究哈。

 if($extend)
        $content    =   $this->parseExtend($content);
    // 解析布局
    $content    =   $this->parseLayout($content);

由代码知道根据正则表达式匹配出  include标签 ，默认的include标签为    <include file="./Public/nav.html"/>  的形式，  而函数preg_match_all （对该函数不了解的需要查看一

下函数）返回的是匹配的次数，所以 $matches[1][$i] 匹配的是第i个include标签的  file="./Public/nav.html"    （file里面的内容是可变的，只是举个例子）$matches[0][$i] 匹配的是第i个include标签的 <include file="./Public/nav.html"/>。

parseXmlAttrs 函数的作用是 将匹配到的 file="./Public/nav.html"  放入到xml标签里，然后再进行解析xml属性，返回解析的数组（可看源码）。{这个思想很有用啊，以后有可能会用啊}。

parseIncludeItem 函数解析模板文件并读取模板文件内容，然后再调用parseInclude 进行include 标签解析，一直到没有include标签。采用的是递归的思想。

于是parseInclude 函数的作用：解析include 标签里的文件名，从而读取文件内容，代替当前的include标签。

我接着看parse函数，parsePhp 检查PHP语法,  接着用正则替换掉literal标签内容，并将其放在全局变量$literal中，最后再替换回来，接着代码涉及到标签库。

// 内置标签库 无需使用taglib标签导入就可以使用 并且不需使用标签库XML前缀
$tagLibs =  explode(',',C('TAGLIB_BUILD_IN'));
foreach ($tagLibs as $tag){
    $this->parseTagLib($tag,$content,true);
}

Thinkphp 中有许多内置的标签如 <foreach name= 'arr'  item='foo'>   volist  empty  等等，当然也可以自己定义标签库，这么艰巨的任务有兴趣的同学可以尝试一下哈。由于我没有自定义标签库，所以直接看内置标签库的解析就OK了。系统内置的标签库名为“Cx”。

下面我们对 parseTagLib 函数进行解析

/**
 * TagLib库解析
 * @access public
 * @param string $tagLib 要解析的标签库
 * @param string $content 要解析的模板内容
 * @param boolean $hide 是否隐藏标签库前缀
 * @return string
 */
public function parseTagLib($tagLib,&$content,$hide=false) {
    $begin      =   $this->config['taglib_begin'];
    $end        =   $this->config['taglib_end'];
    if(strpos($tagLib,'\\')){
        // 支持指定标签库的命名空间
        $className  =   $tagLib;
        $tagLib     =   substr($tagLib,strrpos($tagLib,'\\')+1);
    }else{
        $className  =   'Think\\Template\TagLib\\'.ucwords($tagLib);            
    }
    //实例化标签库
    $tLib       =   \Think\Think::instance($className);
    $that       =   $this;
    //$tLib->getTags() 得到所有标签
    foreach ($tLib->getTags() as $name=>$val){
        $tags = array($name);
        if(isset($val['alias'])) {// 别名设置
            $tags       = explode(',',$val['alias']);
            $tags[]     =  $name;
        }
        $level      =   isset($val['level'])?$val['level']:1;
        $closeTag   =   isset($val['close'])?$val['close']:true;
        foreach ($tags as $tag){
            //$hide=false  默认标签库$tagLib=Cx
            $parseTag = !$hide? $tagLib.':'.$tag: $tag;// 实际要解析的标签名称
            if(!method_exists($tLib,'_'.$tag)) {
                // 别名可以无需定义解析方法
                $tag  =  $name;
            }
            $n1 = empty($val['attr'])?'(\s*?)':'\s([^'.$end.']*)';
            $this->tempVar = array($tagLib, $tag);

            //我们以 volist 标签为例 $closeTag=true
            if (!$closeTag){
                $patterns       = '/'.$begin.$parseTag.$n1.'\/(\s*?)'.$end.'/is';
                $content        = preg_replace_callback($patterns, function($matches) use($tLib,$tag,$that){
                    return $that->parseXmlTag($tLib,$tag,$matches[1],$matches[2]);
                },$content);
            }else{
                // 匹配形式如 <volist name="arr"  id="foo"> **</volist>
                $patterns       = '/'.$begin.$parseTag.$n1.$end.'(.*?)'.$begin.'\/'.$parseTag.'(\s*?)'.$end.'/is';
                for($i=0;$i<$level;$i++) {
                    //进行标签解析，并将之前的标签替换成解析后的内容
                    $content=preg_replace_callback($patterns,function($matches) use($tLib,$tag,$that){
                        return $that->parseXmlTag($tLib,$tag,$matches[1],$matches[2]);
                    },$content);
                }
            }
        }
    }
}

因此又需要查看函数parseXmlTag 

/**
 * 解析标签库的标签
 * 需要调用对应的标签库文件解析类
 * @access public
 * @param object $tagLib  标签库对象实例
 * @param string $tag  标签名
 * @param string $attr  标签属性
 * @param string $content  标签内容
 * @return string|false
 */
public function parseXmlTag($tagLib,$tag,$attr,$content) {
    if(ini_get('magic_quotes_sybase'))
        $attr   =   str_replace('\"','\'',$attr);
    $parse      =   '_'.$tag;
    $content    =   trim($content);
    // 返回该标签的属性数组 $tags
    $tags       =   $tagLib->parseXmlAttr($attr,$tag);
    return $tagLib->$parse($tags,$content);
}

我们仍以标签volist为例，可知该函数又调用了 Cx->_volist 方法。

/**
 * volist标签解析 循环输出数据集
 * 格式：
 * <volist name="userList" id="user" empty="" >
 * {user.username}
 * {user.email}
 * </volist>
 * @access public
 * @param array $tag 标签属性
 * @param string $content  标签内容
 * @return string|void
 */
public function _volist($tag,$content) {
    $name  =    $tag['name'];
    $id    =    $tag['id'];
    $empty =    isset($tag['empty'])?$tag['empty']:'';
    $key   =    !empty($tag['key'])?$tag['key']:'i';
    $mod   =    isset($tag['mod'])?$tag['mod']:'2';
    // 允许使用函数设定数据集 <volist name=":fun('arg')" id="vo">{$vo.name}</volist>
    $parseStr   =  '<?php ';
    if(0===strpos($name,':')) {
        $parseStr   .= '$_result='.substr($name,1).';';
        $name   = '$_result';
    }else{
        //自动识别构建变量
        $name   = $this->autoBuildVar($name);
    }
    //下面这段代码采用了PHP流程控制的替代语法
    //左花括号（{）换成冒号（:），把右花括号（}）分别换成 endif;，endwhile;，endfor;，endforeach; 以及 endswitch;
    $parseStr  .=  'if(is_array('.$name.')): $'.$key.' = 0;';
    if(isset($tag['length']) && '' !=$tag['length'] ) {
        $parseStr  .= ' $__LIST__ = array_slice('.$name.','.$tag['offset'].','.$tag['length'].',true);';
    }elseif(isset($tag['offset'])  && '' !=$tag['offset']){
        $parseStr  .= ' $__LIST__ = array_slice('.$name.','.$tag['offset'].',null,true);';
    }else{
        $parseStr .= ' $__LIST__ = '.$name.';';
    }
    $parseStr .= 'if( count($__LIST__)==0 ) : echo "'.$empty.'" ;';
    $parseStr .= 'else: ';
    $parseStr .= 'foreach($__LIST__ as $key=>$'.$id.'): ';
    $parseStr .= '$mod = ($'.$key.' % '.$mod.' );';
    $parseStr .= '++$'.$key.';?>';
    $parseStr .= $this->tpl->parse($content);
    $parseStr .= '<?php endforeach; endif; else: echo "'.$empty.'" ;endif; ?>';

    if(!empty($parseStr)) {
        return $parseStr;
    }
    return ;
}

至此，完成了标签库的解析，其他标签原理相同。其实就是将所谓的标签正则匹配出来然后用PHP 语句替换。然后我们再一次梳理一下标签解析的步骤：

1、调用parseTagLib函数，实例化标签库，然后获取所有标签，进行遍历，然后对于每个标签调用parseXmlTag函数，并用现有的标签替换标签解析后的内容。

2、根据具体的标签调用具体的标签库里的函数，并返回解析后的PHP代码。

下面我们再一次回到parse函数，请同学们自行查看代码，这里不再贴代码了，标签库解析完之后

$content = preg_replace_callback('/('.$this->config['tmpl_begin'].')([^\d\w\s'.$this->config['tmpl_begin'].$this->config['tmpl_end'].'].+?)('.$this->config['tmpl_end'].')/is', array($this, 'parseTag'),$content);

这一步其实就是替换模板变量。这里不再赘述。有兴趣的同学，可以自行查看。至此，parse函数完成。我们又回到上一个函数compiler函数

其中该函数有一句

Hook::listen('template_filter',$tmplContent);

显然又调用了行为扩展。于是我又去如图目录下找到common.php 文件查看

ThinkPHP 模板解析类Template分析

发现该标签对应的行为扩展类为ContentReplaceBehavior，打开代码查看如下

'template_filter'=> array(
    'Behavior\ContentReplaceBehavior', // 模板输出替换
),
/**
 * 模板内容替换
 * @access protected
 * @param string $content 模板内容
 * @return string
 */
protected function templateContentReplace($content) {
    // 系统默认的特殊变量替换
    $replace =  array(
        '__ROOT__'      =>  __ROOT__,       // 当前网站地址
        '__APP__'       =>  __APP__,        // 当前应用地址
        '__MODULE__'    =>  __MODULE__,
        '__ACTION__'    =>  __ACTION__,     // 当前操作地址
        '__SELF__'      =>  htmlentities(__SELF__),       // 当前页面地址
        '__CONTROLLER__'=>  __CONTROLLER__,
        '__URL__'       =>  __CONTROLLER__,
        '__PUBLIC__'    =>  __ROOT__.'/Public',// 站点公共目录
    );
    // 允许用户自定义模板的字符串替换
    if(is_array(C('TMPL_PARSE_STRING')) )
        $replace =  array_merge($replace,C('TMPL_PARSE_STRING'));
    $content = str_replace(array_keys($replace),array_values($replace),$content);
    return $content;
}

于是发现之前在模板中使用的模板特殊变量原来是在这实现的。至此compiler函数结束了。于是又回到了loadTemplate函数，函数中有这段代码，就是将解析编译后的代码写入缓存文件。并返回缓存文件。

$tmplContent =  $this->compiler($tmplContent);
Storage::put($tmplCacheFile,trim($tmplContent),'tpl');
return $tmplCacheFile;

于是又回到fetch函数

public function fetch($templateFile,$templateVar,$prefix='') {
    $this->tVar         =   $templateVar;
    $templateCacheFile  =   $this->loadTemplate($templateFile,$prefix);
    Storage::load($templateCacheFile,$this->tVar,null,'tpl');
}

其实就是加载缓存文件。至此，整个模板解析、编译，加载过程完成。

如果讲解有不对的地方，欢迎指正

 
标签： ThinkPHP XML
反对 0举报 0 评论 0
 

免责声明：本文仅代表作者个人观点，与乐学笔记（本网）无关。其原创性以及文中陈述文字和内容未经本站证实，对本文以及其中全部或者部分内容、文字的真实性、完整性、及时性本站不作任何保证或承诺，请读者仅作参考，并请自行核实相关内容。
    本网站有部分内容均转载自其它媒体，转载目的在于传递更多信息，并不代表本网赞同其观点和对其真实性负责，若因作品内容、知识产权、版权和其他问题，请及时提供相关证明等材料并与我们留言联系，本网站将在规定时间内给予删除等相关处理.

  • nginx 各类网站设置 (laravel , thinkphp , nod
    基础部分设置[root@centos ~]# vim /opt/nginx/conf/nginx.confuser www www;worker_processes auto;pid logs/nginx.pid;worker_rlimit_nofile 100000;events {use epoll;multi_accept on;worker_connections 65535 ;}http {include mime.types;default_type
    02-09
  • thinkphp5 IIS7.5 隐藏index.php的方法
    ?xml version="1.0" encoding="UTF-8"? configurationsystem.webServerrewriterulesrule name="WPurls" enabled="true" stopProcessing="true"match url=".*" /conditions logicalGrouping="MatchAll"
    02-09
  • ThinkPHP 利用.htaccess文件的 Rewrite 规则隐
    通常的URL里面含有index.php，为了达到更好的SEO效果可能需要去掉URL里面的index.php ，通过URL重写的方式可以达到这种效果，通常需要服务器开启URL_REWRITE模块才能支持。 下面是Apache的配置过程，可以参考下：1、httpd.conf配置文件中加载了mod_rewrite.so
    02-09
  • 【小程序+thinkphp5】 用户登陆，返回第三方session3rd
    【小程序+thinkphp5】 用户登陆，返回第三方ses
    服务器环境： centos7   php7.0准备工作： 注册小程序，并获取 appid 、appsecret下载微信解密算法sdk : https://mp.weixin.qq.com/debug/wxadoc/dev/api/signature.htmlhttps 的域名。需要在小程序后台服务器域名那配置 　　代码实现 一 、 thinkphp5 
    02-09
  • 码云推荐 | 基于 ThinkPHP5 的通用后台 lyadmin_v2
    码云推荐 | 基于 ThinkPHP5 的通用后台 lyadmin
    lyadmin_v2 项目介绍 lyamdin是一套轻量级通用后台，采用Bootstrap3制作，自带权限管理，模块化开发。lyadmin_v2是基于ThinkPHP5全新开发的新版本。真正原创的Builder页面生生成器完美支持2.0并且支持多达38中表单类型的支持，包括但不限于文本、富文本、图片
    02-05 ThinkPHPlyadmin
  • 在 thinkphp 中使用 laravel 的全部组件
    作为一个使用 php 作为主力语言的公司，不管怎么说，在一些老的项目中，总会碰到使用 thinkphp 的。那么，热爱 laravel 的你，当你去开发新的 feature 时，大胆的去引入 laravel 的组件吧。不管是对于现在的开发效率，还是日后项目的重构，迁移都是有很大帮助
    02-05 LaravelThinkPHP
  • ThinkPHP V5.0.5 版本发布 — 祝大家新春快乐！
    ThinkPHP V5.0.5 版本发布 — 祝大家新春快乐！
    ThinkPHP V5.0.5 版本发布，祝大家新春快乐，事业有成，“鸡”祥如意^_^官方快速入门系列教程 新增了控制器从入门到精通 V5.0.5版本是年前最后一个发布版本，也是5.0系列版本的最后一个功能版本，主要改进和优化了数据库和模型部分，并修正了之前版本的一些问
    02-05 ThinkPHP数据库
  • 基于thinkphp的音乐网站源码
    基于thinkphp的音乐网站源码
    KSmusic音乐网站源码是一个以php+MySQL进行开发的免费音乐网站源码，只需进行简单的设置，即可拥有属于自己的音乐网站。 更新日志：标签增加 分页功能 大大增加数据自由性专辑 count 标签 用于读取数据总数量新增上一个，下一个标签 ，新增 网盘下载设置项新
    01-06 音乐网站ThinkPHP
  • 在线工单售后客户服务管理系统（thinkphp内核）
    在线工单售后客户服务管理系统（thinkphp内核）
    THINKPHP内核的工单系统，非常适合于售后客户服务，二开后对接到网站系统是非常不错的哦，可以添加客户和售后人员，支持短信和邮件提醒，只需要在后台配置好就行了，还是非常简单的。1、系统管理1.1：客户管理：可实现对职员的管理，可添加职员，并对不同角色
    01-06 ThinkPHP
  • thinkphp 模板解析的流程
    thinkphp 模板解析的流程
    ThinkPHP控制器中在每一个方法的最后都有这样的一句话 ,你确定对这句话非常了解吗？$this-display();当然你会说这句话是用来解析或显示控制器的方法所对应的模板的。有了这句，模板里的内容才可以正常显示，没有这句话就会抛出错误：模板不存在。但是这句话是
    12-23 ThinkPHP
更多>PHP教程
php-fpm进程管理的三种模式 phpfpm子进程 [PHP8] 我参加了PHP8工程师认证初学者考试beta考试
更多>C/C++教程
VScode运行C++中文终端乱码的解决方案 vscode错误提示中文 C++ LeetCode1945题解字符串转化后的各位数字之和
更多>Java教程
Java项目导出数据为 PDF 文件的操作代码 盘点Java中延时任务的多种实现方式 java 延时队列怎么实现
更多>ASP.NET
使用WebClient自动填写并提交ASP.NET页面表单的源代码 asp.net mvc多条件+分页查询解决方案 asp.net mvc多条件+分页查询解决方案
更多>JSP编程
JSP通用高大上分页代码(超管用) JSP验证码动态生成方法
点击排行
网站首页  |  关于我们  |  联系方式  |  使用协议  |  版权隐私  |  网站地图  |  网站留言  |  违规举报