array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'yaf-dispatcher.dispatch.php', 1 => 'Yaf_Dispatcher::dispatch', 2 => 'Dispatch a request', ), 'up' => array ( 0 => 'class.yaf-dispatcher.php', 1 => 'Yaf_Dispatcher', ), 'prev' => array ( 0 => 'yaf-dispatcher.disableview.php', 1 => 'Yaf_Dispatcher::disableView', ), 'next' => array ( 0 => 'yaf-dispatcher.enableview.php', 1 => 'Yaf_Dispatcher::enableView', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/yaf/yaf_dispatcher/dispatch.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

Yaf_Dispatcher::dispatch

(Yaf >=1.0.0)

Yaf_Dispatcher::dispatch — Dispatch a request

Description

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

This method does the heavy work of the Yaf_Dispatcher. It takes a request object.

The dispatch process has three distinct events:

Routing takes place exactly once, using the values in the request object when Yaf_Dispatcher::dispatch() is called. Dispatching takes place in a loop; a request may either indicate multiple actions to dispatch, or the controller or a plugin may reset the request object to force additional actions to dispatch (see Yaf_Plugin_Abstract). When all is done, the Yaf_Dispatcher returns a response.

Parameters

request

A Yaf_Request_Abstract instance to dispatch.

Return Values

The Yaf_Response_Abstract instance on success, false on failure, or null if the application is not initialized.

Examples

Example #1 Yaf_Dispatcher::dispatch() example

<?php
$app = new Yaf_Application(dirname(__FILE__) . "/conf/application.ini");
$app->bootstrap();

// Build a request pointing at ProductController::detailAction and
// dispatch it manually.
$request = new Yaf_Request_Http("/product/detail/id/42");

$response = Yaf_Dispatcher::getInstance()->dispatch($request);

if ($response instanceof Yaf_Response_Abstract) {
    $response->response();
}
?>

See Also