更优雅的处理ZBlogPHP主题的模板文件备注问题

更优雅的处理ZBlogPHP主题的模板文件备注问题

模板文件备注,是开发者一开始没有关注,到后来又被各种坑的问题。

模板设定,是建站系统中常见的设定;开发者,可以开发编写不同的模板文件,在网站的文章/分类/列表等类型中去选择模板,实现相对动态的页面效果。

不谈历史,反正我们是被系统直接读取所有PHP文件坑惨了的人。被这个问题烦恼后,我在群里闹腾了一段时间,在YT提供的正则帮助下,为模板文件中加入了类型/名称。需求最后到了ZBP的开发四人组(bang)手中,只是添加了模板中名称注释,粗暴简陋,还是会让用户在使用时,错误的选择到不适合当前类型的模板。

在这之后,考虑到模板文件中频繁的正则读取备注,性能地下的情况下,改为加入json单独为模板文件注释。

有了这个设定,那就需要设定一些规范的规则,因为JSON相对严格的数据模式;

{
    "id": "os_mylog",
    "templates": [
        {
            "filename": "index",
            "type": "list",
            "name": "列表自动模板"
        },
        {
            "filename": "single",
            "type": "single",
            "name": "文章/单页自动模板"
        },
        {
            "filename": "page-archive",
            "type": "page",
            "name": "文章归档页面"
        },
        {
            "filename": "page-link",
            "type": "page",
            "name": "友情链接页面"
        },
        {
            "filename": "page-tag",
            "type": "page",
            "name": "标签云页面"
        }
    ]
}

虽然在后面的读取操作中,id并没有使用,但考虑到冗余问题,暂时先加入id的设定。

templates是一个模板文件数组,其中每一个对象代表了一个可用的模板设定。filename字段为文件名,*不加.php;type字段为类型,用于区分不同位置;name字段为模板名称描述。

关于type类型的设定:

all:全部类型可用;

single:文章或单页中可用;

list:所有列表类型可用,分类/标签/日期/作者页等;

其余类型设置与系统设定相同


添加完模板设定以后,我们还需要处理这个设定;处理流程:

1、尝试读取json文件,转为对象数据;

2、判断当前编辑的类型,匹配显示对应内容;

3、组成新的html,通过JS语句,替换掉原先的模板下来框选择内容;

这些处理,我们就单独阐述方法了,我将这个php放出来,在include.php中引用这个文件即可(当然,你要替换掉我的模板id前缀,避免变量名污染)。

在include.php中,我们在ActivePlugin_xxxxx函数中,接入接口;

Add_Filter_Plugin('Filter_Plugin_Edit_Response3','os_mylog_OutputTemplateSelect');
Add_Filter_Plugin('Filter_Plugin_Category_Edit_Response','os_mylog_OutputTemplateSelect');
Add_Filter_Plugin('Filter_Plugin_Tag_Edit_Response','os_mylog_OutputTemplateSelect');
Add_Filter_Plugin('Filter_Plugin_Member_Edit_Response','os_mylog_OutputTemplateSelect');


json需要严格编写,如果自己不能确定是否符合规范,可以在www.bejson.com这个网站中验证。


templat.php下载