Dispatcher Class Reference

Inheritance diagram for Dispatcher:

Object

List of all members.


Public Member Functions

 _invoke (&$controller, $params, $missingAction=false)
 _restructureParams ($params)
 baseUrl ()
 dispatch ($url, $additionalParams=array())
 parseParams ($from_url)
 start (&$controller)

Public Attributes

 $admin = false
 $base = false
 $plugin = null
 $webservices = null

Detailed Description

Definition at line 42 of file dispatcher.php.

Member Function Documentation

Dispatcher::_invoke ( &$  controller,
$  params,
$  missingAction = false 
)

Invokes given controller's render action if autoRender option is set. Otherwise the contents of the operation are returned as a string.

Parameters:
object $controller
array $params
boolean $missingAction
Returns:
string

Definition at line 255 of file dispatcher.php.

References $output, and start().

Referenced by dispatch().

Dispatcher::_restructureParams ( $  params  ) 

Enter description here...

Parameters:
unknown_type $params
Returns:
unknown

Definition at line 417 of file dispatcher.php.

Referenced by dispatch().

Dispatcher::baseUrl (  ) 

Returns a base URL.

Returns:
string Base URL

Definition at line 360 of file dispatcher.php.

Referenced by dispatch().

Dispatcher::dispatch ( $  url,
$  additionalParams = array() 
)

Dispatches and invokes given URL, handing over control to the involved controllers, and then renders the results (if autoRender is set).

If no controller of given name can be found, invoke() shows error messages in the form of Missing Controllers information. It does the same with Actions (methods of Controllers are called Actions).

Parameters:
string $url URL information to work on.
array $additionalParams Settings array ("bare", "return"), which is melded with the GET and POST params.
Returns:
boolean Success

Definition at line 78 of file dispatcher.php.

References $base, $plugin, _invoke(), _restructureParams(), baseUrl(), Object::cakeError(), Inflector::camelize(), Object::log(), parseParams(), start(), and Inflector::underscore().

Dispatcher::parseParams ( $  from_url  ) 

Returns array of GET and POST parameters. GET parameters are taken from given URL.

Parameters:
string $from_url URL to mine for parameter information.
Returns:
array Parameters found in POST and GET.

Definition at line 309 of file dispatcher.php.

References $data.

Referenced by dispatch().

Dispatcher::start ( &$  controller  ) 

Starts up a controller

Parameters:
object $controller

Definition at line 277 of file dispatcher.php.

Referenced by _invoke(), and dispatch().

Member Data Documentation

Dispatcher::$admin = false

Definition at line 51 of file dispatcher.php.

Dispatcher::$base = false

Definition at line 47 of file dispatcher.php.

Referenced by dispatch().

Dispatcher::$plugin = null

Definition at line 59 of file dispatcher.php.

Referenced by dispatch().

Dispatcher::$webservices = null

Definition at line 55 of file dispatcher.php.

The documentation for this class was generated from the following file: