Yaf_Dispatcher::autoRender »

« Yaf_Bootstrap_Abstract

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

finalclassYaf_Dispatcher {

protected$_router;

protected$_view;

protected$_request;

protected$_plugins;

protectedstatic$_instance;

protected$_auto_render;

protected$_return_response;

protected$_instantly_flush;

protected$_default_module;

protected$_default_controller;

protected$_default_action;

public__construct()

publicautoRender(bool$flag = ?): Yaf_Dispatcher

publiccatchException(bool$flag = ?): Yaf_Dispatcher

publicdisableView(): bool

publicdispatch(Yaf_Request_Abstract$request): Yaf_Response_Abstract

publicenableView(): Yaf_Dispatcher

publicflushInstantly(bool$flag = ?): Yaf_Dispatcher

publicgetApplication(): Yaf_Application

publicgetDefaultAction(): string

publicgetDefaultController(): string

publicgetDefaultModule(): string

publicstaticgetInstance(): Yaf_Dispatcher

publicgetRequest(): Yaf_Request_Abstract

publicgetRouter(): Yaf_Router

publicinitView(string$templates_dir, array$options = ?): Yaf_View_Interface

publicregisterPlugin(Yaf_Plugin_Abstract$plugin): Yaf_Dispatcher

publicreturnResponse(bool$flag): Yaf_Dispatcher

publicsetDefaultAction(string$action): Yaf_Dispatcher

publicsetDefaultController(string$controller): Yaf_Dispatcher

publicsetDefaultModule(string$module): Yaf_Dispatcher

publicsetErrorHandler(call$callback, int$error_types): Yaf_Dispatcher

publicsetRequest(Yaf_Request_Abstract$request): Yaf_Dispatcher

publicsetView(Yaf_View_Interface$view): Yaf_Dispatcher

publicthrowException(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

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