Zend Framework チュートリアル フロントエンド コントローラー Zend_Controller_Front の使い方の詳細説明

この記事の例では、Zend Framework チュートリアルのフロントエンド コントローラー Zend_Controller_Front の使用法について説明します。参考として、次のように全員と共有してください:

主な機能

ZendFramework の MVC 実装の中心的なメカニズムは、Zend_Controller_Front フロントエンド コントローラーを介して行われます。これは、リクエスト環境の初期化、リクエストの処理、ルート配布、および完了に使用されます。 Zend_Controller_Front サンプル モードで使用される単一ユニット。したがって、アプリケーションにはフロントエンド コントローラーが 1 つだけあります。フロントエンド コントローラーに特別な機能を提供する必要がある場合は、Zend_Controller_Front を継承してフロントエンド コントローラーをカスタマイズできます。

Mainメソッド

getInstance()

は、フロントエンドコントローラーインスタンスを取得するために使用されます。フロント コントローラー オブジェクトを作成する唯一の方法。

$front = Zend_Controller_Front::getInstance();

setControllerDirectory()とaddControllerDirectory()

setControllerDirectory()はアクションコントローラーアクションコントローラークラスファイルの保存場所を設定します。パラメータにはパス文字列または連想配列を使用できます。

例:

//路径是相对于应用的/application目录下
// 字符串
$front->setControllerDirectory('../application/controllers');
// 关联数组
$front->setControllerDirectory(array(
  'default' => '../application/controllers',
  'blog'  => '../modules/blog/controllers',
  'news'  => '../modules/news/controllers',
));
// Add a 'foo' module directory:
$front->addControllerDirectory('../modules/foo/controllers', 'foo');

注: モジュール名を指定せずに addControllerDirectory() を使用すると、ディレクトリはデフォルトのモジュールに設定されます。ディレクトリが設定されている場合は上書きされます。

コントローラー ディレクトリの現在の設定は、getControllerDirectory() を通じて取得でき、モジュールとディレクトリのペアの連想配列が返されます。

addModuleDirectory() と getModuleDirectory()

フロントエンド コントローラーの機能の 1 つは、モジュール ディレクトリ構造を定義して、「モジュール」と呼ばれる独立したコンポーネントを作成できることです。

各モジュールは独自のディレクトリに配置され、デフォルト モジュールと同じディレクトリ構造を持ちます。たとえば、少なくとも「controllers」サブディレクトリ、「views」サブディレクトリ、およびその他のアプリケーション サブディレクトリがあります。

addModuleDirectory() を使用すると、1 つ以上のモジュール ディレクトリを含むディレクトリ名を渡すことができます。 次に、それらはスキャンされ、コントローラ ディレクトリとしてフロント コントローラに追加されます。

次に、特定のモジュールまたは現在のモジュール パスを確認したい場合は、getModuleDirectory() を呼び出し、オプションでモジュール名を渡してモジュール ディレクトリを取得します。

dispatch()

dispatch(Zend_Controller_Request_Abstract $request = null, Zend_Controller_Response_Abstract $response = null) は、フロントエンド コントローラーの最も重い作業を完了します。このメソッドはオプションのパラメータ要求オブジェクトや応答オブジェクトを受け取り、開発者がそれぞれのカスタム オブジェクトを渡すことができます。

リクエストまたはレスポンスオブジェクトが渡されない場合、dispatch()は以前に登録されたオブジェクトをチェックしてそれを使用し、見つからない場合はデフォルトのオブジェクトバージョンを作成します(どちらもデフォルトではHTTPオブジェクトを使用します)。

同様に、dispatch() は最初に登録されたルーターとディスパッチャーのオブジェクトをチェックし、見つからない場合はデフォルト バージョンをインスタンス化します。

配布プロセスには、ルーティング、ディスパッチ、レスポンスという 3 つの異なるイベントがあります。

ルーティングは、dispatch() が呼び出されたときにリクエスト オブジェクトの値を使用して 1 回だけ発生します。ディスパッチはループ内で発生します。リクエストによって複数のアクションのディスパッチが指示される場合や、コントローラまたはプラグインがリクエスト オブジェクトをリセットして、追加のアクションが強制的にディスパッチされる場合があります。すべてが完了すると、フロント コントローラーは応答オブジェクトを返します。

run()

Zend_Controller_Front::run($path) は、コントローラーを含むディレクトリへのパスであるパラメーターを 1 つだけ持つ静的メソッドです。まず getInstance() を通じてフロントエンド コントローラー インスタンスを取得し、次に setControllerDirectory() を通じて受信パスを登録し、最後にそれを配布します。

基本的に、フロントエンド コントローラー環境をカスタマイズする必要がない場合、run() はフロントエンド コントローラー環境を確立する非常に便利なメソッドです。

Zend_Controller_Front::run('../application/controllers');

環境アクセサー メソッド

上記のメソッドに加えて、フロントエンド コントローラー環境に影響を与える可能性のあるアクセサー メソッドが多数あります。したがって、フロントエンド コントローラー デリゲート (デリゲート) の環境にも影響を与える可能性があります。 ） クラス。

resetInstance() メソッドは、現在の設定をすべてクリアします。主にテストに使用されますが、複数のフロント コントローラーをチェーンする場合にも使用できます。

(set|get)DefaultControllerName() メソッドは、デフォルト コントローラーの別の名前を指定し (それ以外の場合は 'index' を使用)、現在の値を取得できます。彼らはディストリビュータを代理します。

(set|get)DefaultAction() メソッドは、デフォルトのアクションに別の名前を指定し (それ以外の場合は 'index' を使用)、現在の値を取得できます。彼らはディストリビュータを代理します。

(set|get)Request() メソッドは、配信処理で使用されるリクエストのクラスまたはオブジェクトを指定し、現在のリクエスト オブジェクトを取得します。リクエスト オブジェクトを設定するときに、リクエスト クラスの名前を渡すことができます。このメソッドはクラス ファイルをロードしてインスタンスを作成します。

(set|get)Router() メソッドは、配布プロセスで使用されるルーター クラスまたはオブジェクトを指定し、現在のオブジェクトを取得します。ルーターを設定するときにルーター クラスの名前を渡すと、このメソッドがクラス ファイルをロードしてインスタンスを作成します。

ルーターオブジェクトを取得するときは、まずルーターオブジェクトが存在するかどうかを確認し、存在しない場合はデフォルトのルーターインスタンスを作成します（ルーターを書き換えます）。

(set|get)BaseUrl() メソッドは、リクエストをルーティングするときに削除するベース アドレス (ベース URL) を指定し、現在の値を取得します。この値は、ルーティングの前にルーターに提供されます。

(set|get)Dispatcher()方法指定分发过程中使用的分发器类或对象，以及获取当前对象。设定分发器对象时，可以传入一个分发器类的名字，该方法将加载类文件并创建实例。

获取分发器对象时，首先检查是否已有一个存在，如果没有，将创建一个默认的分发器实例。

(set|get)Response()方法指定分发过程中使用的响应类或对象，已经获取当前对象。设定响应对象时，可以传入一个响应类的名字，该方法将加载类文件并创建实例。

registerPlugin(Zend_Controller_Plugin_Abstract $plugin, $stackIndex = null)方法允许注册一个插件对象。通过设置可选参数$stackIndex，插件执行的顺序。

unregisterPlugin($plugin)方法移除插件对象。$plugin可以是一个插件对象或者代表移除插件类的字符串。

throwExceptions($flag)方法用来开启或者关闭分发过程中抛出异常的能力。默认的，异常引起并放置在响应对象中；开启throwExceptions()将覆盖这一行为。

returnResponse($flag)方法通知前端控制器是否从dispatch()中返回请求对象（true），否则自动发送响应对象（false—）。默认的，响应对象被自动发送（通过调用Zend_Controller_Response_Abstract::sendResponse()）；开启returnResponse()将覆盖这一行为。

返回响应对象的原因包括希望在发送响应前检查异常，记录响应的各种属性（例如消息头）等等。

前端控制器参数

介绍里曾提到前端控制器可以用作各种控制器组件的注册表。它通过一个"param"家族的方法来做到这些。这些方法允许通过前端控制器注册任意类型的数据 —— 对象和变量，可以在分发链中的任何时候获取。这些变量被传递到路由器，分发器，以及动作控制器。这些方法包括：

setParam($name, $value)方法设定值为$value的单个参数$name。
setParams(array $params)方法通过关联数组一次设定多个参数。
getParam($name)方法通过$name标识符获取单个参数。
getParams()方法一次获取整个参数列表。
clearParams()方法可以清空一个参数（传入单个字符串标识符），清空多个参数（传入字符串标识符数组），清空整个参数栈（不传入参数）。

有几个预定义的参数可供设定，它们在分发链中有特别的用途：

useDefaultControllerAlways用来提示 分发器遇到无法分发的请求时使用默认模块的默认控制器。这默认是关闭的。

阅读可能遭遇的MVC异常获得使用该设定的更详尽信息。

disableOutputBuffering用来提示 is used to hint to 分发器不使用输出缓冲来捕捉动作控制器产生的输出。默认的，分发器捕捉任何输出并追加到响应对象的主体内容。

noViewRenderer用来禁用ViewRenderer。设定该参数为true可以禁用该助手。

noErrorHandler 用来禁用错误处理器插件。设定该参数为true可以禁用该插件。

自定义前端控制器

要继承前端控制器，至少需要覆盖getInstance()方法：

class My_Controller_Front extends Zend_Controller_Front
{
  public static function getInstance()
  {
    if (null === self::$_instance) {
      self::$_instance = new self();
    }
    return self::$_instance;
  }
}

覆盖getInstance()保证后面调用Zend_Controller_Front::getInstance()会返回子类的实例，而不是Zend_Controller_Front实例，这对于一些可替换的路由器和视图助手非常有用。

通常不需要继承前端控制器，除非你需要增加新的功能（比如，一个插件自动加载器，或者一个方法来指定动作助手路径）。你想要改动的地方可能包括修改控制器目录的存储方式，使用的默认路由器以及分发器。

ZendFramewrok提供的默认前端控制器已经足够我们使用了，通过Bootstrap功能，完全没有必要手动编写代码改变Zend_Controller_Front的默认机制。所以通常情况下Zend_Controller_Front对于应用来说是不存在。如果需要使用Zend_Controller_Front提供的功能，通过Zend_Controller_Front::getInstance();获取实例即可。

希望本文所述对大家PHP程序设计有所帮助。

更多Zend Framework教程之前端控制器Zend_Controller_Front用法详解相关文章请关注PHP中文网！