PHP 8.4.1 Released!

    Yaf_Plugin_Abstract 类

    (Yaf >=1.0.0)

    简介

    Plugins 允许轻松地定制和扩展框架。

    插件（Plugin）是类。实际定义的类将会基于组件变化——需要实现这些接口，但该插件（Plugin）本身就是一个类。

    插件（plugin）通过使用 Yaf_Dispatcher::registerPlugin() 加载到 Yaf 中，在框架注册后，插件根据接口实现的所有方法将会在恰当的时间被调用。

    示例

    示例 #1 插件示例

    <?php
    /* bootstrap class should be defined under ./application/Bootstrap.php */
    class Bootstrap extends Yaf_Bootstrap_Abstract {
    public function     _initPlugin(Yaf_Dispatcher $dispatcher) {
    /* register a plugin */
    $dispatcher->registerPlugin(new TestPlugin());
    }
    }

    /* plugin class should be placed under ./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) {
    /* final hook
    in this hook user can do logging or implement 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"

    类摘要

    class Yaf_Plugin_Abstract {
    /* 方法 */
    public dispatchLoopShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void
    public dispatchLoopStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void
    public postDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void
    public preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void
    public preResponse(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void
    public routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void
    public routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void
    }

    目录

    改进此页面

    了解如何改进此页面 • 提交拉取请求 • 报告一个错误
    ＋添加备注

    用户贡献的备注 1 note

    up
    1
    gianjason#gmail.com
    11 years ago
    All the methods which the plugin implemented according to this interface, will be called at the proper time automatically.
    ＋添加备注
    To Top