简介:
Magento配置系统是支撑Mangeo运行的关键。配置系统掌管着所有的module/model/class/template/etc等文件。它把整个Magento系统抽象出来,用一个配置文件来描述。这里的“配置文件”并不是一个物理上存在的文件,而是Magento根据当前的系统状态动态生成的一段XML。这样的抽象提供了无与伦比的灵活性,允许你覆盖几乎任何系统的默认行为。
实例写个来看看,首先先从控制器方面写起。
首先来创建一个模块:
注:Magento的插件叫module,就是模块的意思。比如我们看到app/code/core/Mage目录里的很多文件夹,其实每一个文件夹目录对应的就是一个module模块,这是Magento的核心代码。通常我们需要对核心代码进行修改,都会新建一个app/code/local/项目/模型名称文件夹。
比如我们要修改Magento的核心Checkout功能。
原核心代码的目录为/app/code/core/Mage/Checkout
复制到/app/code/local/Mage/Checkout 然后修改该目录下的Checkout代码进行二次开发等。就可以不影响到核心的Mage,这么说吧,叫代码重写。因为Magento默认是会使用/app/code/local里面的源代码。同时核心代码没去修改,升级后因为修改过的是以插件的形式重写,就不用进行再次修改了。
创建模块需要一个项目,你可以用Mage,即/app/code/local/Mage,由于作者实际测试开发,所以项目名称为Qxz
目录为:/app/code/local/Qxz/Mymodule 模块名称为:Mymodule
创建以下目录:
app/code/local/Qxz/Mymodule/Block
app/code/local/Qxz/Mymodule/controllers
app/code/local/Qxz/Mymodule/etc
app/code/local/Qxz/Mymodule/Helper
app/code/local/Qxz/Mymodule/Model
app/code/local/Qxz/Mymodule/sql
#以上6个目录为插件基本需要存在的,为了以后开发方便一次创建好
然后我们需要创建两个配置文件:(配置文件都在etc目录内)
1是告诉Magento有某个模块的存在
2是模块自身的配置
首先系统模块的位置:注:这是全局的系统配置。
app/etc/modules/
创建配置文件的命名规则为:项目名称_模块名称,前面已经说到了。所以我们的系统配置文件的命名为:Qxz_Mymodule.xml
写入下面的配置:
<config>
<modules>
<Qxz_Mymodule>
<active>true</active>
<codePool>local</codePool>
</Qxz_Mymodule>
</modules>
</config>
然后我们创建模块自身的配置:config.xml
自身模块位置:app/code/local/Qxz/Mymodule/etc/
写入下面配置代码:
<config>
<modules>
<Qxz_Mymodule>
<version>0.1.0</version>
</Qxz_Mymodule>
</modules>
</config>
我们现在进入Magento后台,清/刷新缓存
然后系统—配置—高级—禁用模块输出
我们可以看到,最后面已经Qxz_Mymodule的模块了,Magento已经知道该模块的存在,但现在这模块并不能做任何事情。
来给他增加点功能吧,就编程界的开始输出“Hello word”吧。
#前提,你得对MVC有一定的理解。
我们要配置一个路由。路由是用来把一个URL请求转换成一个执行控制器和方法。和传统的PHP MVC不同的是,我们需要在Magento的全局配置中显式的定义自己的路由。
我们先来修改模块自身的配置文件app/code/local/Qxz/Mymodule/ect里的。注意系统配置和当前模块的配置。
红色部分为增加的:
<config>
<modules>
<Qxz_Mymodule>
<version>0.1.0</version>
</Qxz_Mymodule>
</modules>
<frontend>
<routers>
<mymodule>
<use>standard</use>
<args>
<module>Qxz_Mymodule</module>
<frontName>mymodule</frontName>
</args>
</mymodule>
</routers>
</frontend>
</config>
什么是frontend?
frontend标签指向一个Magento区(Area),比如“frontend”就是指网站的前台,“admin”是指网站的后台,“install”是指Magento的安装程序。【注:这个有点像磁盘分区,区和区之间是相互独立的,但是都归操作系统能够管理,在这里归Magento管理。默认的Magento安装没有“install”这个区,frontend区接管了,全局配置中的以下代码可以解释这一点
<frontend>
…
<install>
<use>standard</use>
<args>
<module>Mage_Install</module>
<frontname>install</frontname>
</args>
</install>
…
</frontend>
】
什么是routers?
Phil Karlton有一句很著名的话“在计算机领域只有两件事是困难的:缓存和命名”。Magento引入了很多新概念,无疑存在很多命名问题,这里就是一个例子。routers标签有时候包含的是路由对象的定义,有时候包含的是路径的定义。路由对象是进行路由操作的实体,而路径仅仅是路由对象的一个参数。【注:如果你仔细看过那个全局配置xml的话,你会发现有两处地方出现routers,一处是“web -> routers”,另外一处是“frontend-> routers”。你再仔细看看会发现两处routers包含的内容不一样。第一处包含的是路由对象的定义,第二处包含的是路径的定义。】
什么是module?
这个标签的内容应该是一个模块的全名,项目_模块名,在这里是“Qxz_Mymodule”。Magento用这个名字来定位你的模块文件。
什么是frontname?
当一个router解析一个URL的时候,它是按照如下规则进行的
http://example.com/frontName/actionControllerName/actionMethod/
所以,当我们在frontname标签里定义了“mymodule”以后,Magento会把如下的URL请求交给我们的模块“Qxz_Mydoule”来处理
http://example.com/mymodule/*
有些人容易把frontname和前端控制器(Front Controller)混淆起来。它们是两个不同的概念,frontname只跟路由相关,学过Zf的人都知道,其实就是个模块名。【注:根据我们前面讲过的Magento的MVC流程,前端控制器是用来实例化所有路由的,而这里的“frontName”只是路由过程中的一个参数】
什么是mymodule?
这个标签的名字应该是模块名字的小写版本。我们的模块名字是“Mymodule”,所以这里我们用“mymodule”。你应该也已经注意到我们定义的“frontName”也是和我们的模块相匹配的。这是一个不成文的规定,但不是强制要求。事实上,一个模块可以定义多个,也就是可以有多个“frontName”。
为路由创建执行控制器
Magento的MVC流程中路由会把控制权交给执行控制器。上面我们定义了路由,现在我们来定义我们的执行控制器。首先创建文件
app/code/local/Qxz/Mymodule/controllers/IndexController.php
模块的控制器应该放在模块的子目录“controllers”(小写c)里面。这是规定,Magento会在这个目录寻找模块的控制器文件。我们的第一个控制器包含以下内容
#Qxz项目Mymodule模块的执行控制器
class Qxz_Mymodule_IndexController extends Mage_Core_Controller_Front_Action {
public function indexAction() {
echo ‘Hello World!’;
}
}
清空Magento缓存,请求如下URL
http://127.0.0.1/ mymodule /index/index
或:127.0.0.1/mymodule
到此为止,我们的小插件的第一个控制器已经完成了。
执行控制器的命名规则:
还记得config.xml的标签吗?
<module>Qxz_Mymodule</module>
执行控制的名字的构成如下
以标签的内容开始(Qxz_Mymodule)
紧接一个下划线(Qxz_Mymodule_)
加上我们给控制器取的名字“Index”(Qxz_Mymodule_Index)
最后加上关键词“Controller” (Qxz_Mymodule_IndexController)
自己定义的属于frontend区的执行控制器都应该继承Mage_Core_Controller_Front_Action。
URL里面的index/index是什么
我们刚访问的http://127.0.0.1/mymodule /index/index
或:127.0.0.1/mymodule
第一个里index/index是什么意思呢?
其实Magento默认的路由规则是:
http://127.0.0.1/frontName/actionControllerName/actionMethod/
所以在我们请求的URL
http://exmaple.com/mymodule /index/index
其中“mymodule”是“frontName”,第一个“index”是执行控制器(Action Controller)的名字,第二个“index”是执行方法的名字。对比我们写的执行控制器代码,我们不难发现执行方法的定义是执行方法名字加上“Action”关键字
publicfunction indexAction(){…}
Magento根据命名规则找到执行控制器文件并实例化,然后再根据命名规则调用指定的执行方法。如果URL没有给出执行控制器名字或者执行方法,Magento会用默认的“index”来替代,所以下面三个URL是等价的
http://exmaple.com/mymodule/index/index
http://exmaple.com/mymodule/index/
http://exmaple.com/mymodule/
好了,Magento的MVC架构的C层大概就是这样了。它比传统的PHP MVC的控制器要复杂一点,但是Magento的这个高度灵活的MVC架构能让你创造出几乎所有你能想到的URL结构。
关于作者