phpcmsv9二次开发手册.docx
《phpcmsv9二次开发手册.docx》由会员分享，可在线阅读，更多相关《phpcmsv9二次开发手册.docx（35页珍藏版）》请在冰豆网上搜索。
phpcmsv9二次开发手册
PHPCMS二次开发教程
文件目录结构
根目录
| – 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图标
PHPCMSV9核心文件说明
模块与控制器
模块：
phpcmsv9框架中的模块，位于phpcms/modules目录中每一个目录称之为一个模块。
即url访问中的m。
访问content模块示例：
控制器：
phpcmsv9的控制器就是模块的类文件，位于phpcms/modules/模块/目录下面。
类名成就是文件名+.php，例如一个名为abc的控制器,那么他的命名为abc.php即可。
控制器类默认继承系统的函数库，可以直接使用。
控制器类的类名称与控制器文件名必须相同。
如果您创建了一个abc.php在test模块下，那么我们在浏览器里面输入URL：
c=abc
二次开发技巧
如果要对已存在的控制器进行二次开发，为了方便升级不建议直接对内核文件直接修改该，您可以通过“MY_*.php”的形式进行二次开发。
例如您要对改phpcms/mood/index.php进行二次开发。
您可以在与index.php同级的目录下建立"MY_index.php"
php
classMY_indexextendsindex{
function__construct（）{
parent:
:
__construct（）;
}
……yourcode
}
这样当您通过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
php
define（'PHPCMS_PATH',dirname（__FILE__）.DIRECTORY_SEPARATOR）;
includePHPCMS_PATH.'/phpcms/base.php';
pc_base:
:
creat_app（）;
>
这段代码首先加载了phpcms框架的引导文件base.php，然后它根据指定的配置文件建立了一个Web应用实例并运行。
PHPCMS框架入口文件：
文件路径：
根目录/phpcms/base.php代码片段如下：
php
define（'IN_PHPCMS',true）;
define（'PC_PATH',dirname（__FILE__）.DIRECTORY_SEPARATOR）;
if（!
defined（'PHPCMS_PATH'））define（'PHPCMS_PATH',PC_PATH.'..'.DIRECTORY_SEPARATOR）;
define（'CACHE_PATH',PHPCMS_PATH.'caches'.DIRECTORY_SEPARATOR）;
……
>
该文件为框架入口文件，包含实例化系统/模块类方法，调用系统/模块方法，系统常用常量等。
如：
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代码片段如下：
php
functionnew_addslashes（$string）{
if（!
is_array（$string））returnaddslashes（$string）;
foreach（$stringas$key=>$val）$string[$key]=new_addslashes（$val）;
return$string;
}
……
>
该文件中的函数，为全系统基础函数，可以在系统中直接调用。
二次开发技巧:
如果需要增加自己的全局函数，可根据需要增加到/phpcms/libs/functions/global.func.php/extention.func.php中，不会影响升级
数据模型基类：
文件路径：
根目录/phpcms/libs/classes/model.class.php代码片段如下：
php
pc_base:
:
load_sys_class（'db_factory','',0）;
classmodel{//数据库配置
protected$db_config='';//数据库连接
protected$db='';//调用数据库的配置项
protected$db_setting='default';//数据表名
protected$table_name='';//表前缀
public$db_tablepre='';
……
>
加载数据模型后，可以的数据库该类中方法进行数据库操作。
表单调用类：
文件路径：
根目录/phpcms/libs/classes/form.class.php。
代码片段如下：
php
classform{
//编辑器调用
publicstaticfunctioneditor（$textareaid='content',$toolbar='basic',$module='',$catid='',$color='',$allowupload=0,$allowbrowser=1,$alowuploadexts='',$height=200,$disabled_page=0）{
}
//图片上传调用
publicstaticfunctionimages（$name,$id='',$value='',$moudle='',$catid='',$size=50,$class='',$ext='',$alowexts='',$thumb_setting=array（）,$watermark_setting=0）{
}
……
>
通过实例化该类可以，调用在程序中调用编辑器、表单上传、日期选择、栏目结构等表单。
实例化方法：
pc_base:
:
load_sys_class（'form','',0）;
模板解析缓存类：
文件路径：
根目录/phpcms/libs/classes/template_cache.class.php。
代码片段如下：
php
finalclasstemplate_cache{
publicfunctiontemplate_compile（$module,$template,$style=‘default’） {
$tplfile=$_tpl=PC_PATH.'templates'.DIRECTORY_SEPARATOR.$style.DIRECTORY_SEPARATOR.$module.DIRECTORY_SEPARATOR.$template.'.html';
……
?
>
该类作用为解析模板，解析模板及更新模板缓存
PHPCMSV9二次开发
PHPCMSURL访问：
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.php'
php
defined（'IN_PHPCMS'）orexit（'Nopermissionresources.'）;
pc_base:
:
load_sys_class（'model','',0）;
classtest_modelextendsmodel{
publicfunction__construct（）{
$this->db_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模块示例：
创建模块控制器类
为test模块增加一个名为myest的控制器文件路径：
根目录/phpcms/modules/test/mytest.php。
代码片段如下：
php
defined（'IN_PHPCMS'）orexit（'Nopermissionresources.'）;
classmytest{
function__construct（）{
}
publicfunctioninit（）{
$var='helloworld!
';
echo$myvar;
}
publicfunctionmylist（）{
$var='helloworld!
thisisaexample!
';
echo$myvar;
}
}
>
常用操作列表
（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.加载前台模板
include template（'test', 'mytest', 'default'）;
7.加载后台模板
include$this->admin_tpl（'mytest_admin_list'）;
8.权限控制
后台控制控制器需要加载admin模块下的admin类，并继承该类
php
defined（'IN_PHPCMS'） or exit（'Nopermissionresources.'）;
pc_base:
:
load_app_class（'admin','admin',0）;
class mytest_admin extends admin {
//这个控制器需要登录后台才可以访问}
?
>
PHPCMSV9模板与标签
∙PC标签
∙评论模块
∙会员模块
∙友情链接模块
∙投票模块
∙公告模块
∙专题模块
∙内容模块
∙工具箱
∙json工具箱
∙xml工具箱
∙get标签
∙碎片工具箱
v9二次开发之构建模块全过程
第一：
开发流程
为你的phpcms创建一个模块的一般开发流程是：
创建数据库和数据表；（没有数据库操作可略过）
创建模块目录
创建模块控制器类；
创建模块类与模块函数；（如果只是简单的模块可以不必创建）
创建模板文件；
运行和调试。
第二：
创建模块
phpcmsv9框架中的模块，位于phpcms/modules目录中每一个目录称之为一个模块
如果要创建一个模块，只要在phpcms/modules目录下创建文件夹并放入你的控制器类就可以了。
例如我要开发一个叫做test的模块，那么首先在 phpcms/modules目录下创建文件夹，并将其命名为test。
test模块的标准结构通常是这样的。
其中
classes为模块类库包
functions为模块函数库包
templates为模块模板包这里通常放置含有权限控制的控制器模板，也就是后台模板。
如果您的模板有单独的前台模板，你需要在phpcms\templates\default下创建一个您的模块目录来放置前台模板，"default"为你的风格包名称，我们默认适用default
第三：
创建模块控制器类
在创建模块中我们已经创建好了一个名为“test”的模块，接下来我们继续为这个模块添加两个控制器类。
phpcmsv9的控制器就是模块的类文件，位于phpcms/modules/模块/目录下面。
类名成就是文件名+.php，例如一个名为mytest的控制器,那么他的命名为mytest.php即可。
控制器类默认继承系统的函数库，可以直接使用。
控制器类的类名称与控制器文件名必须相同。
控制器类文件包含两种形式：
1.mytest.php控制器，前台浏览（不含权限控制）
php
defined（'IN_PHPCMS'）orexit（'Nopermissionresources.'）;
classmytest{
function__construct（）{
}
publicfunctioninit（）{
$var='helloworld!
';
echo$myvar;
}
publicfunctionmylist（）{
$var='helloworld!
thisisaexample!
';
echo$myvar;
}
}
>
这个控制器的url访问方法前面已经介绍过了，
没有填写“a”的情况下，默认调用init方法
2.mytest_admin.php控制器，后台管理（含权限控制）
后台控制控制器需要加载admin模块下的admin类，并继承该类。
需要注意的是因为你添加的控制器类继承了其他的类，你要小心你控制器的方法名不要和该类中的方法名一样了，否则会造成影响，具体请查看admin类中有哪些方法。
php
defined（'IN_PHPCMS'）orexit（'Nopermissionresources.'）;
pc_base:
:
load_app_class（'admin','admin',0）;
classmytest_adminextendsadmin{
publicfunction__construct（）{
}
publicfunctioninit（）{
$myvar='oh,iamphpcmser';
echo$myvar;
}
}
>
在控制器中增加模板调用
phpcms可以实现完全的模板与程序分离，所以在我们的控制器程序中要加载模板，才可以更友好的显示出来。
1.加载前台模板
前台模板文件在phpcms\templates\default\模块名称目录中，本示例也就在phpcms\templates\default\test中
加载模板方法如下:
includetemplate（'test','mytest','default'）;
其中test为模块名称mytest 为模板目录下模板名称,default为风格名称，默认不填为defalut
在上面例子中如果要给mytest.php中init方法加载一个mytest的模板，如下
publicfunctioninit（）{
$var='helloworld!
';
includetemplate（'test','mytest','default'）;
}
这样我们通过url访问该方法的时候也就加载了对应的模板。
2.加载后台模板
后台模板文件在phpcms\modules\模块名称\templates目录中，本示例也就在phpcms\modules\test\templates中
加载模板方法如下：
include$this->admin_tpl（'mytest_admin_list'）;
其中mytest_admin_list为phpcms\modules\test\templates中mytest_admin_list.tpl.php，注意：
此处模板必须以.tpl.php作为后缀
在上面例子中如果要给mytest_admin.php中init方法加载一个mytest_admin_list的模板，如下
publicfunctioninit（）{
$myvar='oh,iamphpcmser';
include$this->admin_tpl（'mytest_admin_list'）;
}
第四：
创建数据库模型类
数据库模型位于：
phpcms/model/目录下。
数据模型文件的命名规则建议为数据表名称+'_model.class.php'
如果在我们的创建的模块中我要使用一个数据库“test”，首先需要建立一个数据库模型文件，文件名称为'test_model.class.php'
内容如下：
php
defined（'IN_PHPCMS'）orexit（'Nopermissionresources.'）;
pc_base:
:
load_sys_class（'model','',0）;
classtest_modelextendsmodel{
publicfunction__construct（）{
$this->db_config=pc_base:
:
load_config（'database'）;
$this->db_setting='def
升级会员 