Dispatcher Class Info:
Properties:
-
base string
Base URL
-
here string
Current URL
-
params string
the params for this request
-
webroot string
webroot path
Method Summary:
- asset( $url )
- baseUrl( )
- cached( $url )
- cakeError( $method, $messages = array ( ) )
- __construct( $url = NULL, $base = false )
- _deliverAsset( $assetFile, $ext )
- dispatch( $url = NULL, $additionalParams = array ( ) )
- dispatchMethod( $method, $params = array ( ) )
- getUrl( $uri = NULL, $base = NULL )
- _invoke( $controller, $params )
- log( $msg, $type = 2 )
- Object( )
- parseParams( $fromUrl )
- _persist( $name, $return, $object, $type = NULL )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- _stop( $status = 0 )
- toString( )
- uri( )
asset
topChecks if a requested asset exists and sends it to the browser
- Parameters:
-
-
$url required
-
- Method defined in:
- cake/dispatcher.php on line 560
- Return
boolean True on success if the asset file was found and sent
- Access
public
baseUrl
topReturns a base URL and sets the proper webroot
- Method defined in:
- cake/dispatcher.php on line 323
- Return
string Base URL
- Access
public
cached
topOutputs cached dispatch view cache
- Parameters:
-
-
string $url required
Requested URL
-
- Method defined in:
- cake/dispatcher.php on line 523
- Access
public
cakeError
topUsed to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
- Parameters:
-
-
string $method required
Method to be called in the error class (AppError or ErrorHandler classes)
-
array $messages optional array ( )
Message that is to be displayed by the error class
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
__construct
topConstructor.
- Parameters:
-
-
$url optional NULL
-
$base optional false
-
- Method defined in:
- cake/dispatcher.php on line 75
_deliverAsset
topSends an asset file to the client
- Parameters:
-
-
string $assetFile required
Path to the asset file in the file system
-
string $ext required
The extension of the file to determine its mime type
-
- Method defined in:
- cake/dispatcher.php on line 622
- Return
void
- Access
protected
dispatch
topDispatches 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 optional NULL
URL information to work on
-
array $additionalParams optional array ( )
Settings array ("bare", "return") which is melded with the GET and POST params
-
- Method defined in:
- cake/dispatcher.php on line 97
- Return
boolean Success
- Access
public
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
getUrl
topReturns and sets the $_GET[url] derived from the REQUEST_URI
- Parameters:
-
-
string $uri optional NULL
Request URI
-
string $base optional NULL
Base path
-
- Method defined in:
- cake/dispatcher.php on line 474
- Return
string URL
- Access
public
_invoke
topInitializes the components and models a controller will be using. Triggers the controller action, and invokes the rendering if Controller::$autoRender is true and echo's the output. Otherwise the return value of the controller action are returned.
- Parameters:
-
-
object $controller required
Controller to invoke
-
array $params required
Parameters with at least the 'action' to invoke
-
- Method defined in:
- cake/dispatcher.php on line 185
- Return
string Output as sent by controller
- Access
protected
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
Object
topA hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
parseParams
topReturns array of GET and POST parameters. GET parameters are taken from given URL.
- Parameters:
-
-
string $fromUrl required
URL to mine for parameter information.
-
- Method defined in:
- cake/dispatcher.php on line 244
- Return
array Parameters found in POST and GET.
- Access
public
_persist
topChecks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
requestAction
topCalls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
- Parameters:
-
-
mixed $url required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
- Parameters:
-
-
array $properties optional array ( )
An associative array containing properties and corresponding values.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
uri
topReturns the REQUEST_URI from the server environment, or, failing that, constructs a new one, using the PHP_SELF constant and other variables.
- Method defined in:
- cake/dispatcher.php on line 427
- Return
string URI
- Access
public
