[ZF]Zend Framework v1 初探

Published by johnson on

最近因為工作需要用到ZF，所以就來摸一下
Zend Framework是php裡頭其中一種Framework，因為它實作的是按照MVC架構做的，所以要先把MVC的概念看懂，
可以參考維基寫的MVC

建立目錄架構：
首先把網站目錄結構建成(目錄結構規劃不一定要參照這個方式)：

顯示原始碼
列印？
1Project/
2    application/
3        controllers/
4        models/
5        views/
6            layouts/
7            scripts/
8    library/
9    public/
10        .htaccess
11        index.php
12        js/
13        img/
14        css/

另外設個DNS指到Project/public這個目錄

下載Zend Framework：
接著下載Zend Framework
他有 Full 跟 minimal 兩個版本，建議是下載Full，下載下來後解壓縮並把 /(Zend_Framework)/library/Zend整個目錄複製到你的Project/library下

建立index：
我們先在Project/public底下建立一個index.php，這支index.php的用途就是把除了靜態檔案以外，把其他的request都交給Zend Framework來處理，所以記得要把Rewrite的功能開起來。

首先在Project/public底下建一個.htaccess，填入以下內容：

顯示原始碼
列印？
1RewriteEngine On
2RewriteCond %{REQUEST_FILENAME} -s [OR]
3RewriteCond %{REQUEST_FILENAME} -l [OR]
4RewriteCond %{REQUEST_FILENAME} -d
5RewriteRule ^.*$ - [NC,L]
6RewriteRule ^.*$ index.php [NC,L]
7RewriteBase /

這段Rewrite的設定就是將所有目錄、檔案以外的URL都交給index.php處理，比如http://localhost/img/a.png便會直接吐內容，如果是http://localhost/foo/bar這類的就會丟給index.php處理

RewriteCond指令定義了規則生效的條件，也就是說RewriteCond要符合才會跑RewriteRule
-s：測試路徑名稱是否存在
-l：測試路徑名稱並確認是否有一個存在的符號連接
-d：測試路徑目錄是否存在

接著要設定index.php的內容：

顯示原始碼
列印？
1<?php
2    //設定application路徑常數
3    define('APPLICATION_PATH', realpath(dirname( __FILE__ ) . '/../application/'));
4    //設定環境常數(開發者)
5    define('APPLICATION_ENVIRONMENT', 'development');
6     
7    //設定時區
8    date_default_timezone_set('Asia/Taipei');
9     
10    //設定path，PATH_SEPARATOR是一個PHP中的常數，是用來串接路徑與路徑之間的區隔符號，因為UNIX是":"、windows是";"，所以直接使用PATH_SEPARATOR才不會在移植時爛掉
11    set_include_path(APPLICATION_PATH . '/../library' . PATH_SEPARATOR . get_include_path());
12     
13     
14    require_once 'Zend/Loader/Autoloader.php';
15    //呼叫Zend_Loader_Autoloader，讓Zend Framework在有load classes的能力
16    $autoloader = Zend_Loader_Autoloader::getInstance();
17    //這適用於函式庫中沒有自己加的namepsace，所以會使用預設讀Zend Framework中class所使用的字首Zend_跟ZendX_，讓Zend Framework內的class能夠自動被載入。
18    //setFallbackAutoloader(true)是讓寫在include_path(library)中，又沒有註冊namespace的class能被載入
19    $autoloader->setFallbackAutoloader(true);
20     
21    //呼叫前端Controller
22    $frontController = Zend_Controller_Front::getInstance();
23    //設定ControllerDirectory
24    $frontController->setControllerDirectory(APPLICATION_PATH . '/controllers');
25    //設定環境為開發者模式
26    $frontController->setParam('env', APPLICATION_ENVIRONMENT);
27    //執行
28    $frontController->dispatch();
29?>

Action Controller：
先在Project/application/controllers裡面建一個IndexController.php，在Zend Framework裡可以將request都交由front controller下的dispatcher來決定要交由哪個action controller來處理，所以controller命名的方式就是URL名稱(開頭大寫)Controller.php。例如http://DNS/foo就會去執行FooController的indexAction；http://DNS/foo/bar就是執行FooController的barAction。如果將Action命名成testOneAction，則DNS會對應成test-one

接著在IndexController.php輸入以下內容：

顯示原始碼
列印？
1<?php
2    class IndexController extends Zend_Controller_Action {
3        public function init() {
4            //當物件建立時會自動執行此函式
5        }
6        public function indexAction() {
7            //關閉預設viewRenderer，不會去找application/views/scripts裡的template來顯示
8            $this->_helper->viewRenderer->setNoRender();
9            echo 'hello from Index#index';
10        }
11    }
12?>

這時只要輸入http://DNS/就可以看到畫面顯示出hello from Index#index的字串

View Script：
剛剛上述Action的作法，只是拿來測試controller是否正常執行，事實上是不符合MVC架構的，controller是拿來運算而非拿來顯示的，顯示的部份必須由view來執行！
在Zend Framework中，action controller預設都會有一個view renderer來負責顯示的工作，他會根據controller/action的名稱去找application/views/scripts/controller_name/action.phtml來顯示，例如剛剛上述的IndexController/indexAction就會去找index/index.phtml，所以先在application/views/scripts底下建一個index目錄，index的目錄裡再建一個index.phtml
再將Project/application/controllers/IndexController.php改成以下內容：

顯示原始碼
列印？
1<?php
2    class IndexController extends Zend_Controller_Action {
3        public function init() {
4            //當物件建立時會自動執行此函式
5        }
6        public function indexAction() {
7            //將日期儲存到Controller裡view這個物件的today變數
8            $this->view->today = date('Y-m-d');
9        }
10    }
11?>

接著輸入Project/application/views/scripts/index/index.phtml內容：

顯示原始碼
列印？
1<!-- #file: Project/application/views/scripts/index/index.phtml -->
2<!-- 可以使用 $this->escape() 函式針對變數做HTML escape-->
3<h1>It's <?php echo $this->today; ?> today.</h1>

這樣http://DNS/就會顯示出日期了

URL Routing：
上面有提過Controller和Action的命名方式，現在來實作一下 http://DNS/foo 和 http://DNS/foo/bar

首先先在Project/application/controllers裡建一個FooController.php並輸入以下內容：

顯示原始碼
列印？
1<?php
2    class FooController extends Zend_Controller_Action {
3        public function indexAction() {
4            //關閉預設viewRenderer
5            $this->_helper->viewRenderer->setNoRender();
6            echo "It's Foo#index";
7        }
8        public function barAction(){
9            //關閉預設viewRenderer
10            $this->_helper->viewRenderer->setNoRender();
11            echo "It's Foo#bar";
12        }
13    }
14?>

選擇View Scripts：
上述有提到view renderer來負責顯示的工作，他會根據controller/action的名稱去找符合的phtml檔，
例如上述提到的狀況，若是改成view輸出，則應該會在Project/application/views/scripts/foo/裡多出index.phtml和bar.phtml
但Action也可以直接選擇其他的view script來顯示。

例如將Project/application/controllers裡的FooController.php改成：

顯示原始碼
列印？
1<?php
2    class FooController extends Zend_Controller_Action {
3        public function indexAction() {
4            $this->view->msg = "Foo#index";
5            //把view script改成Project/application/views/scripts/foo/bar.phtml(要在所有view的變數輸入完後再做render，不然render之後才輸入的變數皆會失效)
6            $this->render('bar');
7        }
8        public function barAction(){
9            //使用原本的view scripts輸出
10            $this->view->msg = "Foo#bar";
11        }
12    }
13?>

Project/application/views/scripts/foo/bar.phtml：

顯示原始碼
列印？
1<!-- #file: Project/application/views/scripts/foo/bar.phtml -->
2It's <?php echo $this->msg; ?>.

使用Layout排版：
在設計網站時，都會有一些固定的版型，比如Header或sidebar大家都長一樣，只是內容不同而已，這樣的需求可以用Zend Framework中的Layout元件來完成。

首先要使用Layout元件時，需要一開始初始化時就把元件打開，並且設定layout存放的路徑，所以必須在Project/index.php中再加入一段程式碼：

顯示原始碼
列印？
1<?php
2    //程式碼要加在Zend_Loader_Autoloader::getInstance();之後
3     
4    //啟用mvc，並設定layout路徑
5    Zend_Layout::startMvc(array('layoutPath' => APPLICATION_PATH . '/views/layouts'));
6     
7    //程式碼要加在Zend_Controller_Front::getInstance();之前
8?>

接著在Project/application/views/layouts/layout.phtml

顯示原始碼
列印？
1<!DOCTYPE HTML>
2<html>
3    <head>
4        <meta charset="UTF-8">
5        <title>ZF TEST</title>
6    </head>
7    <body>
8    <div id="hd"><h1>Header</h1></div>
9    <!-- $this->layout()->content就是view script的所有輸出 -->
10    <div id="bd"><?php echo $this->layout()->content; ?></div>
11    <div id="ft"><small>Footer</small></div>
12    </body>
13</html>

現在可以試試上述幾個已經完成測試的foo/bar就都有layout了

選擇不同的Layout：
跟view script一樣，Layout也是可以選擇的，當然你要在Project/application/views/layouts裡再建一個，比如建了一個test_layout.phtml，
只要在Controller.php裡的Action方法加上以下這段程式碼就可以了：

顯示原始碼
列印？
1$this->_helper->layout->setLayout('test_layout');

關閉Layout：
如果開啟了Layout元件，但某些action不需要用到Layout，
一樣在Controller.php裡的Action方法加上以下這段程式碼就可以了：

顯示原始碼
列印？
1$this->_helper->layout->disableLayout();

錯誤處理：
當寫程式時，發生問題是難免的事，Zend Framework吐出來的錯誤訊息有點亂，可以做個簡單的錯誤處理畫面，
先在Project/application/controllers/裡建一個ErrorController.php
在ErrorController.php：

顯示原始碼
列印？
1<?php
2    class ErrorController extends Zend_Controller_Action {
3        public function errorAction() {
4            //取得error_handler參數
5            $error = $this->_getParam('error_handler');
6            //取得Controller Response
7            $response = $this->getResponse();
8            //也可以使用view script和Layout來做好看的錯誤頁面
9            //關閉預設viewRenderer
10            $this->_helper->viewRenderer->setNoRender();
11            //停止使用Layout
12            $this->_helper->layout->disableLayout();
13            switch ($error->type) {
14                //找不到CONTROLLER
15                case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
16                //找不到ACTION
17                case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
18                    //設定HttpResponseCode為404
19                    $response->setHttpResponseCode(404);
20                    echo "<h1>Page Not Found</h1>";
21                default:
22                    //設定HttpResponseCode為500
23                    $response->setHttpResponseCode(500);
24                    echo "<h1>Application Error</h1>";
25            }
26        }
27    }
28?>

此時當網頁有錯誤時，便會執行ErrorController的errorAction

Categories: PHPZendFramework

Related Posts

PHP

Authentication for Privately Repositories in Composer

在一些專案裡，可能會用到一些公司或個人的 Private Repository，因此在進行套件更新時，就會需要一些認證才能繼續動作。 Composer 提供了透過 auth.json 進行認證的功能，方便在需要認證的情境使用。

PHP

How to Calculate the Nth Root of any Number with PHP

在 PHP 中，雖然有提供 sqrt() 來計算平方根，但是也僅限於平方根，對於立方根或次方根就無法處理，因此需要透過一點小技巧來計算。

PHP

How to Automatically Generate PHP code with PHP-Parser

在大型專案中，因為架構極其複雜，所以常會看到有許多由抽象類別、介面實作出來同性質的子物件，比如說 Parser、Extractor 等等。而當依據需求實作出大量又有些微客製化的物件後，如果要一次性調整大量的物件程式碼，比方說修改特定 Variable 的值，就會非常耗費人力。 在這種情況下，我們可以透過 nikic/PHP-Parser 套件達成自動產生 PHP code 的效果。