【shopex】真正可用的app开发机制

shopex的app开发机制详解

 

网上流传的shopex4.8.5的app开发教程，不仅说得不明不白，而且由于版本问题，照着做根本是做不成的。

知其然，亦要知其所以然。

---

shopex提供了的一个干净的机制让开发者扩展或修改功能-app开发机制，让我们可以实现以下特性：

1、建立自己的数据库表。
 2、创建自己的控制器。
 3、在前后台增加栏目。
 4、用自己的控制器替换系统默认的（自定义业务流程）。
 5、添加事件侦听器，使得系统事件时调用自己的代码。

可以看到，这基本相当提供给大家一个简单的php框架了。下面说下技术细节。

每个程序包占一个目录。 我们推荐将所有的包都放置在plugins/app文件夹下。下面用个例子, 阐述下功能包的各个控制点。假设这个文件夹的名字为：demo， 包里面必须有一个 app.demo.php。并且里面必须含有一个 app_demo的类。该类需要继承app这个基类。

下面我们一个小例子来阐述下这种app功能包基本开发步骤：

1、在网站根目录的/plugins/app目录下创建demo目录，那么同时这个文件下面就必须要有个app.demo.php文件，此文件可以如下定义：

 <?php
 class app_demo extends app{

     var $ver = 0.8;
     var $name='样例程序';
     var $website = 'http://www.shopex.cn';
     var $author = 'dev@shopex.cn';

     //可选函数
     //定义接管系统哪些流程，由自身的哪个类/方法去执行
     //本例表示，启用后前台将把所有访问购物车的控制器请求重定向
     //到本软件包内 democtl对象的cartidx方法里。
     function ctl_mapper(){
         return array(
             'shop:cart:index' => 'ctl:cartidx',//注意这里，文档是使用demo_ctl需要加app命名_前缀，实际不需要
         );
     }

     //可选函数
     //侦听系统哪些事件
     //此处可用关键字any表示所有事件
     //本例表示：
     //侦听订单新建事件 -> 调用event_handle类的order_new方法执行
     //侦听会员新建事件 -> 调用event_handle类的member_create方法执行
     function listener(){
         return array(
             'trading/order:create' =>
                 'demo_event_handler:order_new',

             'member/account:register' =>
                 'demo_event_handler:member_create',

             //'any'=>'demo_event_handler:any',
         );
     }

     //可选函数, 返回需要建表的信息
     //本例是建立两个表, 系统会自动加前缀 sdb_<ident>
     function dbtables(){
         $tables['table_2'] = array (
             'columns' =>
             array (
                 'controller' =>
                 array (
                     'type' => 'varchar(100)',
                     'required' => true,
                     'pkey' => true,
                     'editable' => false,
                 ),
                 'plugin' =>
                 array (
                     'type' =>'varchar(100)',
                     'required' => true,
                     'editable' => false,
                 ),
             ),
         );
         $tables['table_1'] = array (
             'columns' =>
             array (
                 'controller' =>
                 array (
                     'type' => 'varchar(100)',
                     'required' => true,
                     'pkey' => true,
                     'editable' => false,
                 ),
                 'plugin' =>
                 array (
                     'type' =>'varchar(100)',
                     'required' => true,
                     'editable' => false,
                 ),
             ),
         );
         return $tables;
     }

     //我承认这是个非常邪恶的设计...
     //但你要承认它可以让你无所不能
     function output_modifiers(){
         return array(
          'admin:goods/product:index'=>'modifiers:product_edit'
         );
     }

     //重载安装时的方法...
     //同样可重载的还有：
     //   uninstall -> 卸载
     //   enable -> 程序启动
     //   disable -> 程序关闭
     function install(){
         //别忘了调用父类的install
         return parent::install();
     }

 }

2、为了防止命名冲突，请使用自己包的名字作为类的前缀，文件plugins/app/demo/demo_event_handler.php，这里的是对应上面的app.demo.php定义的与系统的本身的方法对接，该文件的代码如下：

 <?php
 class demo_event_handler{

     //订单新建时本方法将被自动执行
     //此处event被赋值为 order:new
     function order_new($event_type,$order_data){
         ...
     }

     //会员新建时本方法将被自动执行
     //此处event被赋值为 order:new
     function member_create($event_type,$member_data){
         ...
     }

     //任何事件都将调用此函数
     function any($event_type,$event_data){
         ...
     }
 }

3、例如与前台购物车操作对接，我们可以定义一下文件来实现此功能，如文件plugins/app/demo/demo_ctl.php，代码如下：

*注意，旧版是继承app_page类，实际上并没有这个类文件，真正要操作前台页面，需要继承shopPage类，且不需额外加载。

 <?php
 class demo_ctl extends shopPage{

     function cartidx(){
         //输出模板：软件包文件夹里的cart.html
         //$this->system; //可以调用系统入口
         //$this->db; //可以直接使用数据库

         //载入包里的类...
         //require(dirname(__FILE__).'/demo_my_model_layer.php');
         //$obj = new demo_my_model_layer;

         $this->output('view/cart.html');
     }

 }

4、建立一个类来重定义购物车页面用关键字<{$_BASE_PATH_}>可以定位到插件文件夹的url,如我们建立一个模板文件plugins/app/demo/view/cart.html在文件里面我们就可以使用此关键词

<p>
例如输出<br />
plugins/app/demo/images/cart.png
</p>

<img src="<{$_BASE_PATH_}>/images/cart.png" />

5，附：【过滤器】将后台商品列表页面的“新建商品”按钮上的文字换掉。

<?php
class demo_modifiers{
    function product_edit( &$content ){
        return str_replace('添加商品','别看我是只羊！',$content);
    }
}

6,此时后台工具箱->插件与扩展->刷新插件数据库->应用中心 你就可以看到你新增的插件，点击启用，即进入安装流程：

确认后打开你所接管的控制器方法，如例子中的购物车首页，你会发现并没有成功，而是提示

对不起，无法找到您访问的页面，请返回重新访问。

其实这就是shopex代码和手册的矛盾之处，系统核心是只能加载app对象的index方法action，手册上写明可以接管系统流程具体到某个action，否则app就失去了他的意义了。

要修改有两种方法：

1，在demo_ctl，即app前台控制器，以index方法为入口，去操作其他类方法（毕竟核心文件已加密，改不了）；

2，修改kernel.php，在callAction方法中将

list( $objCtl, $act_method ) = $appmgrMdl->get_func( substr( $value, 0, strrpos( $value, ":" ) ).":".$act_method );
修改为：
list( $objCtl, $act_method ) = $appmgrMdl->get_func( $value );

然后继续愉快地开发app扩展。