Zend Framework - アクションコントローラ記述例

HOME | TOP

■ アクションコントローラのシンプル例

アクションコントローラを作成するには、Zend_Controller_Actionクラスを継承したサブクラスを作成することになります。

リクエストに基づいて決定された「コントローラ名」と「アクション名」があり、
その「コントローラ名」で呼び出すアクションコントローラファイルが決まり、
「アクション名」でそのコントローラの中のどのアクションメソッドをコールするかが決まります。

つまり、アクションコントローラ内には呼ばれる可能性のあるアクションメソッドを最低でも１つは用意していないと意味がないことになります。

http://サーバ名/foo/bar がリクエストされた場合（コントローラ名が"foo"、アクション名が"bar"）を例に記述すると、最低限の記述は以下のようになります。
アクションコントローラ例 [application/controllers/FooController.php] <?php require_once 'Zend/Controller/Action.php'; class FooController extends Zend_Controller_Action { public function barAction() { /* メインの処理をここに */ } }

作成したアクションコントローラのファイルが正しく呼び出されて、正しくクラスがオブジェクト化されて、正しく目的のアクションメソッドがコールされるための命名規則は以下のとおりになります。

項目記述命名規則

コントローラ名 foo リクエストにコントローラ名に該当する部分が無ければデフォルトの"index"に

アクション名 bar リクエストにアクション名に該当する部分が無ければデフォルトの"index"に

ファイル名 FooController.php 先頭大文字コントローラ名＋ Controller.php

クラス名 FooController 先頭大文字コントローラ名＋ Controller

アクションメソッド名 barAction 先頭小文字アクション名＋ Action

上記のように、リクエストに「コントローラ名」や「アクション名」に該当する部分が無ければデフォルトのIndexController.phpファイルに記述したIndexControllerクラスのindexActionメソッドがコールされることになります。

このデフォルトはフロントコントローラのメソッドsetDefaultControllerName('foo')およびsetDefaultAction('bar')で再設定することができるようになっています。

項目	記述	命名規則
コントローラ名	foo	リクエストにコントローラ名に該当する部分が無ければデフォルトの"index"に
アクション名	bar	リクエストにアクション名に該当する部分が無ければデフォルトの"index"に
ファイル名	FooController.php	先頭大文字コントローラ名＋ Controller.php
クラス名	FooController	先頭大文字コントローラ名＋ Controller
アクションメソッド名	barAction	先頭小文字アクション名＋ Action

■ アクションコントローラに追加できる記述

コントローラ名およびアクション名に基づいて呼ばれるアクションメソッドの前後のタイミングで実行させたいコードを記述するためのメソッドが用意されています。
アクションコントローラ例 [application/controllers/FooController.php] <?php require_once 'Zend/Controller/Action.php'; class FooController extends Zend_Controller_Action { public function init() { /* 真っ先に呼ばれるメソッド */ } public function preDispatch() { /* ディスパッチ直前に呼ばれるメソッド */ } public function barAction() { /* ディスパッチの結果呼ばれるアクションメソッド（メインの処理） */ } public function postDispatch() { /* ディスパッチで呼ばれたメインの処理終了後に呼ばれるメソッド */ } }
特定のタイミングで呼ばれるメソッドを定義（記述）することができます。

なければ呼ばれないだけなので、必要なものだけを定義しておくといいでしょう。

■ アクションコントローラに追加できる記述（その２）

エラー発生時に呼ばれるメソッドを記述することができます。
アクションコントローラ例 [application/controllers/FooController.php] <?php require_once 'Zend/Controller/Action.php'; class FooController extends Zend_Controller_Action { public function barAction() { /* ディスパッチの結果呼ばれるメインの処理 */ } public function __call($methodName, $args) { /* ここにエラー発生時の処理を記述できる */ } }

ではアクションコントローラ内に__call()を記述していなかった場合のエラーはどうなるかというと、コントローラ名"error"、アクション名"error"のエラーコントローラを呼び出そうとします。
エラーコントローラ例 [application/controllers/ErrorController.php] <?php require_once 'Zend/Controller/Action.php'; class ErrorController extends Zend_Controller_Action { public function errorAction() { $this->view->setEncoding("sjis"); $errors = $this->_getParam('error_handler'); switch ($errors->type) { case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER: $errmsg = 'コントローラが見つかりません。'; break; case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION: $this->_redirect('/'); $errmsg = 'アクションが見つかりません。'; break; default: $errmsg = 'その他の例外が発生しました。'; break; } $this->view->errmsg = $errmsg; } }

見てのとおり単なるコントローラ名"error"、アクション名"error"のアクションコントローラです。
なので、エラーコントローラ用のビュースクリプトを用意する必要があります。
[application/views/scripts/error/error.phtml] <html> <head> <title>エラー</title> <script type="text/javascript" charset="UTF-8" src="//cache1.value-domain.com/xrea_header.js" async="async"></script> </head> <body> <h1>エラー</h1> <p>エラーが発生しました。</p> エラーの種類： <?php echo $this->escape($this->errmsg);?> </body> </html>

2010(C)Mingw