All the methods which the plugin implemented according to this interface, will be called at the proper time automatically.
(Yaf >=1.0.0)
Les plugins apportent la possibilité d'étendre et de personnaliser facilement le framework. Un plugin est une classe qui étend Yaf_Plugin_Abstract et qui redéfinit une ou plusieurs méthodes d'accroche, appelées automatiquement à des moments fixes du cycle de distribution : avant et après le routage, avant et après la boucle de distribution, et avant et après chaque distribution unitaire.
Un plugin est attaché au distributeur avec Yaf_Dispatcher::registerPlugin(), généralement dans le Bootstrap ; une fois enregistré, toutes les méthodes d'accroche que le plugin implémente sont appelées au moment voulu, chacune recevant les instances courantes de Yaf_Request_Abstract et de Yaf_Response_Abstract.
Exemple #1 Exemple d'un plugin
<?php
/* La classe bootstrap doit être définie ici : ./application/Bootstrap.php */
class Bootstrap extends Yaf_Bootstrap_Abstract {
public function _initPlugin(Yaf_Dispatcher $dispatcher) {
/* Enregistre un plugin */
$dispatcher->registerPlugin(new TestPlugin());
}
}
/* La classe du plugin doit être placée ici : ./application/plugins/ */
class TestPlugin extends Yaf_Plugin_Abstract {
public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
/* avant le routage
dans cette accroche, il est possible de réécrire des URL */
var_dump("routerStartup");
}
public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
/* routage terminé
dans cette accroche, il est possible de vérifier l'authentification */
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) {
/* dernière accroche
dans cette accroche, il est possible de journaliser ou d'implémenter la mise en page */
var_dump("dispatchLoopShutdown");
}
}
Class IndexController extends Yaf_Controller_Abstract {
public function indexAction() {
return FALSE; //empêche le rendu
}
}
$config = array(
"application" => array(
"directory" => dirname(__FILE__) . "/application/",
),
);
$app = new Yaf_Application($config);
$app->bootstrap()->run();
?>Résultat de l'exemple ci-dessus est similaire à :
string(13) "routerStartup" string(14) "routerShutdown" string(19) "dispatchLoopStartup" string(11) "preDispatch" string(12) "postDispatch" string(20) "dispatchLoopShutdown"
$request, Yaf_Response_Abstract $response): void$request, Yaf_Response_Abstract $response): void$request, Yaf_Response_Abstract $response): voidAll the methods which the plugin implemented according to this interface, will be called at the proper time automatically.