附件三：DedeCMS二次开发——代码篇

二、代码篇

2.1、common.func.php 公用函数

获得当前的脚本网址
function GetCurUrl()

返回格林威治标准时间
function MyDate($format='Y-m-d H:i:s',$timest=0)

把全角数字转为半角
function GetAlabNum($fnum)

把含HTML的内容转为纯text
function Html2Text($str,$r=0)

把文本转HTML
function Text2Html($txt)

输出Ajax头
function AjaxHead()

中文截取2，单字节截取模式
function cn_substr($str,$slen,$startdd=0)

把标准时间转为Unix时间戳
function GetMkTime($dtime)

获得一个 0000-00-00 00:00:00 标准格式的时间
function GetDateTimeMk($mktime)

获得一个 0000-00-00 标准格式的日期
function GetDateMk($mktime)

获得用户IP
function GetIP()

获取拼音以gbk编码为准
function GetPinyin($str,$ishead=0,$isclose=1)

dedecms通用消息提示框
function ShowMsg($msg,$gourl,$onlymsg=0,$limittime=0)

保存一个cookie
function PutCookie($key,$value,$kptime=0,$pa="/")

删除一个cookie
function DropCookie($key)

获取cookie
function GetCookie($key)

获取验证码
function GetCkVdValue()

过滤前台用户输入的文本内容
// $rptype = 0 表示仅替换 html标记
// $rptype = 1 表示替换 html标记同时去除连续空白字符
// $rptype = 2 表示替换 html标记同时去除所有空白字符
// $rptype = -1 表示仅替换 html危险的标记
function HtmlReplace($str,$rptype=0)

获得某文档的所有tag
function GetTags($aid)

过滤用于搜索的字符串
function FilterSearch($keyword)

处理禁用HTML但允许换行的内容
function TrimMsg($msg)

获取单篇文档信息
function GetOneArchive($aid)

2.2、dedesql.class.php 数据库类

系统会自动载入 dedesql.class.php 文件，并用
$dsql = $db = new DedeSql(false);
进行初始化数据库连接，因此在工程所有文件中均不需要单独初始化这个类，可直接用 $dsql 或 $db 进行操作，为了防止错误，操作完后不必关闭数据库。

常用的方法：
1、执行一个非查询类型的SQL语句，如 insert 、create 、update 等
$rs = $db->ExecuteNoneQuery($sql);
返回值为是否执行成功。

2、执行一个非查询类型的SQL语句，并返回成功记录数
$rs = $db->ExecuteNoneQuery2($sql);

与上面相比，它返回的是影响的记录数，而不是布尔值

3、返回单个记录
$arr = $db->GetOne($sql);

$dsql 如果不带 limit ，系统会自动加上 limit 0,1

4、执行条件查询语句

1 $db->SetQuery($dsql);

2 $db->Execute();

3 while($arr = $db->GetArray())

4 {

5 }
可以简化为：

6 $db->Execute('me',$dsql);

7 while($arr = $db->GetArray())

8 {

9 }
'me' 为记录集游标，用于区分不同的查询，如：

10 $db->Execute('me',$dsql);

11 while($arr = $db->GetArray())

12 {

13    $db->Execute('2',$dsql2);

14    while($arr2 = $db->GetArray())

15    {

16

17    }

18 }
像这种情况必须指定一个值区分默认的'me'参数，否则会出错

$db->GetArray($rsid,$acctype) 参数
$rsid="me"
$acctype=MYSQL_ASSOC

在查询游标中读取数据还可以用
$db->GetObject($rsid="me");

返回的结果是用类结构表示的值。

5、获取上一个插入的自动递增主键id值
$db->GetLastID();

6、获得查询的总记录数
$db->GetTotalRow($rsid="me")

7、获得MySql的版本号
$db->GetVersion($isformat=true)
默认的情况下会转换成 x.xx 形式浮点数

8、析放某查询的资源

$db->FreeResult($rsid="me");

9、在数据库中是否存在某数据表
$db->IsTable($tbname)

10、重新选择要操作的数据库
$db->SelectDB($dbname);

11、获得数据库连接标识
$db->linkID
获得这个连接标识后，可以直接用mysql相关函数进行数据库操作
在非不得已的情况，项目中一般不使用这个变量。

2.3、datalistcp.class.php 动态分页类

类文件
include/datalistcp.class.php

适用范围：数据量不大的数据分页
使用方法：

1 $dl = new DataListCP();

2 $dl->pageSize = 25;              //设定每页显示记录数（默认25条）

3 $dl->SetParameter($key,$value);  //设定get字符串的变量

//这两句的顺序不能更换

4 $dl->SetTemplate($tplfile);?//载入模板

5 $dl->SetSource($sql);?//设定查询SQL

6

7 $dl->Display();?//显示

模板

8 {dede:datalist}<br />

9  <li>{field.fieldname1/} - {field.fieldname2/} ...</li><br />

10 {/dede:datalist}<br />

11 <br />

12 {tag:pagelist listitem="info,index,end,pre,next,pageno"  listsize="5"/}

listitem、listsize 是可选属性
如果需要自定义 datalist 相关属性，可以继续本类来创建一个新类，只需改变 GetArcList($atts,$refObj='',$fields=array()) 方法即可。

2.4、dedetag.class.php 静态模板类

类文件
include/dedetag.class.php

这个文件是dedecms V5.3及之前版本使用的主要的模板类，它是解析式模板类，并非编译式的（区别是前者通过获得标签位置进行内容替换，后者是直接解析式PHP代码，二次执行）

一、模板语法
织梦模板引擎是一种使用XML名字空间形式的模板解析器，使用织梦解析器解析模板的最大好处是可以轻松的制定标记的属性，感觉上就像在用HTML一样，使模板代码十分直观灵活，新版的织梦模板引擎不单能实现模板的解析还能分析模板里错误的标记。

1、织梦模板引擎的代码样式有如下几种形式：
{dede:标记名称 属性='值'/}
{dede:标记名称 属性='值'}{/dede:标记名称}
{dede:标记名称 属性='值'}自定义样式模板(InnerText){/dede:标记名称}

提示：
如果使用带底层模板的标记，必须严格用{dede:标记名称 属性='值'}{/dede:标记名称} 这种格式，否则会报错。

2、织梦模板引擎内置有多个系统标记，这些系统标记在任何场合都是能直接使用的。

(1) global 标记，表示获取一个外部变量，除了数据库密码之外，能调用系统的任何配置参数，形式为：
{dede:global name='变量名称'}{/dede:global}
或
{dede:global name='变量名称'/}

其中变量名称不能加 $ 符号，如变量 $cfg_cmspath ，应该写成 {dede:global name='cfg_cmspath'/} 。

(2) foreach 用来输出一个数组，形式为：
{dede:foreach array='数组名称'}[field:key/] [field:value/]{/dede:foreach}

(3) include 引入一个文件，形式为：
{dede:include file='文件名称' ismake='是否为dede板块模板(yes/no)'/}
对文件的搜索路径为顺序为：绝对路径、include文件夹，CMS安装目录，CMS主模板目录

3、织梦标记允许在任何标记中使用函数对得到的值进行处理，形式为：
{dede:标记名称 属性='值' function='youfunction("参数一","参数二","@me")'/}
其中 @me 用于表示当前标记的值，其它参数由你的函数决定是否存在，例如：
{dede:field name='pubdate' function='strftime("%Y-%m-%d %H:%M:%S","@me")'/}

4、织梦标记允许有限的编程扩展。
格式为：
{dede:tagname runphp='yes'}
$aaa = @me;
@me = "123456";
{/dede:tagname}
@me 表示这个标记本身的值，因此标记内编程是不能使用echo之类的语句的，只能把所有返回值传递给@me。
此外由于程序代码占用了底层模板InnerText的内容，因此需编程的标记只能使用默认的InnerText。

二、解析方式

在 dedetag.class.php 里面有四个类

class DedeAttribute  属性结构表述

class DedeAttributeParse  属性解析器

class DedeTag  标签结构表述

class DedeTagParse  标签解析器

使用解析类解析模板时一般经过下面的步骤

1、初始化：

$dtp = new DedeTagParse();

2、载入模板/模板字符串：

$dtp->LoadTemplate(模板文件（绝对路径）);  //会生成缓存，第二次不需解析模板

或$dtp->LoadSource(字符串);

3、给标签赋值

foreach($dtp->CTags as $tid=>$ctag) {

//判断ctag的名称和属性，并给赋不同的值，通常用函数处理

if($ctag->GetName=='mytag') $dtp->Assign($tid, mytagvalue($ctag) );  }

在上面例子中，直接把名称为 mytag的标签转交给 mytagvalue 函数处理，mytagvalue 里判断$ctag的各个属性，返回不同内容即可。

在 V5.3版本中，通常除了field、list等专用标签之外，凡arc.*开头的类解析的文件，标签都是对应该 include/taglib 的源码的，这个由系统进行了自动的映射。

4、显示或保存为HTML

$dtp->display();

或

$dtp->SaveTo(静态文件名);

对于二次开发人员而言，不大需要知道dedecms模板具体解析方式，不过应该十分清楚CTag这个类的结构，从而判断标签不同属性进行处理。

1 class DedeTag

2 {

3     var $IsReplace=FALSE; //标记是否已被替代，供解析器使用

4     var $TagName=""; //标记名称

5     var $InnerText=""; //标记之间的文本

6     var $StartPos=0; //标记起始位置

7     var $EndPos=0; //标记结束位置

8     var $CAttribute=""; //标记属性描述,即是class DedeAttribute

9     var $TagValue=""; //标记的值

10     var $TagID = 0;

11

12     //获取标记的名称和值

13     function GetName()

14     {

15         return strtolower($this->TagName);

16     }

17

18     function GetValue()

19     {

20         return $this->TagValue;

21     }

22

23     //下面两个成员函数仅是为了兼容旧版

24     function GetTagName()

25     {

26         return strtolower($this->TagName);

27     }

28

29     function GetTagValue()

30     {

31         return $this->TagValue;

32     }

33

34     //获取标记的指定属性

35     function IsAttribute($str)

36     {

37         return $this->CAttribute->IsAttribute($str);

38     }

39

40     function GetAttribute($str)

41     {

42         return $this->CAttribute->GetAtt($str);

43     }

44

45     function GetAtt($str)

46     {

47         return $this->CAttribute->GetAtt($str);

48     }

49

50     function GetInnerText()

51     {

52         return $this->InnerText;

53     }

54 }

2.5、dedetemplate.class.php 动态模板类

核心类文件
include/dedetemplate.class.php
用途：用于非核心模块的动态页面或列表页的模板解析，如：member/content_list.php ，通常是在 datalistcp.class.php 中使用，这个类在动态运行的情况下，由于本身是把模板编译成PHP的，因此性能上会优级于旧的解析类，这个方法将在未来版本中作为通用的方式。

一、使用方法：

$tpl = new DedeTemplate(
模板对象实例名称，通常是'tpl',
[模板存放目录（生成缓存时会存放在这个目录）,
include语法默认引用目录]
);
通常情况下参数二和参数三是不必要的，如：
$tpl = new DedeTemplate('tpl');

如果在类文件中调用，应该加上设置：
$this->tpl->SetObject($this);
在一些块调用中默认将使用当前类的成员函数。

$tpl->LoadTemplate(模板的物理路径);

如果模板中带有 {dede:config name='' value=''/}
可以在载入模板后，通过 $tpl->GetConfig($name) 获得这些变量的值。

显示页面或保存页面为文件
$tpl->Display();
$tpl->SaveTo(物理绝对路径的文件名);

二、模板标记语法

1、标记通用特性
(1) 短标记
{dede:tagname.name/}
等同于
{dede:tagname name='' /}
(2) 块标记
{dede:tagname}
循环代码
{/dede:tagname}

2、标记的具体语法及对应的PHP代码
(1) 配置变量
{dede:config name='' value=''/}
配置变量可以在载入模板后通过 $tpl->GetConfig($name) 获得，仅作为配置，不在模板中显示。

(2) 短标记

{dede:global.name/}   外部变量      等同于 <?php echo $name; ?>
{dede:var.name/}      var数组       等同于 <?php echo $_vars['name']; ?>
{dede:field.name/}    field数组     等同于 <?php echo $fields['name']; ?>
{dede:cfg.name/}      系统配置变量  等同于 <?php echo $cfg_name; ?>

考虑到大多数情况下都会在函数或类中调用模板，因此 $_vars、$fields 数组必须声明为 global 数组，否则模板引擎无法获得它的值从而导致产生错误。

(3) 自由调用块标记
{tag:blockname bind='GetArcList' bindtype='class'}
循环代码
{/tag:blockname}

必要属性：
bind       数据源来源函数
bindtype   函数类型，默认是 class 可选为 sub
rstype     返回结果类型，默认是 array ，可选项为 string

自定义函数格式必须为 function(array $atts,object $refObj, array $fields);
在没有指定 bind 绑定的函数的情况下，默认指向 MakePublicTag($atts,$tpl->refObj,$fields) 统一管理，这个函数存放在 cls_dede_tplinc.php 。

(4) 固定块标记

[1] datalist
从绑定类成员函数GetArcList中获取数组并输出
{dede:datalist}
循环代码
{/dede:datalist}
遍历一个二给维数组，数据源是固定的，只适用用类调用。
等同于
{tag:blockname bind='GetArcList' bindtype='class' rstype='arrayu'}
循环代码
{/tag:blockname}

[2] label
从绑定函数中获取字符串值并输出
等同于 {tag:blockname bind='func' bindtype='sub' rstype='string'/}

[3] pagelist

从绑定类成员函数GetPageList中获取字符串值并输出
等同于 {tag:blockname bind='GetPageList' bindtype='class' rstype='string'/}

(5) include 语法
{dede:include file=''/}
{dede:include filename=''/}

(6) php 代码块
{dede:php
php 代码
/}
或
{dede:php}
php代码
{/dede:php}

(7) if 条件
仅支持 if ，else ，else 直接用{else}表示,但不支持{else if}这样的语法 ，一般建议模板中不要使用太复杂的条件语法，如果确实有需要，可以直接使用 php 语法。

{dede:if 条件} a-block  {else} b-block {/dede:if}

条件中允许使用 var.name 、 global.name 、 field.name、cfg.name 表示相应的变量。

如：
{dede:if field.id>10 }
{/dede:if}

(8) 遍历一个 array 数组

{dede:array.name}
{dede:key/} = {dede:value/}
{/dede:array}

各种语法的具体编译后的代码，可查看 dede-template-class.php 的 function CompilerOneTag(&$cTag)。

块调用示例代码：
1、示例一

1 {tag:datalist  %