La clase Yaf_Dispatcher

(Yaf >=1.0.0)

Introducción

El propósito de la clase Yaf_Dispatcher es inicializar el entorno de peticiones, enrutar las peticiones entrantes, y despachar cualquier acción encontrada; agrega las respuestas y las devuelve cuando el proceso está completado.

Yaf_Dispatcher también implementa el patrón Singleton, lo que significa que solamente puede estar disponible una instancia de la misma a la vez. Esto le permite actuar también como un registro en el que los demás objetos del proceso de despacho pueden apoyarse.

Sinopsis de la clase

final class Yaf_Dispatcher {

/* Propiedades */

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étodos */

public 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

}

Propiedades

_router: La instancia de Yaf_Router que usa el despachador para enrutar las peticiones.
_view: La implementación de Yaf_View_Interface usada para renderizar las vistas, inicializada de forma perezosa en el primer despacho.
_request: El objeto de petición que se está despachando.
_plugins: La lista de plugins registrados con Yaf_Dispatcher::registerPlugin().
_instance: Referencia estática a la única instancia del despachador.
_auto_render: Si el despachador renderiza automáticamente la vista después del despacho. Por omisión, true.
_return_response: Si Yaf_Application::run() devuelve el objeto de respuesta en lugar de enviarlo directamente. Por omisión, false.
_instantly_flush: Si el cuerpo de la respuesta se vuelca en cuanto se establece. Por omisión, true.
_default_module: El nombre del módulo por omisión, tomado de la entrada de configuración application.dispatcher.defaultModule.
_default_controller: El nombre del controlador por omisión, tomado de la entrada de configuración application.dispatcher.defaultController.
_default_action: El nombre de la acción por omisión, tomado de la entrada de configuración application.dispatcher.defaultAction.

Tabla de contenidos

Yaf_Dispatcher::autoRender — Activa/desactiva la auto-renderizado
Yaf_Dispatcher::catchException — Activar/desactivar la captura de excepciones
Yaf_Dispatcher::__construct — Constructor de la clase Yaf_Dispatcher
Yaf_Dispatcher::disableView — Deshabilita el renderizado de vistas
Yaf_Dispatcher::dispatch — Despachar una petición
Yaf_Dispatcher::enableView — Habilita el renderizado de vistas
Yaf_Dispatcher::flushInstantly — Activa/desactiva el vaciado instantáneo
Yaf_Dispatcher::getApplication — Recupera la aplicación
Yaf_Dispatcher::getDefaultAction — Recupera el nombre de la acción por omisión
Yaf_Dispatcher::getDefaultController — Recupera el nombre del controlador por omisión
Yaf_Dispatcher::getDefaultModule — Recupera el nombre del módulo por omisión
Yaf_Dispatcher::getInstance — Recupeara la instancia despachadora
Yaf_Dispatcher::getRequest — Recupera la instancia de petición
Yaf_Dispatcher::getResponse — Obtener el objeto de respuesta
Yaf_Dispatcher::getRouter — Recuperar la instancia de envío
Yaf_Dispatcher::initView — Inicializa una vista y la devuelve
Yaf_Dispatcher::registerPlugin — Registra un plugin
Yaf_Dispatcher::returnResponse — El propósito de returnResponse
Yaf_Dispatcher::setDefaultAction — Cambia el nombre de la acción por omisión
Yaf_Dispatcher::setDefaultController — Cambia el nombre del controlador por omisión
Yaf_Dispatcher::setDefaultModule — Cambia el nombre del módulo por omisión
Yaf_Dispatcher::setErrorHandler — Establece el gestor de errores
Yaf_Dispatcher::setRequest — El propósito de setRequest
Yaf_Dispatcher::setResponse — Establecer el objeto de respuesta
Yaf_Dispatcher::setView — Establecer un motor de vistas personalizado
Yaf_Dispatcher::throwException — Activa/desactiva el lanzamiento de excepciones

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.