The Yaf_Dispatcher class

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

Yaf_Dispatcher

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 __construct()

public Yaf_Dispatcher autoRender(bool $flag = ?)

public Yaf_Dispatcher catchException(bool $flag = ?)

public bool disableView()

public Yaf_Response_Abstract dispatch(Yaf_Request_Abstract $request)

public Yaf_Dispatcher enableView()

public Yaf_Dispatcher flushInstantly(bool $flag = ?)

public Yaf_Application getApplication()

public string getDefaultAction()

public string getDefaultController()

public string getDefaultModule()

public static Yaf_Dispatcher getInstance()

public Yaf_Request_Abstract getRequest()

public Yaf_Router getRouter()

public Yaf_View_Interface initView(string $templates_dir, array $options = ?)

public Yaf_Dispatcher registerPlugin(Yaf_Plugin_Abstract $plugin)

public Yaf_Dispatcher returnResponse(bool $flag)

public Yaf_Dispatcher setDefaultAction(string $action)

public Yaf_Dispatcher setDefaultController(string $controller)

public Yaf_Dispatcher setDefaultModule(string $module)

public Yaf_Dispatcher setErrorHandler(call $callback, int $error_types)

public Yaf_Dispatcher setRequest(Yaf_Request_Abstract $request)

public Yaf_Dispatcher setView(Yaf_View_Interface $view)

public Yaf_Dispatcher throwException(bool $flag = ?)

}

Properties

_router
_view
_request
_plugins
_instance
_auto_render
_return_response
_instantly_flush
_default_module
_default_controller
_default_action

Table of Contents

Yaf_Dispatcher::autoRender — Switch on/off autorendering
Yaf_Dispatcher::catchException — Switch on/off exception catching
Yaf_Dispatcher::__construct — Yaf_Dispatcher constructor
Yaf_Dispatcher::disableView — Disable view rendering
Yaf_Dispatcher::dispatch — Dispatch a request
Yaf_Dispatcher::enableView — Enable view rendering
Yaf_Dispatcher::flushInstantly — Switch on/off the instant flushing
Yaf_Dispatcher::getApplication — Retrieve the application
Yaf_Dispatcher::getDefaultAction — Retrive the default action name
Yaf_Dispatcher::getDefaultController — Retrive the default controller name
Yaf_Dispatcher::getDefaultModule — Retrive the default module name
Yaf_Dispatcher::getInstance — Retrive the dispatcher instance
Yaf_Dispatcher::getRequest — Retrive the request instance
Yaf_Dispatcher::getRouter — Retrive router instance
Yaf_Dispatcher::initView — Initialize view and return it
Yaf_Dispatcher::registerPlugin — Register a plugin
Yaf_Dispatcher::returnResponse — The returnResponse purpose
Yaf_Dispatcher::setDefaultAction — Change default action name
Yaf_Dispatcher::setDefaultController — Change default controller name
Yaf_Dispatcher::setDefaultModule — Change default module name
Yaf_Dispatcher::setErrorHandler — Set error handler
Yaf_Dispatcher::setRequest — The setRequest purpose
Yaf_Dispatcher::setView — Set a custom view engine
Yaf_Dispatcher::throwException — Switch on/off exception throwing