Zend Framework - プラグイン記述例

■ プラグインのシンプル例

プラグインはフロントコントローラで登録することになるのでクラス定義をフロントコントローラに直書きするか、別のファイルにクラスを書いてそれをフロントコントローラから呼び出す形にするかは自由です。

プラグイン例 [application/controllers/plugins/Foo.php] require_once 'Zend/Controller/Front.php'; class FooPlugin extends Zend_Controller_Plugin_Abstract { public function postDispatch(Zend_Controller_Request_Abstract $request) { } }

フロントコントローラと同じ'Zend/Controller/Front.php'を呼んでいれば、内部で'Zend/Controller/Plugin/Abstract.php'が呼ばれることになります。

フロントコントローラが行うルーティングおよびディスパッチの前後のタイミングで処理を実行するためのメソッドが用意されているので、必要なタイミングで実行されるメソッドを定義することになります。
routeStartup, routeShutdown, dispatchLoopStartup, preDispatch, postDispatch, dispatchLoopShutdownが用意されているメソッドになります。

フロントコントローラ [htdocs/index.php] <?php require_once 'Zend/Controller/Front.php'; require_once '../application/controllers/plugins/Foo.php'; // プラグインのクラス定義 $front = Zend_Controller_Front::getInstance(); $front->setControllerDirectory('../application/controllers'); $front->registerPlugin(new FooPlugin()); // プラグインのオブジェクトを作成して登録 $front->dispatch();

registerPlugin()メソッドを使ってプラグインのオブジェクトを登録しています。

フロントコントローラのインスタンスはシングルトンなので、プラグインを定義したファイル内で
Zend_Controller_Front::getInstance()->registerPlugin(new FooPlugin())とすることもできます。