ThinkPHP5.1自定义标签的使用

近来有项目需要用的自定义的标签，TP使用的是5.1，各位要注意，5.1较5.0在目录结构和程序上有较大的改动。注意自己的版本。下面进入正题。

一、创建标签函数文件

在模型目录下创建目录 tabLib，在目录里创建一个Cms.php 

namespace app\cms\tagLib;
use think\Db;
use think\template\TagLib;

class Cms extends TagLib{

    protected $tags = [
        //标签定义： attr 属性列表，close 是否闭合（0或1，默认1），alias标签别名 level嵌套层次
        'lists' => ['attr' => 'num,order,sort'],
    ];

    // 当不使用content的时候，闭合标签没有效果
    // 修改过此文件后，需要改动下模板的内容，否则模板有缓存不会执行新的内容。
    public function tagLists($tag,$content){
        $cateID = $tag['cate_id']; //栏目ID
        $num    = $tag['num']; //数量
        $order  = input($tag['order']); //排序方式
        $type = $cateID;
        $name = $tag['name'];
        $tableName = 'table_name';
        $parse = '<?php $map=[];';
        $parse .= '$__LIST__ = Db::name('.$tableName.')->where(["cate_id"=>'. $cateID .'])
            ->limit('.$num.')
            ->select(); ?>';
        $parse .= '{volist name="__LIST__" id="'. $name .'"}';
        $parse .= $content;
        $parse .= "{/volist}";
        return $parse;
    }

在开发中遇到疑惑：

1. 上面的tagLists 函数对应 protected $tags中的标签定义，大小写要注意，否则是找不到函数的。

2. $parse 字符中全部为组装的字符串，该字符串会被TP的模板标签再解析一次，所以在里面可以使用TP原有的标签或原生的PHP语句。但是不可以把外面的Array或对象做为参数传入$param中，要知道他只是一个用来组装的字符串。请注意 $__LIST__这个变量的使用，要想从数据库中读取数据，必须写完整的PHP代码，不可以在外面执行完查询，然后把查询后的list做为变量传入。

 

二、在模板配置信息中加载此标签函数

在模块 cms/config/template.php 中加入一句： 'taglib_pre_load' => 'app\cms\tagLib\Cms',

如果你没有此文件，可以在根目录里的config目录下，复制一份template放到cms/config目录下。

三、在模板中使用标签。

  {cms:lists name="row" num="10" cate_id="5" order="1"}
        <li>{$row.title}</li>
    {/cms:lists}

name, num ,cate_id 等属性会作为tagLists的第一个参数 $tags传入。而{cms:lists} 和 {$/cms:lists}之间的内容，会作为一个完整的字符串$content 传入 tagLists 的第二个参数。

注意：这里分闭合标签和非闭合标签，如果是闭合标签，则必须在（一）中使用content,如果是非闭合标签则可以不用。如果你不使用content变量，则闭合的标签 {/cms:lists}会被原样输出，不会进行解析。

 

暂时有这么多的困惑，关于分页列表的问题还在研究，研究完了再补充上来。

补充：在tagList中不要对$tag[]数组中获取到的数据进行数据类型转换，因为当传过来的是一个变量时，这个变量不会生效！！所以在这里使用intval($tag[num])是不对的。