magento開發 -- 深入理解Magento第二章

然後我們要創建一個係統配置文件來激活這個模塊 

最後，讓我們檢查一下模塊是不是已經被激活

1. 清空Magento緩存
2. 在管理後台，進入 System->Configuration->Advanced
3. 展開“Disable Modules Output”
4. 確認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的時候，它是按照如下規則進行的
https://example.com/frontName/actionControllerName/actionMethod/
所以，當我們在<frontName>標簽裏定義了“helloworld”以後，Magento會把如下的URL請求交給我們的模塊“Alanstormdotcom_Helloworld”來處理
https://example.com/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 { public function indexAction() { echo 'Hello World!'; } } 

 

清空Magento緩存，請求如下URL
https://exmaple.com/helloworld/index/index
如果你看到一個空白頁麵上麵寫著“Hello World”，那麼恭喜你，你已經成功創建了你的第一個Magento控製器！

如何命名執行控製器？

還記得config.xml的<module>標簽嗎？
<module>Alanstormdotcom_Helloworld</module>
執行控製的名字的構成如下

1. 以<moudule>標簽的內容開始 （Alanstormdotcom_Helloworld）
2. 緊接一個下劃線 （Alanstormdotcom_Helloworld_）
3. 加上我們給控製器取的名字“Index”(Alanstormdotcom_Helloworld_Index)
4. 最後加上關鍵詞“Controller” （Alanstormdotcom_Helloworld_IndexController）

我們自己定義的屬於frontend區的執行控製器都應該繼承Mage_Core_Controller_Front_Action。

URL裏麵的index/index是什麼意思？

正如前文所述，Magento默認的路由的規則如下
https://example.com/frontName/actionControllerName/actionMethod/
所以在我們請求的URL
https://exmaple.com/helloworld/index/index
其中“helloworld”是“frontName”，第一個“index”是執行控製器（Action Controller）的名字，第二個“index”是執行方法的名字。對比我們寫的執行控製器代碼，我們不難發現執行方法的定義是執行方法名字加上“Action”關鍵字
public function indexAction(){...}
Magento根據命名規則找到執行控製器文件並實例化，然後再根據命名規則調用指定的執行方法。如果URL沒有給出執行控製器名字或者執行方法，Magento會用默認的“index”來替代，所以下麵三個URL是等價的
https://exmaple.com/helloworld/index/index
https://exmaple.com/helloworld/index/
https://exmaple.com/helloworld/
我們再來看一個例子。如果URL如下
https://exmaple.com/checkout/cart/add
Magento的執行步驟如下

1. 查詢全局配置，找到frontName “checkout”對應的模塊，Mage_Checkout
2. 找到執行控製器 “Mage_Checkout_CartController”
3. 調用執行控製器的“addAction”方法

進一步理解執行控製器

 

下麵我們來為我們的執行控製器添加一個執行方法。添加如下代碼到IndexController.php

 

public function goodbyeAction() { echo 'Goodbye World!'; } 

 

請求URL
https://example.com/helloworld/index/goodbye
這次你應該看到“Goodbye World!”。因為我們繼承了“Mage_Core_Controller_Front_Action”，我們可以使用一些父類已經定義好的方法和變量。比如父類會把URL後麵跟的參數轉換成key/value的數組。添加如下代碼到我們的執行控製器

 

public 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>'; }