ECMall插件开发指南

ECMall2.0插件开发指南

Copyright?shop https://www.360docs.net/doc/3f12761744.html,

本文档面向程序开发者及爱好者

文档历史

日期版本作者描述

2009/8/14 1.0Garbin Huang创建文档

前言

本文档主要面向有一定程序基础的开发人员和技术爱好者，旨在帮助其快速入门ECMall V2.0的插件开发。通过阅读本文档，您还可以了解到插件的开发规范，快速地制作出符合规范的插件。阅读本文档需要您具备一定的PHP编程基础，特别是面向对象的编程知识，如“类”，“对象”，“派生”等概念。

目录

前言 (2)

目录 (3)

1.定义 (4)

1.1.什么是插件 (4)

1.2.ECMall插件的特点 (4)

1.3.可以用插件实现哪类功能 (4)

2.插件的构成 (4)

2.1.文件构成 (4)

2.2.代码构成 (5)

3.编写插件实例 (5)

3.1.创建一个插件 (5)

3.2.实现主体代码 (6)

3.3.使用和调试 (6)

4.发布分享您的插件 (7)

5.附录 (7)

https://www.360docs.net/doc/3f12761744.html,.php中可用的信息 (7)

5.2.插件类中可用的成员及函数 (8)

5.3.目前可用的勾子列表 (8)

1.插件的定义

1.1.什么是插件

插件是一种嵌入原始程序用以改变原始程序特定功能的程序。

ECMall插件的特点

1.2.ECMall

1.2.

传统的Web应用程序要实现改变原始程序的功能需要在指定原始程序的代码文件上修改以达到目的。这种修改原始文件代码以实现插件功能的方法造成了一个问题，一旦程序升级，正常情况下您都需要重新修改之前的改动。若新升级的程序改动不大，您可能只需要将之前改动的地方复制粘贴在新程序上，而若新升级的程序改动比较大，则可能导致您需要重新制作插件。可维护性比较低。

ECMall的插件机制将插件代码文件从原始程序文件分离出来，大大增加了插件的可维护性，即使是升级程序也不再需要您再做重复编写插件的劳动，每个插件都可单独维护，随意启用禁用。

ECMall的插件机制拥有统一的插件勾子，具有统一性，有利于插件的分享，您写的插件正常情况下，您可以简单打包发布与其他用户分享，同时也增加了插件的可维护性。

1.3.可以用插件实现哪类功能

从大的范围上讲，我们可以利用插件实现诸如：改变原始程序控制流程，改变原始程序数据的功能。例如，您可以利用插件实现让商品详情内容支持UBB代码，您还可以利用插件实现让用户在登录或退出后根据不同条件跳到指定地址或显示不同的模板。

大体上讲，利用插件可以方便实现以下两类功能：

①改变原始数据内容

②改变原始控制流程

2.插件的构成

2.1.文件构成

插件是由一组代码文件构成的，插件被放置于./external/plugins目录，每个插件在plugins目录中表现为一个目录。每个插件至少包含两个文件：https://www.360docs.net/doc/3f12761744.html,.php，main.plugin.php 表格：插件的文件构成

文件描述

2.2.代码构成

每个插件在程序中都是一个从BasePlugin 插件基础类派生出的子类，该类至少拥有以下成员方法

表格：插件的代码构成3.编写插件实例

我们就以店铺地址简写插件来给大家展示创建一个插件的过程。该插件可在ECMall 安装包中的./upload/external/plugins 目录中找到。

3.1.创建一个插件

首先，创建一个名为“short_store_url ”的目录。

然后，在该目录下分别创建main.plugin.php 和https://www.360docs.net/doc/3f12761744.html,.php 两个文本文件。

至此该插件的必要文件构成都已准备完毕。接下来，我们需要完成该插件的描述信息。将插件信息写入https://www.360docs.net/doc/3f12761744.html,.php ，以下代码及相关注释供您参考：在这里我们设置了hook 为on_run_action ，表示该插件在运行action 之前运行。

至此，插件的描述信息就完成了，本例功能比较简单，该描述信息还可以描述插件需要的配置项，可以在用户启用插件时展示相应的配置表单，并可保存自定义的配置项供插件使

main.plugin.php 插件主体代码文件https://www.360docs.net/doc/3f12761744.html,.php

插件描述信息文件

变量/方法描述

execute()

插件运行入口，具体插件的代码在这里实现

用，更具体的信息请参看附录：https://www.360docs.net/doc/3f12761744.html,.php中可用的信息。

3.2.实现主体代码

每个插件都是BasePlugin插件基础类的派生类，每个插件的类必须遵循：

①命名规则：“插件唯一标识首字母大写”+“Plugin

Plugin””，如本例中唯一标识为“short_store_url”则其类名为“Short_store_urlPlugin”。

②该类必须是从“BasePlugin”类直接或间接继承。

③必须拥有execute方法，该方法是插件的执行入口

下面我们来具体实现本例的主体代码，以下代码及相关注释供参考：Array

3.3.使用和调试

现在我们已经完成了该示例插件，您现在只需要将该目录上传至您商城的

./external/plugins/目录即可登录商城后台->扩展->插件管理启用和调试您的插件了。

4.发布分享您的插件

发布您的插件仅需简单地将您制作的插件目录打包发布即可。由于ECMall共有四种语言编码版本，因此，为了让您的插件可以被更多的人使用，我们推荐您将插件转换成四种语言编码的版本后再将其分别打包发布。

5.附录

5.1.

https://www.360docs.net/doc/3f12761744.html,.php

https://www.360docs.net/doc/3f12761744.html,.php中可用的信息

名称描述示例

id唯一标识，必须

与插件目录名保

持一致

test

hook插件勾子on_run_action

name插件名称测试插件

author插件作者Garbin Huang

website作者网站https://www.360docs.net/doc/3f12761744.html,

版本V1.0

desc描述这只是一个测试插件

config配置表单描述，

在启用配置插件

时将依据此处配

置显示表单array(

'test_text'=>array(

'text'=>'测试配置',//输入框标题

'type'=>'text',//文本输入框

'siz e'=>3,//宽度3

),

'test_select'=>array(

'text'=>'测试配置选项',

'type'=>'select',//选择控件

'items'=>array(//可选项,cn为值，“中国”为显示的名称

'cn'=>'中国','us'=>'美国',

),

),

'test_textarea'=>array(

'text'=>'测试多行文本',

'type'=>'textarea',//多行文本框

'cols'=>30,//列30

'rows'=>5//行5

),

'test_radio'=>array(

'text'=>'测试单选框',

'type'=>'radio',//单选框

'name'=>'config[test_radio]',//在表单域中

的名称，在此必须指定且形如config[配置项名]

'items'=>array(//可选值，“1”为

值,“yes”为显示的文本

1=>'yes',0=>'no'

),

),

'test_checkbox'=>array(

'text'=>'测试复选框',

'type'=>'checkbox',//复选框

'name'=>'config[test_checkbox][]',//在此必

须指定且形如config[配置项名][]

'items'=>array(//“apple”为值，“苹果”

为显示的文本

'apple'=>'苹果','banana'=>'香蕉'

),

),

),

5.2.插件类中可用的成员及函数

成员/方法描述

$data有些插件勾子会给插件开放可修改的数据，这些数据被存储在$this->data 中，您只需要使用普通的赋值方法即可改变插件勾子所开放的数据。如插

件勾子开放的数据访问名为menu，则使用$this->data['menu']即可访问到

该数据。

$config有些插件需要在用户启用的时候进行配置，这些配置项就存放在该变量中，只需要使用$this->config访问该变量就可以获取用户启用时所提交的

配置。

assign()为模板赋值，例如$this->assign('example','示例');就给模板赋值了一变量名为“example”值为“示例”的变量。

display()显示模板，例如$this->display('example.html');就可以在当前程序流程中显示一个模板，需要注意的是，显示的模板的位置依赖于插件运行时的控制

器。如后台，则显示的模板在./admin/templates目录下，前台则在对应的

模板风格目录。

5.3.目前可用的勾子列表

勾子作用范围开放的数据描述

on_load_adminmenu后台menu该勾子在后台获取后台管理菜单处，开放

菜单数据给插件，您可以通过修改菜单数

据以达到增删后台菜单项的目的。

on_run_action全局-该勾子对于ECMall全局都有效，这意味

着，若您不在插件实现代码中限制，该插

件将会在前后台都起作用，该勾子处于

action被运行前，您通常可以在需要阻止

或改变用户动作时利用此勾子，具体可参

考“店铺地址简写”插件。

end_run_action全局-该勾子处于action运行结束后，通常您可

以在用户做完某个动作后进行一些处理

操作时利用此勾子。例如，您想在用户访

问某商品详情时更新商品的页面访问量。on_display全局display_file该勾子处于显示模板前，开放显示的模板

名称(如：index.html)给插件。您可以通过

修改模板名称以达到改变显示模板的目

的。

end_display全局display_file该勾子处于显示模板后，开放显示的模板

名称(如：index.html)给插件。具体用法根

据您的需要。例如，您可以通过此勾子来

达到在所有模板显示后追加输出内容的

目的。