编辑“Open Web Analytics/模块创建”

{{Open Web Analytics top}}
OWA 的功能是完全模块化的，开发者可以通过创建一个新的模块来扩展OWA的功能。所有的模块文件都存放在owa目录下的modules文件夹中。下面介绍怎样创建一个新的模块。
==主要步骤==
创建一个模块主要有以下步骤：
*为你的模块创建一个新的目录；
*为你的模块创建一个module.php文件；
*创建事件Event handlers（[[处理器]]）、controllers（控制器）、和views（视图）；
*创建Entities（实体）和database tables（[[数据库]]表）；
==模块的目录结构==
一个模块以及它相关的文件都是存储在OWAmodules目录中属于它们的子目录中的。

*/path/to/owa/modules/your_module
模块的基本目录； 

*/path/to/owa/modules/your_module/classes
这是你用来存储帮助类（helperclasses）的，这些类可以使用owa_coreAPI::supportClassFactory方法来加载；

*/path/to/owa/modules/your_module/entities
用来存储实体，控制器可以通过owa_coreAPI::entitiyFactory方法来访问这些实体；  

*/path/to/owa/modules/your_module/handlers
用来存储事件处理器类（event handler classes ）. 

*/path/to/owa/modules/your_module/metrics
用来存储指标类（ metrics classes）. 

*/path/to/owa/modules/your_module/updates
用来存储数据库模式更新类（database schema updater classes） 

==Module.php==
在为模块创建好目录后，你就需要在该目录中创建一个module.[[php]]文件。该文件将会包含主要的用来扩展OWA的模块类。你的module.php文件将会包含所有的事件处理器、实体、过滤的注册，以及你希望添加到OWA中的[[API]]命令。在module.php中你需要定义一个类，来继承抽象的owa_module类，并且设置一些属性，例如下面的例子：
<pre>class owa_helloModule extends owa_module {
	
	function __construct() {
		
		$this->name = 'hello'; // 模块的名称，不要含空格；
		$this->display_name = 'Hello World'; // 显示模块的名称
		$this->group = 'hello'; // 模块的组，需要与上面的一致；
		$this->author = 'Joe Smith'; // 作者名称
		$this->version = '1.0'; // 模块的版本号
		$this->description = 'Hello world sample module.'; // 简要描述
		$this->config_required = false; // 激活模块后是否配置
		$this->required_schema_version = 1; //  模块所注册的实体的必须的模式版本.
		
		return parent::__construct();
	}
}
</pre>
对于模块的命名必须遵守nameModule的命名规则；


对于事件处理器、实体等的创建，用户在手册导航中找到相关词条来阅读，在这里就不赘述了。

==参考来源==
*http://wiki.openwebanalytics.com/index.php?title=Creating_a_New_Module


{{Open Web Analytics}}

[[category:Open Web Analytics]]