简介
Yaf_Plugin_Abstract是Yaf的插件基类, 所有应用在Yaf的插件都需要继承实现这个类, 这个类定义了7个方法, 其中routerStartup, routerShutdown, dispatchLoopStartup, preDispatch, postDispatch, dispatchLoopShutdown会在对应的6个时机被调用; preResponse为预留方法, 目前不会被自动调用.
在PHP5.3之后, 打开yaf.use_namespace的情况下, 也可以使用 Yaf\Plugin_Abstract
abstract Yaf_Plugin_Abstract {public void routerStartup( Yaf_Request_Abstract $request ,
Yaf_Response_Abstract $response );public void routerShutdown( Yaf_Request_Abstract $request ,
Yaf_Response_Abstract $response );public void dispatchLoopStartup( Yaf_Request_Abstract $request ,
Yaf_Response_Abstract $response );public void preDispatch( Yaf_Request_Abstract $request ,
Yaf_Response_Abstract $response );public void postDispatch( Yaf_Request_Abstract $request ,
Yaf_Response_Abstract $response );public void dispatchLoopShutdown( Yaf_Request_Abstract $request ,
Yaf_Response_Abstract $response );public void preResponse( Yaf_Request_Abstract $request ,
Yaf_Response_Abstract $response );
}
![[注意]](images/note.gif) |
注意 |
|---|---|
| 插件有两种部署方式, 一种是部署在plugins目录下, 通过名称中的后缀(可通过ap.name_suffix和ap.name_separator来改变具体命名形式)来使得自动加载器可以正确加载. 另外一种是放置在类库, 由普通加载规则加载, 但无论哪种方式, 用户定义的插件都需要继承自Yaf_Plugin_Abstract. |
例子
注册和使用插件的例子
<?php
/* bootstrap类应该定义在./application/Bootstrap.php中 */
class Bootstrap extends Yaf_Bootstrap_Abstract {
public function _initPlugin(Yaf_Dispatcher $dispatcher) {
/* 注册一个插件 */
$dispatcher->registerPlugin(new TestPlugin());
}
}
/* 插件类应该放置在./application/plugins/下 */
class TestPlugin extends Yaf_Plugin_Abstract {
public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
/* 在路由之前执行, 在这个钩子里, 用户可以做一些URL重写 */
var_dump("routerStartup");
}
public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
/* 路由完成, 在这个钩子里, 用户可以做登录检测 */
var_dump("routerShutdown");
}
public function dispatchLoopStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
var_dump("dispatchLoopStartup");
}
public function preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
var_dump("preDispatch");
}
public function postDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
var_dump("postDispatch");
}
public function dispatchLoopShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
/* 最后一个钩子, 在这个钩子里, 用户可以记录日志或者实现布局(layout) */
var_dump("dispatchLoopShutdown");
}
}
class IndexController extends Yaf_Controller_Abstract {
public function indexAction() {
return FALSE; //prevent rendering
}
}
$config = array(
"application" => array(
"directory" => dirname(__FILE__) . "/application/",
),
);
$app = new Yaf_Application($config);
$app->bootstrap()->run();
?>
以上例程的输出类似于:
string(13) "routerStartup" string(14) "routerShutdown" string(19) "dispatchLoopStartup" string(11) "preDispatch" string(12) "postDispatch" string(20) "dispatchLoopShutdown"