模块开发指南.pdf

《模块开发指南.pdf》由会员分享，可在线阅读，更多相关《模块开发指南.pdf（10页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、ECECECECMallMallMallMall 社区电子商务第 1 页/共 10 页ECMallECMallECMallECMall 2.02.02.02.0模块开发指南模块开发指南Copyright 本文档面向程序开发者及爱好者04ECECECECMallMallMallMall 社区电子商务第 2 页/共 10 页文档历史文档历史前言前言本文档主要面向有一定程序基础的开发人员和技术爱好者，旨在帮助其快速入门ECMall V2.0 的模块开发。通过阅读本文档，您还可以了解到模块的开发规范，快速地制作出符合规范的模块。阅读本文档需要您具备一定的 PHP 编程基础，特别是面向对象的编程知识，如

2、“类”，“对象”，“派生”等概念，并且需要您对 ECMall 2.0 的系统结构，Smarty 模板的使用有一定的了解。日期日期版本版本作者作者描述描述2009/8/191.0Garbin Huang创建文档ECECECECMallMallMallMall 社区电子商务第 3 页/共 10 页目录目录前言.2目录.31.模块的定义.41.1.什么是模块.41.2.模块的意义.41.3.模块的适用范围.42.模块的基本构成.42.1.模块的文件构成.42.2.模块的代码构成.53.模块实例分析.53.1.创建一个模块.53.2.实现主体代码.63.3.实现安装和卸载.93.4.使用和调试.104

3、.发布和分享.10ECECECECMallMallMallMall 社区电子商务第 4 页/共 10 页1.1.1.1.模块的定义模块的定义1.1.1.1.1.1.1.1.什么是模块什么是模块什么是模块什么是模块模块是一个在代码层面独立于主体程序的程序代码，其为主体程序提供额外的功能补充，其拥有独立的前后台控制器，模板，语言包，安装，卸载程序，其是一个建立在主体程序平台上的应用。如果 ECMall 是一个操作系统，那么模块就相当于运行在这个操作系统上的第三方应用，如“迅雷”，“QQ”等。1.2.1.2.1.2.1.2.模块的意义模块的意义模块的意义模块的意义使用模块有利于您独立新增的功能代码的

4、管理维护和分享，并且有利于您对您系统中各功能模块的管理（比如您可以随时方便地开启和关闭功能模块），更重要的是使用模块可以帮助您在不对主体程序进行任何修改的情况下完成一个相对复杂的相对独立相对独立的新功能(如果结合插件和挂件，您将可以完成更加复杂的功能模块，不再受相对独立相对独立的限制)。1.3.1.3.1.3.1.3.模块的适用范围模块的适用范围模块的适用范围模块的适用范围相对独立的功能比较适合使用模块来实现，但不限于此，在配合插件和挂件的情况下，您完全可以制作出与系统其他功能紧密相连的应用。例如，ECMall 系统内置的文章功能，与其他功能没有太多的关联，您或许只需要运用该功能添加几个文章，

5、在前台展示一下，那么这个功能可以用模块来实现它。但如果您的需求不只限于此，您还想在首页某个区域展示指定的文章列表，这也没关系，我们依然推荐您使用模块来实现这一功能，不同的是，这时您需要配合“挂件”功能来实现与首页形成的这种关系。提示：若您觉得现有内置的文章管理功能无法满足您的需求，您可以尝试制作一个您想象中的文章管理功能模块。2.2.2.2.模块的基本构成模块的基本构成2.1.2.1.2.1.2.1.模块的文件构成模块的文件构成模块的文件构成模块的文件构成模块是一个拥有完整功能的程序，他拥有独立的控制器，语言文件，模板文件，安装程序，卸载程序等等。模块存放于./external/modules

6、 目录下，其下每个目录即为一个模块，以下是一个典型的模块所拥有的文件列表表格：典型的模块所拥有的基本文件列表ECECECECMallMallMallMall 社区电子商务第 5 页/共 10 页我们要求，除了非 utf-8编码的语言文件外，其他文本文件（包括程序主体文件和模板文件等）都必须是以 utf-8编码，并且去掉了 UTF-8 BOM 的文本文件。2.2.2.2.2.2.2.2.模块的代码构成模块的代码构成模块的代码构成模块的代码构成模块的控制器是由模块基础控制器中派生出的具体的控制器，模块基础控制器又分为，前台模块基础控制器(IndexbaseModule)和后台模块(Adminbas

7、eModule)基础控制器，您都需要分别实现。3.3.3.3.模块实例分析模块实例分析我们以数据调用模块为例子来展示如何创建一个模块，该模块的代码在 ECMall 的安装包中./upload/external/modules/datacall 中可以找到。3.1.3.1.3.1.3.1.创建一个模块创建一个模块创建一个模块创建一个模块创建一个模块的典型流程是：创建目录结构及相应文件创建目录结构及相应文件-完成模块信息文件完成模块信息文件。创建目录结构及相应文件请参照 2.1 节中模块基本文件的表格。以下是 datacall 模块的模块描述信息文件(module.info.php)的内容以及相关

8、注释。目录/文件描述admin.module.php模块后台管理控制器文件，负责实现后台管理功能index.module.php前台控制器文件，负责实现前台功能module.info.php模块描述信息文件install.php安装程序uninstall.php卸载程序languages/多语言语言文件存放目录，其下的目录应为与 ECMall 的./languages目录下一致的四个语言编码目录templates/前台模板文件目录，前台模板存放于此templates/admin后台模板文件目录，后台模板存放于此 datacall,/模块名称,使用 Lang:get()获取语言项name=Lan

9、g:get(data_call),/模块描述ECECECECMallMallMallMall 社区电子商务第 6 页/共 10 页描述信息还可以指定该模块的配置项及其表单，以便于使用用户可以做个性化的功能定制。您只需要指定 config 信息即可，该 config 属于与插件开发中的 config 属性类似。在此我们不再详细说明，请持续关注我们发布的文档。3.2.3.2.3.2.3.2.实现主体代码实现主体代码实现主体代码实现主体代码实现主体代码分为实现后台控制器与实现前台控制器两部分，以下是 datacall 的代码及相关注释。后台控制器：admin.module.phpdesc=Lang:

10、get(datacall_desc),/版本号version=1.0,/作者author=ECMall Team,/作者网站website=http:/,/模块管理菜单，可以是多个，该菜单将被显示在后台模块管理列表对应的模块项中menu=array(array(/菜单显示文字text=Lang:get(datacall_manage),/后台控制器(admin.module.php)的 act参数值act=index,),),);?DatacallModule();function DatacallModule()/运行基础类的构造函数进行一些初始化工作parent:_construct();

11、./实现您在 module.info.php 中指定的 menu 中的 act 为 index 的方法，index 即为函数名称function index()./与 ECMall 主体程序控制器一样，使用$this-assign 方法来给模板赋值$this-assign(data,$data);/与主体程序控制器一样，使用$this-display 方法来显示模板，调用的是在模块的./templates/admin 目录下的模板$this-display(datacall.index.html);/*-以下方法为该模块特有的方法，您可以忽略之-*/function add().functio

12、n edit().function handle_post_data($post).ECECECECMallMallMallMall 社区电子商务第 8 页/共 10 页前台控制器：index.module.phpfunction drop().function filter_ids($ids).function _get_mgcategory_options($parent_id=0).function&_tree($gcategories).function _get_options($except=NULL).?DatacallModule();function DatacallModu

13、le()ECECECECMallMallMallMall 社区电子商务第 9 页/共 10 页值得一提的是，在实际代码编写中需要用到的访问模型，配置项，语言项等等都跟主体程序中的控制器一致，您可以尽情发挥您的编码能力。3.3.3.3.3.3.3.3.实现安装和卸载实现安装和卸载实现安装和卸载实现安装和卸载实现安装和卸载只需要您完成两个 php 文件，install.php 和 unistall.php，它们将分别在安装和卸载时被运行。以下是 datacall 的安装和卸载程序代码及相关注释。/运行基础类的构造函数进行一些初始化工作parent:_construct();./*这里的控制器的方法

14、就依您的实际需求而定了，其中 index 是缺省的方法*/function index().function is_cached($id).function js_write($str).function save_cache($id).function doc_output().?ECECECECMallMallMallMall 社区电子商务第 10 页/共 10 页安装 install.php卸载 uninstall.php3.4.3.4.3.4.3.4.使用和调试使用和调试使用和调试使用和调试当您完成了模块之后，只需简单地将该模块目录上传至商城根目录./external/modules目

15、录下即，而后登录站长后台“扩展-模块管理”找到您的模块，安装并启用之就可开始使用和调试您的模块了。4.4.4.4.发布和分享发布和分享发布您的模块仅需简单地将您制作的模块目录及相应的语言文件打包即可发布。由于ECMall 共有四种语言编码版本，因此，为了让您的模块可以被更多的人使用，我们推荐您将语言文件转换成四种语言编码后再打包发布。?php/*这里可以放一些安装模块时需要执行的代码，比如新建表，新建目录、文件之类的*/*下面的代码不是必需的，只是作为示例*/$filename=ROOT_PATH./data/datacall.inc.php;file_put_contents($filename,);?