phpcms-v9二次开发手册新增模块教程.doc

PHPCMS二次开发教程PHPCMS二次开发教程1文件目录结构1PHPCMS V9 核心文件说明2PHPCMS框架入口文件：4PHPCMS V9 二次开发6创建模块控制器类9v9 二次开发之构建模块全过程11PC标签使用说明18PC标签保留参数20get标签21内容模块22PHPCMS v9.1.7整合discuz X2 的解决办法28文件目录结构根目录| api接口文件目录| caches 缓存文件目录 | configs 系统配置文件目录 | caches_* 系统缓存目录| phpcms phpcms框架主目录 | languages 框架语言包目录 | libs 框架主类库、主函数库目录 | model 框架数据库模型目录 | modules 框架模块目录 | templates 框架系统模板目录| phpsso_server phpsso主目录| statics 系统附件包 | css 系统css包 | images 系统图片包 | js 系统js包| uploadfile 网站附件目录| admin.php 后台管理入口| index.php 程序主入口| crossdomain.xml FLASH跨域传输文件| robots.txt 搜索引擎蜘蛛限制配置文件| favicon.ico 系统icon图标PHPCMS V9 核心文件说明模块与控制器模块：phpcms v9框架中的模块，位于phpcms/modules目录中 每一个目录称之为一个模块。即url访问中的m。访问content模块示例：/index.php?m=content控制器： phpcms v9的控制器就是模块的类文件，位于phpcms/modules/模块/目录下面。类名成就是文件名+.php，例如一个名为abc的控制器,那么他的 命名为abc.php即可。控制器类默认继承系统的函数库，可以直接使用。控制器类的类名称与控制器文件名必须相同。如果您创建了一个abc.php在 test模块下，那么我们在浏览器里面输入URL：/index.php?m=test& c=abc二次开发技巧如果要对已存在的控制器进行二次开发，为了方便升级不建议直接对内核文件直接修改该，您可以通过“MY_*.php”的形式进行二次开发。例如您要对改phpcms/mood/index.php进行二次开发。您可以在与index.php同级的目录下建立MY_index.php?phpclass MY_index extends indexfunction _construct() parent:_construct();your code这样当您通过url访问index控制器的时候，系统会默认指向MY_index.php 并且原文件的方法将被继承，可以直接使用。系统配置文件 文件路径：根目录/caches/configs database.php 数据库配置文件 system.php 系统配置文件 route.php 路由配置文件 调用方法如调用系统配置中的web_path:pc_base:load_config(system, web_path );CMS入口文件：PHPCMS是采用MVC设计模式开发,基于模块和操作的方式进行访问，采用单一入口模式进行项目部署和访问，无论访问任何一个模块或者功能，只有一个统一的入口。入口程序是在前期处理用户请求的引导程序。它是唯一一个可以被最终用户可以直接请求运行的。文件路径：根目录/index.php这段代码首先加载了 phpcms 框架的引导文件 base.php，然后它根据指定的配置文件建立了一个 Web 应用实例并运行。PHPCMS框架入口文件：文件路径：根目录/phpcms/base.php 代码片段如下：该文件为框架入口文件，包含实例化系统/模块类方法，调用系统/模块方法，系统常用常量等。如：pc_base:load_model(*_model) 加载数据库模型 pc_base:load_sys_class(classname) 实例化系统类pc_base:load_app_class(classname,admin) 实例化模块类pc_base:load_sys_func (funcfile) 调用系统函数库全局函数文件：文件路径：根目录/phpcms/libs/functions/global.func.php 代码片段如下： $val) $string$key = new_addslashes($val);return $string;?该文件中的函数，为全系统基础函数，可以在系统中直接调用。二次开发技巧:如果需要增加自己的全局函数，可根据需要增加到/phpcms/libs/functions/global.func.php/extention.func.php中，不会影响升级数据模型基类：文件路径：根目录/phpcms/libs/classes/model.class.php 代码片段如下：加载数据模型后，可以的数据库该类中方法进行数据库操作。表单调用类：文件路径：根目录/phpcms/libs/classes/form.class.php。 代码片段如下：通过实例化该类可以，调用在程序中调用编辑器、表单上传、日期选择、栏目结构等表单。 实例化方法：pc_base:load_sys_class(form, , 0);模板解析缓存类：文件路径：根目录/phpcms/libs/classes/template_cache.class.php 。 代码片段如下：该类作用为解析模板，解析模板及更新模板缓存PHPCMS V9 二次开发PHPCMS URL访问：PHPCMS是采用MVC设计模式开发,基于模块和操作的方式进行访问，采用单一入口模式进行项目部署和访问，无论访问任何一个模块或者功能，只有一个统一的入口。参数名称 描述 位置 备注 M 模型/模块名称 phpcms/modules中模块目录名称 必须 C 控制器名称 phpcms/modules/模块/*.php 文件名称 必须 A 事件名称 phpcms/modules/模块/*.php 中方法名称 模块访问方法示例：二次开发命名规范类文件需要以.class.php为后缀（这里是指的phpcms的系统类库文件和模块中的类库文件，第三方引入的不做要求），例如http.class.php。函数文件需要以.func.php为后缀（第三方引入的不做要求），例如mail.func.php。类名和文件名一致，例如 phpcmsapp类的文件命名是phpcmsapp.class.php。数据模型需要以“数据表名称_model.class.php”为形式，类名称与文件名必须相同。二次开发开发流程创建数据库模型类数据库模型位于：phpcms/model/目录下。数据模型文件的命名规则建议为数据表名称+_model.class.php如果在我们的创建的模块中我要使用一个数据库“test”，首先需要建立一个数据库模型文件，文件名称为test_model.class.phpdb_config = pc_base:load_config(database);$this-db_setting = default;$this-table_name = test;parent:_construct();?数据库模型类名称必须与文件名称相同；$this-db_setting = default为数据库配置文件中配置数据库链接池名称，默认为default，一般情况下不需要修改。$this-table_name = test为数据表名称创建模块如果要创建一个模块，只要在 phpcms/modules 目录下创建文件夹并放入你的控制器类就可以了。例如要开发一个叫做test的模块，那么首先在phpcms/modules 目录下创建文件夹，并将其命名为test。模块的标准结构通常是这样的。如果您的模板有单独的前台模板，你需要在phpcms/templates/default下创建一个您的模块目录来放置前台模板，default为你的风格包名称，我们默认适用default访问test模块示例：/index.php?m=test创建模块控制器类为test模块增加一个名为myest的控制器 文件路径：根目录/phpcms/modules/test/mytest.php。 代码片段如下：常用操作列表(1)1.调用数据库模型$this-db=pc_base:load_model(test_model);其中$this-db中所支持的方法请参照phpcms/libs/classes/model.class.php中方法2.加载系统类$http = pc_base:load_sys_class(http); /实例化http类pc_base:load_sys_class(format, , 0); /调用form类，不进行实例化操作3.加载系统函3.加载系统函数库pc_base:load_sys_func(mail); /调用mail函数包4.加载模块类$test = pc_base:load_sys_class(classname,test); /实例化test模块下 classname类5.加载模块函数库pc_base:load_sys_func(global,test); /调用test模块的global函数包常用操作列表(2)6.加载前台模板includetemplate(test,mytest,default);7.加载后台模板include $this-admin_tpl(mytest_admin_list);8.权限控制后台控制控制器需要加载admin模块下的admin类，并继承该类PHPCMS V9 模板与标签 PC标签 评论模块 会员模块 友情链接模块 投票模块 公告模块 专题模块 内容模块 工具箱 json工具箱 xml工具箱 get标签 碎片工具箱 以下为重点内容，可按以下说明自已构建一个新模块进行学习了解v9 二次开发之构建模块全过程第一：开发流程为你的phpcms创建一个模块的一般开发流程是：创建数据库和数据表；（没有数据库操作可略过）创建模块目录创建模块控制器类；创建模块类与模块函数；（如果只是简单的模块可以不必创建）创建模板文件；运行和调试。第二：创建模块phpcms v9框架中的模块，位于phpcms/modules目录中 每一个目录称之为一个模块如果要创建一个模块，只要在 phpcms/modules 目录下创建文件夹并放入你的控制器类就可以了。例如我要开发一个叫做test的模块，那么首先在phpcms/modules 目录下创建文件夹，并将其命名为test。test模块的标准结构通常是这样的。其中classes为模块类库包functions为模块函数库包templates为模块模板包这里通常放置含有权限控制的控制器模板，也就是后台模板。如果您的模板有单独的前台模板，你需要在phpcmstemplatesdefault下创建一个您的模块目录来放置前台模板，default为你的风格包名称，我们默认适用default第三：创建模块控制器类在创建模块中我们已经创建好了一个名为“test”的模块，接下来我们继续为这个模块添加两个控制器类。phpcms v9的控制器就是模块的类文件，位于phpcms/modules/模块/目录下面。类名成就是文件名+.php，例如一个名为mytest的控制器,那么他的命名为mytest.php即可。控制器类默认继承系统的函数库，可以直接使用。控制器类的类名称与控制器文件名必须相同。控制器类文件包含两种形式：1.mytest.php 控制器，前台浏览（不含权限控制）这个控制器的url访问方法前面已经介绍过了，/index.php?m=test&c=mytest/index.php?m=test&c=mytest&a=mylist没有填写 “a” 的情况下，默认调用init方法2.mytest_admin.php 控制器，后台管理(含权限控制)后台控制控制器需要加载admin模块下的admin类，并继承该类。需要注意的是因为你添加的控制器类继承了其他的类，你要小心你控制器的方法名不要和该类中的方法名一样了，否则会造成影响，具体请查看admin类中有哪些方法。在控制器中增加模板调用phpcms 可以实现完全的模板与程序分离，所以在我们的控制器程序中要加载模板，才可以更友好的显示出来。1.加载前台模板前台模板文件在phpcmstemplatesdefault模块名称 目录中，本示例也就在phpcmstemplatesdefaulttest中加载模板方法如下:include template(test,mytest,default);其中test为模块名称mytest为模板目录下模板名称,default为风格名称，默认不填为defalut在上面例子中如果要给mytest.php中init方法加载一个mytest的模板，如下Public function init()$var=hello world!;include template(test,mytest,default);这样我们通过url访问该方法的时候也就加载了对应的模板。2.加载后台模板后台模板文件在phpcmsmodules模块名称templates 目录中，本示例也就在phpcmsmodulestesttemplates 中加载模板方法如下：include $this-admin_tpl(mytest_admin_list);其中mytest_admin_list为phpcmsmodulestesttemplates中mytest_admin_list.tpl.php，注意：此处模板必须以.tpl.php 作为后缀在上面例子中如果要给mytest_admin.php中init方法加载一个mytest_admin_list的模板，如下Public function init()$myvar=oh,i am phpcmser;include $this-admin_tpl(mytest_admin_list);第四：创建数据库模型类数据库模型位于：phpcms/model/ 目录下。数据模型文件的命名规则建议为数据表名称+_model.class.php如果在我们的创建的模块中我要使用一个数据库“test”，首先需要建立一个数据库模型文件，文件名称为test_model.class.php内容如下：db_config=pc_base:load_config(database);$this-db_setting=default;$this-table_name=test;parent:_construct();?注意：1.数据库模型类名称必须与文件名称相同；2.$this-db_setting = default为数据库配置文件中配置数据库链接池名称，默认为default，一般情况下不需要修改。3.$this-table_name = test为数据表名称这样我们就建立好了一个数据库模型类。在模块的控制器中使用$this-db=pc_base:load_model(test_model);来加载。具体如下db=pc_base:load_model(test_model);Public function init()$result=$this-db-select();var_dump($result);?其中$this-db中所支持的方法请参照phpcms/libs/classes/model.class.php中方法PC标签使用说明在PHPCMS V9中我们正式开始需要PC标签做为数据的获取的方式。PC标签是以下面的方式进行声明pc:content action=lists cache=3600 num=20 page=$page/pcPC标签必须以pc开头，并以/pc结尾的代码片段。当然不以/pc结尾并不会引起程序致命性的错误，导致程序无法继续运行。以下为两种已知可能会出现的问题：1. 当网页中出现两个PC标签时，可能会使得没有闭合的PC标签之后的PC标签数据和其混乱。2. 在后台可视化编辑时，可能出现网页结构错乱的问题。PC标签分析：PC标签中pc:冒号之后跟随的为模块名。如上面的例子中调用的是内容模型的PC标签。action=list这个形式所代表的是参数。每一个PHPCMS V9模型都为其PC标签定义了调用的参数。其中有一些调用参数是系统保留的参数，其对所有的PC标签都是有效的。参数必须使用参数名=参数值的方式填写，多个参数之间使用空格分开（如下例），参数值可使用双引号来包括，无论是什么形式的引号都必须是成对出现的。pc:content 参数名=参数值 参数名=参数值 参数名=参数值请查看PC标签保留参数相关章节，以了解具体保留参数及其用途。PC标签分类：PC标签包含两个类别，分别为：1. 工具类2. 模块类工具类，大体上可以理解为PHPCMS V9所提供的一些工具箱。请查看PC标签工具箱相关章节，以了解更多关于工具类的PC标签的更多信息。而模块类，是PHPCMS V9各个模型提供给大家调用模块数据的数据接口。查看具体模块的相关说明章节，以了解更多关于模块类的PC标签的更多信息。如何显示PC标签中的数据：默认情况下PC标签中的数据都是数组方式返回的，你都可以通过 $data 来获取到这个数组，如果你在PC标签中定义了return参数，返回的数组将使用return的值进行命令。一般情况下你可以使用如下的方式来显示值：loop $data $key $val$valtitle/loop基中的$valurl和$valtitle需要具体根据所使用的PC标签，返回的数据来判断。PC标签保留参数下表为PC标签保留参数表，几乎所有的PC标签都支持这些保留参数设置变量名默认值说明actionnull本参数的值表示为操作事件，模型类PC标签必须使用包含本参数，以说明要进行的操作。cache0缓存存储时间（单位秒）num20获取记录的条数，最后会被模板引擎处理成limit传送到处理函数中。pagenull当前分页。一般填写为$_GETpageurlrulenullURL规则returndata返回数据变量名下例中是一个完整的使用例子。pc:content action=lists catid=25 num=20 page=$_GETpage return=dataloop $data $n $r$rtitle/loop/pcget标签GET标签源自于PHPCMS 2008版，其使用SQL语句直接获取数据的特性，成为大家制作模板的首选。在V9中这样强大的工具也得到保留下来。GET标签使用方式如下：pc:get sql=SELECT * FROM phpcms_member cache=3600 page=$page dbsource=discuz return=dataloop $data $key $val$valusername/loop$pages/pc从上面的代码里面可以看出GET标签所支持的参数。对照下面的列表了解每一个参数的用途：参数默认值必须说明sqlnull是要执行的SQL语句cache0否缓存时间，单位为秒page0否分页，通过变量把当前的分布传给PC标签进行处理dbsourcenull否数据源，当你通过系统后台的数据源模块配置过数据源时，可把数据源名填写到这里，系统会去对应的数据源来读取数据。如果要读取本系统的数据请留空returndata否返回的数据的变量内容模块内容模块PC标签调用说明模块名：content模块提供的可用操作操作名说明lists内容数据列表relation内容相关文章hits内容数据点击排行榜category内容栏目列表position内容推荐位列表position操作说明如下：内容推荐位列表（position）：可用参数：参数名是否必须默认值说明posid是null推荐位IDcatid否null调用栏目IDthumb否0是否仅必须缩略图order否null排序类型num是null数据调用数量代码例子：pc:content action=position posid=2 order=listorder DESC num=4loop $data $key $val $valtitle/loop/pc返回参数如下表：字段类型空默认注释titlechar(80)否NULL推荐位标题urlchar否NULL推荐位链接地址inputtimeint(10)否NULL推荐位发布时间thumbchar是NULL推荐位缩略图其他不定是根据模型所设置的加入到推荐位中字段名称内容列表（lists）：可用参数：参数名是否必须默认值说明catid否null调用栏目IDwhere否nullsql语句的where部分thumb否0是否仅必须缩略图order否null排序类型num是null数据调用数量moreinfo否0是否调用副表数据提醒：从PHPCMS V9 Beta 20101105版本开始支持moreinfo参数属性，本参数表示在返回数据的时候，会把副表中的数据也一起返回。一个内容模型分为2个表，一个主表一个副表，主表中一般是保存了标题、所属栏目等等短小的数据（方便用于索引），而副表则保存了大字段的数据，如内容等数据。在模型管理中新建字段的时候，是允许你选择存入到主表还是副表的（我们推荐的是，把不重要的信息放到副表中）。想要在列表中调取副表的数据就需要在PC标签中使用moreinfo这个属性。代码例子：pc:content action=lists catid=2 order=id DESC num=4loop $data $key $val $valtitle/loop/pcwhere用法：pc:content action=lists catid=2 where=thumb!= AND status=99 order=id DESC num=4loop $data $key $val $valtitle/loop/pc返回参数如下表：字段类型空默认注释titlechar(80)否NULL推荐位标题urlchar否NULL推荐位链接地址inputtimeint(10)否NULL推荐位发布时间thumbchar是NULL推荐位缩略图其他不定是其他模型字段点击排行榜（hits）：可用参数：参数名是否必须默认值说明catid否null调用栏目IDday否0调用多少天内的排行order否null排序类型（本月排行- monthviews DESC 、本周排行 - weekviews DESC、今日排行 - dayviews DESC）num是null数据调用数量代码例子：pc:content action=hits catid=2 order=weekviews DESC num=10loop $data $key $val $valtitle/loop/pc返回参数如下表：字段类型空默认注释titlechar(80)否NULL推荐位标题urlchar否NULL推荐位链接地址inputtimeint(10)否NULL推荐位发布时间thumbchar是NULL推荐位缩略图其他不定是其他模型字段相关文章（relation）：可用参数：参数名是否必须默认值说明catid否null