phpcms v9 二次开发之构建模块全过程 by cubeking

第一：开发流程

为你的phpcms创建一个模块的一般开发流程是：

创建数据库和数据表；（没有数据库操作可略过）

创建模块目录

创建模块控制器类；

创建模块类与模块函数；（如果只是简单的模块可以不必创建）

创建模板文件；

运行和调试。

第二：创建模块

phpcms v9框架中的模块，位于phpcms/modules目录中 每一个目录称之为一个模块
如果要创建一个模块，只要在 phpcms/modules 目录下创建文件夹并放入你的控制器类就可以了。

例如我要开发一个叫做test的模块，那么首先在 phpcms/modules 目录下创建文件夹，并将其命名为test。

test模块的标准结构通常是这样的。

其中

classes为模块类库包

 

functions为模块函数库包

 

templates为模块模板包这里通常放置含有权限控制的控制器模板，也就是后台模板。

如果您的模板有单独的前台模板，你需要在phpcms\templates\default下创建一个您的模块目录来放置前台模板，"default"为你的风格包名称，我们默认适用default
 

 第三：创建模块控制器类

在创建模块中我们已经创建好了一个名为“test”的模块，接下来我们继续为这个模块添加两个控制器类。

phpcms v9的控制器就是模块的类文件，位于phpcms/modules/模块/目录下面。类名成就是文件名+.php，例如一个名为mytest的控制器,那么他的命名为mytest.php即可。控制器类默认继承系统的函数库，可以直接使用。控制器类的类名称与控制器文件名必须相同。

控制器类文件包含两种形式：

1.mytest.php 控制器，前台浏览（不含权限控制）

<?php 
　　defined('IN_PHPCMS')orexit('No permission resources.'); 
　　classmytest{ 
　　　　function__construct(){ 
　　　　} 
　　　　publicfunctioninit(){ 
　　　　　$var='hello world!'; 
　　　　　echo $myvar; 
 　　　　}

 

　　　　publicfunctionmylist(){ 
　　　　　$var='hello world!this is a example!'; 
　　　　　echo $myvar; 
 　　　　} 
　　} 
?>

这个控制器的url访问方法前面已经介绍过了，
 

http://www.yourname.com/index.php?m=test&c=mytest 
http://www.yourname.com/index.php?m=test&c=mytest&a=mylist

没有填写 “a” 的情况下，默认调用init方法

2.mytest_admin.php 控制器，后台管理(含权限控制)
 
后台控制控制器需要加载admin模块下的admin类，并继承该类。需要注意的是因为你添加的控制器类继承了其他的类，你要小心你控制器的方法名不要和该类中的方法名一样了，否则会造成影响，具体请查看admin类中有哪些方法。

<?php 
defined('IN_PHPCMS')orexit('No permission resources.'); 
pc_base::load_app_class('admin','admin',0); 
classmytest_adminextendsadmin{ 
　　publicfunction__construct(){ 
　　} 
　　publicfunctioninit(){ 
　　　　$myvar='oh,i am phpcmser'; 
　　　　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='hello world!'; 
　　　　　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,i am phpcmser'; 
　　　　include $this->admin_tpl('mytest_admin_list'); 
　　} 

第四：创建数据库模型类

数据库模型位于：phpcms/model/ 目录下。

数据模型文件的命名规则建议为数据表名称+'_model.class.php'

如果在我们的创建的模块中我要使用一个数据库“test”，首先需要建立一个数据库模型文件，文件名称为'test_model.class.php'

内容如下：

 

<? php

 

　　 defined ( 'IN_PHPCMS' ) or exit ( 'No permission resources.' );

 

　　 pc_base :: load_sys_class ( 'model' , '' , 0 );

 

　　 class test_model extends model {

 

　　　　 public function __construct () {

 

　　　　 $this -> 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' );

来加载。

具体如下

<? php

　　 defined ( 'IN_PHPCMS' ) or exit ( 'No permission resources.' );

　　 class mytest {

　　　　 private $db ;

　　 　　 function __construct () {

　　　　　　 $this -> 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中方法