betterCode() PHP 2025

    Класс Yaf_Plugin_Abstract

    (Yaf >=1.0.0)

    Введение

    Плагины позволяют легко расширять и настраивать фреймворк.

    Плагины являются классами. Определение класса будет меняться в зависимости от компонента - вам может понадобиться реализовать этот интерфейс, но факт остаётся фактом, плагин сам является классом.

    Плагин должен быть загружен в Yaf с использованием Yaf_Dispatcher::registerPlugin(). После регистрации, все методы, реализованные плагином в соответствии с этим интерфейсом, будут вызываться вовремя.

    Примеры

    Пример #1 Пример плагина

    <?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) {
    /* последняя возможность для пользователя что-то сделать */
    var_dump("dispatchLoopShutdown");
    }
    }

    Class     IndexController extends Yaf_Controller_Abstract {
    public function     indexAction() {
    return     FALSE; //предотвращаем рендеринг
    }
    }

    $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
    12 years ago
    All the methods which the plugin implemented according to this interface, will be called at the proper time automatically.
    ＋Добавить
    To Top