如何创建magento模块z之Hello World例子

 

如何创建magento模块z之Hello World例子



步骤:
1.创建一个Hello World模块
2.为这个模块配置路由
3.为这个模块创建执行控制器

 

创建Hello World模块



创建模块的结构目录:
app/core/local/Sjolzy/HelloWorld/Block
app/core/local/Sjolzy/HelloWorld/controllers
app/core/local/Sjolzy/HelloWorld/etc
app/core/local/Sjolzy/HelloWorld/Helper
app/core/local/Sjolzy/HelloWorld/Model
app/core/local/Sjolzy/HelloWorld/sql
创建config.xml的内容(app/core/local/Sjolzy/HelloWorld/etc/config.xml):
<config>
 <modules>
  <Sjolzy_HelloWorld>
   <version>0.1.0</version>
  </Sjolzy_HelloWorld>
 </modules>
</config>
然后创建一个系统配置文件激活这个模块
Sjolzy_HelloWorld.xml(app/etc/modules/Sjolzy_HelloWorld.xml)
<config>
 <modules>
  <Sjolzy_HelloWorld>
   <active>true</active>
   <codePool>local</codePool>
  </Sjolzy_HelloWorld>
 </modules>
</config>
检查是否模块已经激活:先清空magento缓存(var/cache),在后台管理:System->Configuration->Advanced 展开Disable Modules Output,看是否Sjolzy_HelloWorld显示出来。
 

配置路由


路由是用来把一个URL请求转换成一个执行控制器的方法。
需要在magento的全局配置中显式的定义你的路由。
在config.xml(app/core/local/Sjolzy/HelloWorld/etc/config.xml)中:
<config>
 ...
 <!-- /*  fontend:指向网站的前台(也可以是admin|install) */ -->
 <frontend>
  <!-- /*  routers:路由对象的定义或路由路径的定义 */ -->
  <routers>
   <!-- /*  helloworld:指向网站的前台 */ -->
   <helloworld>
    <use>standard</use>
     <args>
      <!-- /*  module:模块名字的小写版本 */ -->
      <module>Sjolzy_HelloWorld</module>
      <!-- /*  fontName:路由过程中的一个参数,只跟路由相关(Front Controller则是用来实例化所有路由) */ -->
      <frontName>helloworld</frontName>
     </args>
   </helloworld>
  </routers>
 </frontend>
</config>
 

为路由创建执行控制器


路由会把控制权交给控制器,我们已经定义了路由,现在来定义我们的执行控制器。
app/code/local/Sjolzy/HelloWorld/controllers/IndexAction.php(模块的控制器放在子目录controllers<小写>里,这是magento的规定)
<?php
class Sjolzy_HelloWorld_IndexController extends Mage_Core_Controller_Front_Action{
 public function indexAction(){
  echo 'Hello World!';
 }
}
?>

还是情况缓存,请求URL:http://example.com/helloworld/index/index
注:http://example.com/frontName/执行控制器/执行方法


如果看到空白页面上写着'Hello World!',则你的模块创建成功!

Magento请求分发与控制器

 

Model-View-Controller (MVC) ,模型-视图-控制器,源于Smalltalk编程言和Xerox Parc。现在有很系统是基于MVC架构的,不同的系统MVC的实现也略有不同,但都体现了MVC的精髓,分离数据,业务逻辑和显示逻辑。最常见的PHP MVC框架是这样的

 

URL请求被一个PHP文件拦截,通常称为前端控制器(Front Controller)

这个PHP文件分析这个URL,获得一个执行控制器(Action Controller)的名字和一个执行方法(Action Method)的名字,这个过程通常称为路由(Routing)

实例化#2获得的执行控制器

调用执行控制器的执行方法

执行方法中处理业务逻辑,比如获取数据

执行控制器负责把数据传递给显示逻辑

显示逻辑生成HTML

这个架构相对于传统的“每个php都是一个页面”来讲已经是一个巨大的飞跃,但还是有人抱怨【译者注: CodeIgniter就是这样一个MVC框架

前端控制器仍然以全局的方式运行

基于配置的惯例导致了系统不够模块

URL Routing不够灵活

控制器往往和视图绑定

更改默认设置往往导致大量的重构

Magento创造了一个更抽象的MVC来解决上述问题

  

URL请求被一个PHP拦截

这个PHP文件实例化一个Magento对象

Magento对象实例化前端控制器

前端控制器实例化全局配置中指定的路由对象,可以是

路由对象会逐个与请求URL匹配

如果发现匹配,那么可以获得一个执行控制器和一个执行方法名字

实例化#6获得的执行控制器,并调用相应的执行方法

执行方法中处理业务逻辑模型数据

控制器实例化布局对象(Layout)

布局对象根据请求参数系统配置创建一个块对象(Block)列表,并实例

布局对象会调用块对象的output方法生成HTML。这是一个递归的过程,因为块对象可以嵌套块对象

每一个块对象都和一个模板文件(Template File)对应。块对象包含了显示逻辑模板文件包含了HTML和PHP输出代码

块对象直接从模型那里获得数据,换句话说,在Magento的MVC架构中,控制器并不直接把数据传给视图

这里很复杂,我们以后会详细解释每一个部分。我们先关注“前端控制器->路由对象->执行控制器”部分。

Hello World示例

 

我们讲了太理论,现在让我们来实践一下,通过实践来加深理解。下面是我们将要做的事情

创建一个Hello World模块

为这个模块配置路由

为这个模块创建执行控制器

创建Hello World模块

 

首先,我们要创建一个模块目录结构,这个我们以前已经做过了,就不再熬述

app/code/local/Alanstormdotcom/Helloworld/Block 

app/code/local/Alanstormdotcom/Helloworld/controllers 

app/code/local/Alanstormdotcom/Helloworld/etc 

app/code/local/Alanstormdotcom/Helloworld/Helper 

app/code/local/Alanstormdotcom/Helloworld/Model 

app/code/local/Alanstormdotcom/Helloworld/sql

下面是config.xml内容

PATH: app/code/local/Alanstormdotcom/Helloworld/etc/config.xml

<config> 

<modules>

       <Alanstormdotcom_Helloworld>

         <version>0.1.0</version>

       </Alanstormdotcom_Helloworld>

</modules>

</config>

然后我们要创建一个系统配置文件来激活这个模块

PATH: app/etc/modules/Alanstormdotcom_Helloworld.xml

<config>

<modules>

       <Alanstormdotcom_Helloworld>

         <active>true</active>

         <codePool>local</codePool>

       </Alanstormdotcom_Helloworld>

</modules>

</config>    

最后,让我们检查一下模块是不是已经被激活

清空Magento缓存

在管理后台,进入 System->Configuration->Advanced

展开“Disable Modules Output”

确认Alanstormdotcom_Helloworld显示出来了

配置路由

 

下面,我们要配置一个路由。路由是用来把一个URL请求转换成一个执行控制器方法。和传统的PHP MVC不同的是,你需要在Magento的全局配置中显式的定义你的路由。我们继续上面的例子,在config.xml中,添加如下代码

<config> 

...

<frontend>

       <routers>

         <helloworld>

            <use>standard</use>

            <args>

                   <module>Alanstormdotcom_Helloworld</module>

                   <frontName>helloworld</frontName>

            </args>

         </helloworld>

       </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 />?

这个标签内容应该是一个模块的全名,Packagename_Modulename,在这里是“Alanstormdotcom_Helloworld”。Magento用这个名字定位你的模块文件

 

什么是<frontName />?

当一个router解析一个URL的时候,它是按照如下规则进行

//sjolzy.cn/frontName/actionControllerName/actionMethod/

所以,当我们在<frontName>标签里定义了“helloworld”以后,Magento会把如下的URL请求交给我们的模块“Alanstormdotcom_Helloworld”来处理

//sjolzy.cn/helloworld/*

有些人容易把<frontName>和前端控制器(Front Controller)混淆起来。它们是两个不同的概念,<frontName>只跟路由相关。【译者注: 根据我们前面讲过的Magento的MVC流程,前端控制器是用来实例化所有路由的,而这里的“frontName”只是路由过程中的一个参数

什么是 <helloworld />?

这个标签名字应该模块名字的小写版本。我们的模块名字是“Helloworld”,所以这里我们用“helloworld”。你应该也已经注意到我们定义的“frontName”也是和我们的模块匹配的。这是一个不成文的规定,但不是强制要求。事实上,一个模块可以定义个<routers>,也就是可以有个“frontName”。

为路由创建执行控制器

还记得Magento的MVC流程吗?路由会把控制权交给执行控制器。上面我们定义了路由,现在我们来定义我们的执行控制器。首先创建文件

app/code/local/Alanstormdotcom/Helloworld/controllers/IndexController.php

模块控制器应该放在模块的子目录“controllers”(小写c)里面。这是规定,Magento会在这个目录寻找模块控制器文件。我们的第一个控制器包含以下内容

class Alanstormdotcom_Helloworld_IndexController extends Mage_Core_Controller_Front_Action {       

publicnction" title="function">function indexAction() {

       echo 'Hello World!';

}

}

清空Magento缓存请求如下URL

//sjolzy.cn/helloworld/index/index

如果你看到一个空白页面上面写着“Hello World”,那么恭喜你,你已经成功创建了你的第一个Magento控制器

如何命名执行控制器

还记得config.xml的<module>标签吗?

<module>Alanstormdotcom_Helloworld</module>

执行控制的名字的构成如下

以<moudule>标签内容开始 (Alanstormdotcom_Helloworld)

紧接一个下划线 (Alanstormdotcom_Helloworld_)

加上我们给控制器取的名字“Index”(Alanstormdotcom_Helloworld_Index)

最后加上关键词“Controller” (Alanstormdotcom_Helloworld_IndexController)

我们自己定义的属于frontend区的执行控制器应该继承Mage_Core_Controller_Front_Action。

URL里面的index/index是什么意思

 

正如前文所述,Magento默认的路由的规则如下

//sjolzy.cn/frontName/actionControllerName/actionMethod/

所以在我们请求的URL

//sjolzy.cn/helloworld/index/index

其中“helloworld”是“frontName”,第一个“index”是执行控制器(Action Controller)的名字,第二个“index”是执行方法名字。对比我们写的执行控制器代码,我们不难发现执行方法的定义是执行方法名字加上“Action”关键字

publicnction" title="function">function indexAction(){...}

Magento根据命名规则找到执行控制器文件实例化,然后再根据命名规则调用指定的执行方法。如果URL没有给出执行控制器名字或者执行方法,Magento会用默认的“index”来替代,所以下面三个URL是等价的

//sjolzy.cn/helloworld/index/index

//sjolzy.cn/helloworld/index/

//sjolzy.cn/helloworld/

我们再来看一个例子。如果URL如下

//sjolzy.cn/checkout/cart/add

Magento的执行步骤如下

查询全局配置,找到frontName “checkout”对应的模块,Mage_Checkout

找到执行控制器 “Mage_Checkout_CartController”

调用执行控制器的“addAction”方法

进一步理解执行控制器

下面我们来为我们的执行控制器添加一个执行方法。添加如下代码到IndexController.php

publicnction" title="function">functiongoodbyeAction() {

echo 'Goodbye World!';

请求URL

//sjolzy.cn/helloworld/index/goodbye

这次你应该看到“Goodbye World!”。因为我们继承了“Mage_Core_Controller_Front_Action”,我们可以使用一些父已经定义好的方法变量。比如父会把URL后面跟的参数转换成key/value的数组。添加如下代码到我们的执行控制器

publicnction" title="function">function paramsAction() {

echo '<dl>';          

foreach($this->getRequest()->getParams() as $key=>$value) {

       echo '<dt><strong>Param: </strong>'.$key.'</dt>';

       echo '<dl><strong>Value: </strong>'.$value.'</dl>';

}

echo '</dl>';

}

请求如下URL

//sjolzy.cn/helloworld/index/params?foo=bar&baz=eof

应该看到如下输出

Param: foo

   Value: bar

Param: baz

   Value: eof

最后,让我们再写一个执行控制器,用来处理一下URL

//sjolzy.cn/helloworld/messages/goodbye

这里的执行控制器名字是“messages”,所以我们要创建如下文件

app/code/local/Alanstormdotcom/Helloworld/controllers/MessagesController.php

执行控制器应该

Alanstormdotcom_Helloworld_MessagesController

添加执行方法

publicnction" title="function">functiongoodbyeAction()       

{

echo 'Another Goodbye';

}

好了,Magento的MVC架构大概就是这样了。它比传统的PHP MVC要复杂一点,但是Magento的这个高度灵活的MVC架构能让你创造出几乎所有你能想到的URL结构。

如何写MVC基础框架



转老逆原创帖!

VC模式下,客户直接发送请求到控制器,控制器根据用户请求的资源分发到相对应的模型来处理,模型完成了业务逻辑后,把所要的数据发送到视图,视图显示返回给客户。这就是web 或是说B/S架构的MVC工作流程。

控制器:

用户的所有请求会发送到控制器,由控制器来根据需要调用模型和视图。比如用户请求index.php 控制器文件,index.php里面不会设计到任何的数据库操作、逻辑操作。它只会寻找执行用户请求的业务模型,把所有的业务逻辑操作交给模型也就是 MVC中的M。把控制器独立出来,形成单入口访问模式,方便做全局管理,比如:日志记录等。

模型:

模型是业务逻辑数据的集合,比如数据库操作,复杂的逻辑运算等。按照功能或项目模块来分成一个个模型,模型间的耦合性很小有利于项目以后的扩展和修改。

视图:

Web技术中的MVC的C层。其主要是由 HTML 、XML语言组成的界面。以前的web界面是视图和模型混杂在一起使用,形成了杂乱的代码,这样使日后程序的维护十分艰难。PHP中知名的模板引擎 smarty 就是为了实现模型和视图分离的一种技术。现在smarty 在PHP行业中被开发者广泛使用。

MVC思想不是为了某种语言而设计的,它适用于所有的面向对象的语言。比如知名的实现MVC思想的JAVA语言的 Struts 框架。当然PHP 框架也是百花齐放如 :Zend Framework 、 Fleaphp 、Thinkphp 、Cakephp 等,都能很好的实现MVC思想而且他们大量应用了GOF 设计模式,开发人员如果基于以上几种MVC框架来进行项目开发的话,开发的效率和代码质量都会大幅度提升,特别是多人协作开发的项目。那PHP怎么实现 MVC的呢?下面给大家开发一个简单的MVC基础框架来说明这一点,完整代码附光盘09/20。

类驱动

在php5中可以使用__autoload 函数来实现类自动加载。但单纯这样的方式不够灵活的。比如类文件存放在不同的目录里面,而此时又需要自动加载的情况下,我们就需要在__autoload函数里进行复杂的逻辑判断来实现自动加载。
比如需要实例化两个类:Myblog 、Mybook。Mylog类在根目录下的Lib/test.php 文件里,Mybook类在根目录下的App/command.php 文件里。

__autoload

函数里实现加载:


[php]php
function __autoload($class){

if($class =='Myblog') include 'Lib/test.php';

if($class =='Mybook') include 'App/command.php';



if(!include_once($classpath)){//加栽类

throw newException("加载类库失败");

}
}
[size=10.5pt]?>

这只是实例化两个不同目录下的两个类而已。如果项目中使用面向对象开发的话,类不会那么少,大家可以想像一下。如果要加载数个不同目录下的类,在__autoload函数里实现会是多么的麻烦和不灵活。

在这里给出个比较简单的解决方案,而且这个解决方案在很多MVC框架中都得以很好的应用

我们只需要在类的命名方式上做些改变,以类的目录路径为类名:

/Yhmphp/ App.php 里的Mysession类,命名为:Yhmphp_App_Mysession。用‘ _ ’下划线来替换

路径分割符,以相对路径下的目录路径做类名。

又比如根目录下的Lib目录下test.php 文件里面(/Lib/test.php) 有个Myblog 类,可以这样给Myblog类命名:

class Lib_Myblog{}
?>
实例化Lib_Myblog类:

$myblog = newLib_Myblog;
[size=10.5pt]?>

__autoload函数里用str_replace函数把路径分割符替换类名中的‘ _ ’下划线,这样就可以准确的找到Lib_Myblog类的所在文件的路径然后准确的加载了:

function __autoload($class){

$classpath =str_replace('_','/',$class).'.php';

if(!include_once($classpath)){//加栽类

throw newException("加载类库失败");

}
}
[size=10.5pt]?>

模型的路由:

当我们给单入口文件(控制器)index.php
加上了模型选参m(index.php?m=myblog),控制器就会去寻找 myblog模型类,并实例化,然后执行myblog模型类中的 model 方法,最后执行show方法
来显示视图。

class App_Run
{

publicfunction routing(){

$model =MOBILE_MODEL.'_'.MODEL_SWITCHING.'_'.$_REQUEST['m'];

if(class_exists($model)){

$cake= new $model;

method_exists($cake,'model')&& $cake->model(); //执行模型里面的 model方法

method_exists($cake,’show’)&& $cake->show(); //视图层

}else{

thrownew Exception("数据模型不存在");

}
}
}
[size=10.5pt]?>

常量MBILE_MODEL定义了模型存放的目录名,在这里做了定义方便日后模型目录的更改。这是个良好的习惯。能统一定义的信息就该统一。能模块化的业务逻辑就应该模块化。为日后的项目维护和项目扩展做好铺垫。

MBILE_MODEL

在Config/__Active.php文件里面这样定义:

[php]php
/**
系统配置
*/
define('MOBILE_ROOT', ''); //站根目录
define('MOBILE_MODEL','Modules'); //模型目录名
[size=10.5pt]?>

class_exists() 函数来判断客户请求的($_REQUEST['m']) 模型类是否存在。Class_exists() 方法依据__autoload() 函数来加载判断。所以__autoload()函数必须在class_exists() 方法之前先加载。

模型类如果存在,就使用method_exists() 方法来判断执行模型类里面的model 方法里面的业务逻辑,然后再执行show() 方法显示视图。这样就完成了一个 MVC 流程。

存放模型的目录是 Modules 目录。这个在上面的MOBILE_MODEL常量中已经定义。难道所有的业务模型都存在一个Modules目录里面吗?这样的设计的确有点问题。文件夹里 面的文件过多,损耗程序寻找模型加载的时间,而且模型过多存在一个目录之中,会让这个项目变得很杂乱。比如前台和后台的模型目录和视图目录就应该分开存 放。

/**
多模型目录
*/
if(empty($_GET['c']) && ) $_GET['c'] ='Default';
if(empty($_GET['m'])) $_GET['m'] = 'Index';

define ('MODEL_SWITCHING',$_GET['c']) ; //前台后台目录切换
[size=10.5pt]?>

常量MODEL_SWITCHING 就是为解决这个问题设计的:
我们先看最后一句代码:

[size=10.5pt]define('MODEL_SWITCHING',$_GET['c']) ; //前台后台目录切换


它定义了常量MODEL_SWITCHING 以$_GET ['c']变量为值。App_Run 类中,常量MOBILE_MODEL 、MODEL_SWITCHING 和$_GET['m'] 组成了模型的加载路径:
$model = MOBILE_MODEL.'_'.MODEL_SWITCHING.'_'.$_GET['m'];

这样设计以后我们想添加多个模型目录都是很容易的事情了。比如:项目需要添加两个模型目录。前台模型目录:Default 和 后台模型目录:Admin 。只需要在默认的模型目录 Modules 下创建 Default 和Admin 两个目录,然后客户访问的URL 中 添加一个 参数c :
访问Default 目录下的Myblog业务模型: index.php?c=default&m=myblog
访问Admin 目录下的Member业务模型: index.php?c=admin&m=member
我们可以再设计灵活及人性化点,就是当$_GET[‘m’]和$_GET[‘c’] 客户没有设置的时候来给模型目录和业务模型类设置一个默认值。
if(empty($_GET['c'])
) $_GET['c'] = 'Default';
if(empty($_GET['m'])) $_GET['m'] = 'Index';

控制器
PHP MVC典型的设计就是使用单入口php文件来实现MVC中的C:控制器。所有的客户请求全部经过index.php 控制器集中控制。然后按需进行分发:

/**
入口文件
*/
try{

error_reporting(E_ALL);//关闭错误输出

require'Config/__Homeswitching.php';

require'Config/__Active.php';

require'App/Auto.php';


$set = newApp_Run;

$set->routing();


}catch (Exception $e){


echo($e->getMessage());


}
[size=10.5pt]?>

多模型设置文件:__Homeswitching.php,定义基础模型目录文件:__Active.php,类驱动文件:Auto.php
加载完后,再实例化模型路由App_Run类,执行其 routing() 方法 寻找完成客户请求。

业务模型

业务模型类是整个项目中使用最多的。它就是MVC 中的M (模型)。类里面封装了大量的业务逻辑。比如:客户向index.php 控制器 请求 (index.php?m=newbook)newbook业务模型,来查询最新出的图书。 那么newbook业务模型类所需要完成的任务就是查询数据库,从数据库中提取最新的图书资料,然后发送到视图层(View)显示给客户。显然,MVC 模式可以把 模型与模型、功能与功能之间的耦合度变得很小、扩展性很强。

/**

* 模型类

* */
class Modules_Default_Index
extends App_Manage
{



privatenewbook=’’;

publicfunction __c****truct(){

parent::__c****truct();

}



publicfunction show(){

$this->tpl->assign(‘newbook’,$this->newbook);
 
$this->tpl->display('Index');

}



publicfunction model(){

/**实现业务逻辑*/

$this->newbook = ‘PHP MVC’;

}
}
[size=10.5pt]?>

业务模型类里面有两个主要方法: model() 、show() 方法。Model() 方法主要实现业务逻辑,比如:读数据库、写数据库等。Show() 方法主要和model() 方法联系获取业务逻辑的数据,然后输出给视图(php模板)。

读者请思考下以下几个问题:
模型类 Modules_Default_Index 为什么要起这个名字?前面__autoload讲解中已讲解。Show() 方法是否能去掉只实现model() 模型?模型的路由小节中讲解。

全局类
在项目开发里,有很多我们自己封装好的类:数据库操作类、模板类、email发送类、分页类、文本缓存类、内存缓存类memcache等等。这些 类中有些是每个模型都必须加载使用的,比如 数据库操作类、分页类。难道我们每个模型里都要显式的实例化一次?那真是太麻烦了。所以设计一个全局管理类App_Manage :

class App_Manage{
protected$tpl;
protected$mem;
protected$email;
publicfunction __c****truct(){

$this->tpl = new Lib_Tpl;
/*
$this->mem = new Lib_Memcached;


$this->email= new Lib_Mailer();*/
}
[font=宋体]}[/font]
[font=宋体][size=10.5pt]?>

在App_Manage中。我们简单的在其构造方法中实例化了几个常用的类。每个模型都继承App_Manage类,这样模型类里面就可以使用父类的方法和属性,以此实现全局类:

public function __c****truct(){

parent::__c****truct();

}