The Yaf_Dispatcher class

    (Yaf >=1.0.0)

    Introduction

    Yaf_Dispatcher purpose is to initialize the request environment, route the incoming request, and then dispatch any discovered actions; it aggregates any responses and returns them when the process is complete.

    Yaf_Dispatcher also implements the Singleton pattern, meaning only a single instance of it may be available at any given time. This allows it to also act as a registry on which the other objects in the dispatch process may draw.

    Class synopsis

    final class Yaf_Dispatcher {
    /* Properties */
    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;
    /* Methods */
    public function __construct()
    public function autoRender(bool $flag = ?): Yaf_Dispatcher
    public function catchException(bool $flag = ?): Yaf_Dispatcher
    public function disableView(): bool
    public function dispatch(Yaf_Request_Abstract $request): Yaf_Response_Abstract
    public function enableView(): Yaf_Dispatcher
    public function flushInstantly(bool $flag = ?): Yaf_Dispatcher
    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 getRouter(): Yaf_Router
    public function initView(string $templates_dir, array $options = ?): Yaf_View_Interface
    public function registerPlugin(Yaf_Plugin_Abstract $plugin): Yaf_Dispatcher
    public function returnResponse(bool $flag): Yaf_Dispatcher
    public function setDefaultAction(string $action): Yaf_Dispatcher
    public function setDefaultController(string $controller): Yaf_Dispatcher
    public function setDefaultModule(string $module): Yaf_Dispatcher
    public function setErrorHandler(call $callback, int $error_types): Yaf_Dispatcher
    public function setRequest(Yaf_Request_Abstract $request): Yaf_Dispatcher
    public function setView(Yaf_View_Interface $view): Yaf_Dispatcher
    public function throwException(bool $flag = ?): Yaf_Dispatcher
    }

    Properties

    _router

    _view

    _request

    _plugins

    _instance

    _auto_render

    _return_response

    _instantly_flush

    _default_module

    _default_controller

    _default_action

    Table of Contents

    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.
    To Top