Docs For Class ThinkTemplate

Class ThinkTemplate

Description

ThinkPHP内置模板引擎类

支持XML标签和普通标签的模板解析编译型模板引擎支持动态缓存

author: liu21st <liu21st@gmail.com>
version: $Id$

Located in /Think/Template/ThinkTemplate.class.php (line 27)

Base
   |
   --ThinkTemplate

Variable Summary

mixed $tagLib

mixed $templateFile

mixed $tVar

Method Summary

static App getInstance ()

string buildAllTemplate ([ $tmplPath = TMPL_PATH], mixed $tmplContent, string $charset)

boolen checkCache (string $tmplTemplateFile)

void cleanCache (string $filename)

void cleanDir ([string $cacheDir = CACHE_PATH])

string compiler (mixed $tmplContent, [string $charset = ''])

void get ( $name)

string|false getIncludeTagLib ( &$content, string $content)

void load ( $templateFile, $charset, $templateVar, $varPrefix)

string loadTemplate ([string $tmplTemplateFile = ''], [string $charset = ''], string $varPrefix)

string parse (string $content)

string parseInclude (string $tmplPublicName)

string|false parseLiteral (string $content)

string parseTag (string $tagStr)

string parseTagLib (string $tagLib, &$content, [boolen $hide = false], string $content)

string parseThinkVar (string $varStr)

string parseVar (string $varStr)

string parseVarFunction (string $name, array $varArray)

string|false parseXmlTag (string $tagLib, string $tag, string $attr, string $content)

string|false restoreLiteral (string $tag)

void set ( $name, $value)

Variables

mixed $tagLib = array() (line 31)

access: protected

mixed $templateFile = '' (line 33)

access: protected

mixed $tVar = array() (line 35)

access: public

Methods

static getInstance (line 47)

取得模板实例对象

静态方法

access: public

static App getInstance ()

buildAllTemplate (line 133)

重新编译项目全部模版

throws: ThinkExecption
access: public

string buildAllTemplate ([ $tmplPath = TMPL_PATH], mixed $tmplContent, string $charset)

mixed $tmplContent: 模板内容
string $charset: 模板输出字符集
$tmplPath

checkCache (line 222)

检查缓存文件是否有效

如果无效则需要重新更新

throws: ThinkExecption
access: protected

boolen checkCache (string $tmplTemplateFile)

string $tmplTemplateFile: 模板文件名

cleanCache (line 254)

清除缓存或者静态文件

throws: ThinkExecption
access: protected

void cleanCache (string $filename)

string $filename: 缓存文件名

cleanDir (line 275)

清除缓存目录下面的文件

throws: ThinkExecption
access: protected

void cleanDir ([string $cacheDir = CACHE_PATH])

string $cacheDir: 缓存目录名

compiler (line 172)

编译模板文件内容

包括模板解析、同步路径和编码转换

throws: ThinkExecption
access: protected

string compiler (mixed $tmplContent, [string $charset = ''])

mixed $tmplContent: 模板内容
string $charset: 模板输出字符集

get (line 53)

access: public

void get ( $name)

$name

getIncludeTagLib (line 395)

搜索模板页面中包含的TagLib库

并返回列表

access: public

string|false getIncludeTagLib ( &$content, string $content)

string $content: 模板内容
&$content

load (line 66)

access: public

void load ( $templateFile, $charset, $templateVar, $varPrefix)

$templateFile
$charset
$templateVar
$varPrefix

loadTemplate (line 90)

加载主模板并缓存

throws: ThinkExecption
access: public

string loadTemplate ([string $tmplTemplateFile = ''], [string $charset = ''], string $varPrefix)

string $tmplTemplateFile: 模板文件
string $varPrefix: 模板变量前缀
string $charset: 模板输出字符集

parse (line 304)

模板解析入口

支持普通标签和TagLib解析支持自定义标签库

throws: ThinkExecption
access: public

string parse (string $content)

string $content: 要解析的模板内容

parseInclude (line 748)

加载公共模板并缓存和当前模板在同一路径，否则使用相对路径

throws: ThinkExecption
access: public

string parseInclude (string $tmplPublicName)

string $tmplPublicName: 公共模板文件名

parseLiteral (line 351)

替换页面中的literal标签

access: public

string|false parseLiteral (string $content)

string $content: 模板内容

parseTag (line 508)

模板标签解析

格式： {TagName:args [|content] }

throws: ThinkExecption
access: public

string parseTag (string $tagStr)

string $tagStr: 标签内容

parseTagLib (line 429)

TagLib库解析

access: public

string parseTagLib (string $tagLib, &$content, [boolen $hide = false], string $content)

string $tagLib: 要解析的标签库
string $content: 要解析的模板内容
boolen $hide: 是否隐藏标签库前缀
&$content

parseThinkVar (line 702)

特殊模板变量解析

格式以 $Think. 打头的变量属于特殊模板变量

throws: ThinkExecption
access: public

string parseThinkVar (string $varStr)

string $varStr: 变量字符串

parseVar (line 587)

模板变量解析,支持使用函数

格式： {$varname|function1|function2=arg1,arg2}

throws: ThinkExecption
access: public

string parseVar (string $varStr)

string $varStr: 变量数据

parseVarFunction (line 663)

对模板变量使用函数

格式 {$varname|function1|function2=arg1,arg2}

throws: ThinkExecption
access: public

string parseVarFunction (string $name, array $varArray)

string $name: 变量名
array $varArray: 函数列表

parseXmlTag (line 479)

解析标签库的标签

需要调用对应的标签库文件解析类

access: public

string|false parseXmlTag (string $tagLib, string $tag, string $attr, string $content)

string $tagLib: 标签库名称
string $tag: 标签名
string $attr: 标签属性
string $content: 标签内容

restoreLiteral (line 375)

还原被替换的literal标签

access: public

string|false restoreLiteral (string $tag)

string $tag: literal标签序号

set (line 61)

access: public

void set ( $name, $value)

$name
$value

Documentation generated on Thu, 27 Mar 2008 08:20:58 +0000 by 塞北的雪