Magento模块开发教程

Magento 模块开发教程

Magento 模块开发教程循序渐进，深入浅出地讲述了 Magento 的架构和工作方式， 把一

个复杂系统的内部结构淋漓尽致的展现在我们面前。通过本教程你将了解到 Magento 之强

大，架构之美。希望对更多的 Magento 开发者有所帮助。

希望阅读者可以达到以下几点：

1. 懂得 PHP 的运作方式

2. 良好的编程基础 （写过 5w 行代码以上）

3. 了解基本设计模式

前的系统状态动态生成的一段 XML。大多数的 PHP 开发者并不习惯于这样抽象层，因为

它增加的编程的复杂性。但是这样的抽象提供了无与伦比的灵活性，允许你覆盖几乎任何

系统的默认行为。

首先，让我们写一个简单的插件来看看这个所谓的“配置文件”长什么样。虽然我已经提

供的现成的代码，但是还是建议你自己建立这个插件，把整个流程走一遍有助于你的理解。

设置插件的目录结构

我们将要创建一个 Magento 的模块【注： Magento 的插件不叫 plug-in，叫 module，翻译

成模块】。Magento 的模块由 php 和 xml 文件组成，目的是扩展或者覆盖系统的行为，比

如为订单增加数据模型，更改一个类的方法，或者增加一个全新的功能。【注：Magento

自带的那些功能也都是基于模块的，比如用户注册，商品展示，结账流程等等。Magento

app/code/local/Packagename

— —

“Packagename”应该是一个唯一的字符串，用来标识你的代码。通常人们使用公司名字作为

Packagename，比如

app/code/local/Microsoft

由于我在做我自己的 Magento 项目，我将使用我自己的域名“Alanstormdotcom”。 然后，

我们要创建以下目录结构

app/code/local/Alanstormdotcom/Configviewer/Block

app/code/local/Alanstormdotcom/Configviewer/controllers

app/code/local/Alanstormdotcom/Configviewer/etc/config.xml

文件内容如下

<config>

<modules>

<Alanstormdotcom_Configviewer>

<version>0.1.0</version>

</Alanstormdotcom_Configviewer>

</modules>

</config>

第二个文件需要在如下位置创建

<codePool>local</codePool>

</Alanstormdotcom_Configviewer>

</modules>

</config>

我们先不管这些文件是干什么的，以后会解释。建立好这两个文件以后，你的模块的骨

架就已经完成了。Magento 已经知道你的模块存在，但是现在你的模块不会做任何事情。

我们来确认一下 Magento 确实装载了你的模块

1. 清空 Magento 缓存

2. 在后台管理界面，进入 System->Configuration->Advanced

3. 展开“Disable Modules Output”

— —

2. 如果“showConfig”存在，那么检查“showConfigFormat”查询字符串是否存在

3. 如果“showConfigFormat”存在，那么输出指定格式的配置信息，否则输出默认格式的配

置信息

4. 终止执行流程

首先更改我们的 config.xml 文件

<config>

<modules>...</modules>

<global>

<events>

<controller_front_init_routers>

</observers>

</controller_front_init_routers>

</events>

</global>

</config>

然后创建如下文件

Alanstormdotcom/Configviewer/Model/Observer.php

输入以下内容

<?php

class Alanstormdotcom_Configviewer_Model_Observer {

$this->setHeader();

$this->outputConfig();

}

}

private function setHeader() {

$format = isset($this->request->{self::FLAG_SHOW_CONFIG_FORMAT}) ?

— —

$this->request->{self::FLAG_SHOW_CONFIG_FORMAT} : 'xml';

switch($format){

case 'text':

header("Content-Type: text/plain");

break;

default:

header("Content-Type: text/xml");

?>

好了，代码编辑结束。清空你的 Magento 缓存，输入如下 URL

http://magento.example.com/?showConfig=true

的状态。它列出了所有的模块，数据模型，类，事件，监听器等等。举个例子，如果你搜

索如下字符串

Configviewer_Model_Observer

你会发现刚刚你创建的那个类被列出来了。Magento 会解析每个模块的 config.xml，并把它

们包含在这个全局配置中。

这个配置文件有啥用？

到目前为止，我们所作的事情似乎没什么意义，但是这个配置文件却是理解 Magento 的

关键因素。你创建的每一个模块都会被加到这个配置文件中，任何时候，你需要调用一个

系统功能的时候，Magento 都会通过这个配置文件来查询相应的模块和功能。举个简单的

例子，如果你懂 MVC 的话，你应该和 “helper class”之类概念的打过交道

3. 在<sales />里面查找 <class />标签

4. 实例化从#3 找到的类（Mage_SalesRule_Helper）

Magento 总是通过配置文件来获得类名，这个逻辑看起来有些复杂，但这样做的优点也很

— —

明显，我们可以不需要更改 Magento 的代码就能更改 Magento 的核心功能。

【注： 在这个例子中，我们可以通过修改配置文件用我们自己的 SalesRule_Helper 类来替

换原来那个】这种高度抽象的编程方式在 php 中并不常见，但是它可以让你清晰的扩展或

者替换系统的某一部分。

第二章Magento 请求分发与控制器

Model-View-Controller (MVC) ，模型 - 视图- 控制器，源于 Smalltalk 编程语言和 Xerox

Parc。现在有很多系统是基于 MVC 架构的，不同的系统 MVC 的实现也略有不同，但都体

现了 MVC 的精髓，分离数据，业务逻辑和显示逻辑。最常见的 PHP MVC 框架是这样的

— —