La classe Yaf_Dispatcher

(Yaf >=1.0.0)

Introduction

Le but de Yaf_Dispatcher est d'initialiser l'environnement de la requête, de router la requête entrante, puis de distribuer les actions découvertes ; il agrège toutes les réponses et les retourne une fois le processus terminé.

Yaf_Dispatcher implémente également le patron singleton, ce qui signifie qu'une seule instance de cette classe peut être disponible à un instant donné. Ceci lui permet aussi d'agir comme un registre dans lequel les autres objets du processus de distribution peuvent puiser.

Synopsis de la classe

final class Yaf_Dispatcher {

/* Propriétés */

protected $_router;

protected $_view;

protected $_request;

protected $_plugins;

protected static $_instance;

protected $_auto_render;

protected $_return_response;

protected $_instantly_flush;

protected $_default_module;

protected $_default_controller;

protected $_default_action;

/* Méthodes */

private function __construct()

public function autoRender(?bool $flag = null): Yaf_Dispatcher|bool

public function catchException(?bool $flag = null): Yaf_Dispatcher|bool

public function disableView(): ?Yaf_Dispatcher

public function dispatch(Yaf_Request_Abstract $request): Yaf_Response_Abstract|null|false

public function enableView(): ?Yaf_Dispatcher

public function flushInstantly(?bool $flag = null): Yaf_Dispatcher|bool

public function getApplication(): ?Yaf_Application

public function getDefaultAction(): ?string

public function getDefaultController(): ?string

public function getDefaultModule(): ?string

public static function getInstance(): ?Yaf_Dispatcher

public function getRequest(): ?Yaf_Request_Abstract

public function getResponse(): ?Yaf_Response_Abstract

public function getRouter(): ?Yaf_Router

public function initView(string $templates_dir, ?array $options = null): Yaf_View_Interface|null|false

public function registerPlugin(Yaf_Plugin_Abstract $plugin): Yaf_Dispatcher|null|false

public function returnResponse(bool $flag = false): Yaf_Dispatcher|bool

public function setDefaultAction(string $action): Yaf_Dispatcher|null|false

public function setDefaultController(string $controller): Yaf_Dispatcher|null|false

public function setDefaultModule(string $module): Yaf_Dispatcher|null|false

public function setErrorHandler(mixed $callback, int $error_types = 0): Yaf_Dispatcher|null|false

public function setRequest(Yaf_Request_Abstract $request): ?Yaf_Dispatcher

public function setResponse(Yaf_Response_Abstract $response): ?Yaf_Dispatcher

public function setView(Yaf_View_Interface $view): ?Yaf_Dispatcher

public function throwException(?bool $flag = null): Yaf_Dispatcher|bool

}

Propriétés

_router: L'instance de Yaf_Router utilisée par le distributeur pour router les requêtes.
_view: L'implémentation de Yaf_View_Interface utilisée pour rendre les vues, initialisée paresseusement lors de la première distribution.
_request: L'objet requête en cours de distribution.
_plugins: La liste des plugins enregistrés avec Yaf_Dispatcher::registerPlugin().
_instance: Référence statique vers l'unique instance du distributeur.
_auto_render: Indique si le distributeur rend automatiquement la vue après la distribution. Vaut true par défaut.
_return_response: Indique si Yaf_Application::run() retourne l'objet réponse au lieu de l'envoyer directement. Vaut false par défaut.
_instantly_flush: Indique si le corps de la réponse est envoyé immédiatement lorsqu'il est défini. Vaut true par défaut.
_default_module: Le nom du module par défaut, issu de l'entrée de configuration application.dispatcher.defaultModule.
_default_controller: Le nom du contrôleur par défaut, issu de l'entrée de configuration application.dispatcher.defaultController.
_default_action: Le nom de l'action par défaut, issu de l'entrée de configuration application.dispatcher.defaultAction.

Sommaire

Yaf_Dispatcher::autoRender — Active ou désactive le rendu automatique
Yaf_Dispatcher::catchException — Active/désactive la capture des exceptions
Yaf_Dispatcher::__construct — Constructeur de Yaf_Dispatcher
Yaf_Dispatcher::disableView — Désactive le rendu de la vue
Yaf_Dispatcher::dispatch — Répartit une requête
Yaf_Dispatcher::enableView — Active le rendu de la vue
Yaf_Dispatcher::flushInstantly — Active/désactive l'envoi instantané
Yaf_Dispatcher::getApplication — Récupère l'application
Yaf_Dispatcher::getDefaultAction — Récupère le nom de l'action par défaut
Yaf_Dispatcher::getDefaultController — Récupère le nom du contrôleur par défaut
Yaf_Dispatcher::getDefaultModule — Récupère le nom du module par défaut
Yaf_Dispatcher::getInstance — Récupère l'instance du distributeur
Yaf_Dispatcher::getRequest — Récupère l'instance de la requête
Yaf_Dispatcher::getResponse — Récupère l'objet réponse
Yaf_Dispatcher::getRouter — Récupère l'instance du routeur
Yaf_Dispatcher::initView — Initialise la vue et la retourne
Yaf_Dispatcher::registerPlugin — Enregistre un plugin
Yaf_Dispatcher::returnResponse — Active ou désactive le retour de la réponse
Yaf_Dispatcher::setDefaultAction — Modifie le nom par défaut de l'action
Yaf_Dispatcher::setDefaultController — Modifie le nom par défaut du contrôleur
Yaf_Dispatcher::setDefaultModule — Change le nom du module par défaut
Yaf_Dispatcher::setErrorHandler — Définit un gestionnaire d'erreur
Yaf_Dispatcher::setRequest — Définit l'objet de requête
Yaf_Dispatcher::setResponse — Définit l'objet de réponse
Yaf_Dispatcher::setView — Définit un moteur de vue personnalisé
Yaf_Dispatcher::throwException — Active/désactive le lancement d'exceptions