Documentation

Zend Framework 0.6(日本語) - Zend Framework Migration Notes

Zend Framework 0.6(日本語)

以前のバージョンから Zend Framework 0.6 またはそれ以降に更新する際は、 下記の移行上の注意点に注意すべきです。

Zend_Controller

MVC コンポーネントの基本的な部分は変わっていません。 次のいずれの方法も使用可能です。

  1. Zend_Controller_Front::run('/path/to/controllers');
  1. /* -- ルータを作成します -- */
  2. $router = new Zend_Controller_RewriteRouter();
  3. $router->addRoute('user',
  4.                   'user/:username',
  5.                   array('controller' => 'user', 'action' => 'info')
  6. );
  7.  
  8. /* -- ルータをコントローラに設定します -- */
  9. $ctrl = Zend_Controller_Front::getInstance();
  10. $ctrl->setRouter($router);
  11.  
  12. /* -- コントローラのディレクトリを設定し、ディスパッチします -- */
  13. $ctrl->setControllerDirectory('/path/to/controllers');
  14. $ctrl->dispatch();

レスポンスオブジェクトを使用して、コンテンツとヘッダを取得することを推奨します。 これにより、アプリケーション内で より柔軟な出力書式の切り替え (たとえば XHTML ではなく JSONXML を使用するなど) ができるようになります。 デフォルトでは、 dispatch() はレスポンスのレンダリングを行い、 ヘッダとレンダリングされた内容の両方を送信します。 フロントコントローラから returnResponse() を使用してレスポンスを返し、レスポンスのレンダリングを独自に行うこともできます。 将来のバージョンのフロントコントローラでは、 レスポンスオブジェクトに出力バッファリングを使用する予定です。

これまでの API に加え、多くの機能が追加されています。 追加された機能についてはドキュメントを参照ください。

最大の変更点は、多くのコンポーネントで サブクラス化による拡張が可能になったことです。以下にポイントを整理します。

  • Zend_Controller_Front::dispatch() は、デフォルトでレスポンスオブジェクトの例外をトラップします。 例外の内容はレンダリングしません。これにより、 システムについての機密情報がレンダリングされてしまうことを防ぎます。 この挙動を変更するにはいくつかの方法があります。

    • フロントコントローラで throwExceptions() を設定します。

      1. $front->throwExceptions(true);
    • レスポンスオブジェクトで renderExceptions() を設定します。

      1. $response->renderExceptions(true);
      2. $front->setResponse($response);
      3. $front->dispatch();
      4.  
      5. // あるいは
      6. $front->returnResponse(true);
      7. $response = $front->dispatch();
      8. $response->renderExceptions(true);
      9. echo $response;
  • Zend_Controller_Dispatcher_Interface::dispatch() は、ディスパッチャトークンではなく リクエストオブジェクト を使用するようになりました。

  • Zend_Controller_Router_Interface::route() は、ディスパッチャトークンではなく リクエストオブジェクト を使用するようになりました。

  • Zend_Controller_Action の変更点は以下のようになります。

    • コンストラクタが受け付ける引数は Zend_Controller_Request_Abstract $requestZend_Controller_Response_Abstract $response および array $params (オプション) の三つになりました。 Zend_Controller_Action::__construct() は、これらを使用してリクエストやレスポンス、 そしてオブジェクトの invokeArgs プロパティを指定します。 コンストラクタをオーバーライドすることで、 この挙動をお望みのように変更できます。 さらによいことに、 init() メソッドを使用してインスタンスの設定を自由に行うことができます。 このメソッドは、コンストラクタでの処理の最後にコールされます。

    • run() は final メソッドではなくなりました。 しかし、このメソッドはもはやフロントコントローラでは使用されません。 これは、クラスをページコントローラとして使用する場合にのみ使用します。 オプションの引数 Zend_Controller_Request_Abstract $request および Zend_Controller_Response_Abstract $response を受け取ります。

    • indexAction() を定義する必要はなくなりました。 しかし、デフォルトのアクションとして定義しておくことを推奨します。 これにより、RewriteRouter とアクションコントローラで デフォルトのアクションメソッドを別々に指定できるようになります。

    • __call() をオーバーライドして、 未定義のアクションが自動的に処理されるようにする必要があります。

    • _redirect() にはオプションで二番目、三番目の引数が追加されました。 二番目の引数はリダイレクト時に返す HTTP コードです。 三番目の引数 $prependBase を使用すると、リクエストオブジェクトに登録したベース URLURL の前に連結することを指示できます。

    • プロパティ $_action は設定されなくなりました。 このプロパティの内容は Zend_Controller_Dispatcher_Token でしたが、これは現在のバージョンにはもう存在しません。 トークンの唯一の目的は、要求されたコントローラやアクション、 URL パラメータについての情報を提供することでした。 これらは現在はリクエストオブジェクトから次のようにして取得できるようになっています。

      1. // 要求されたコントローラ名を取得します。
      2. // その際には $this->_action->getControllerName() を使用します。
      3. // 以下の例では getRequest() を使用していますが、直接 $_request プロパティに
      4. // アクセスしてもかまいません。ただ getRequest() を使用することを推奨します。
      5. // とういのは、親クラスがこのメソッドをオーバーライドして挙動を変更しているかもしれないからです。
      6. $controller = $this->getRequest()->getControllerName();
      7.  
      8. // 要求されたアクション名を取得します。
      9. // その際には $this->_action->getActionName() を使用します。
      10. $action = $this->getRequest()->getActionName();
      11.  
      12. // リクエストパラメータを取得します。
      13. // これは変わっていません。_getParams() メソッドおよび _getParam() メソッドは
      14. // 現在は単なるリクエストオブジェクトへのプロキシです。
      15. $params = $this->_getParams();
      16. // パラメータ 'foo' を取得します。見つからなかった場合はデフォルト値 'default' を設定します
      17. $foo = $this->_getParam('foo', 'default');
    • noRouteAction() は削除されました。 存在しないアクションメソッドを扱うには、 __call() を使用してデフォルトのアクションに誘導します。

      1. public function __call($method, $args)
      2. {
      3.     // 存在しない 'Action' メソッドが要求された場合に、
      4.     // それをデフォルトのアクションに渡します。
      5.     if ('Action' == substr($method, -6)) {
      6.         return $this->defaultAction();
      7.     }
      8.  
      9.     throw new Zend_Controller_Exception('無効なメソッド呼び出しです');
      10. }
  • Zend_Controller_RewriteRouter::setRewriteBase() は削除されました。かわりに Zend_Controller_Front::setBaseUrl() を使用してください (あるいは、リクエストクラスを使用している場合は Zend_Controller_Request_Http::setBaseUrl() を使用します)。

  • Zend_Controller_Plugin_InterfaceZend_Controller_Plugin_Abstract に置き換えられました。 すべてのメソッドは、ディスパッチャトークンではなく リクエストオブジェクト をやり取りするようになりました。

Copyright

© 2006-2019 by Zend, a Rogue Wave Company. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts