CakeErrorController (class)
Class CakeErrorController
Error Handling Controller
Controller used by ErrorHandler to render error views.
- Object
-
Controller implements CakeEventListener
-
AppController
-
CakeErrorController
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Controller/CakeErrorController.php
Properties summary
-
$uses
publicUses Propertyarray
Inherited Magic Properties
Inherited Properties
-
Components
,View
,_eventManager
,_mergeParent
,_responseClass
,autoLayout
,autoRender
,cacheAction
,components
,ext
,helpers
,layout
,layoutPath
,methods
,modelClass
,modelKey
,name
,passedArgs
,plugin
,request
,response
,scaffold
,validationErrors
,view
,viewClass
,viewPath
,viewVars
Method Summary
- __construct() publicConstructor
Method Detail
__construct()source public
__construct( CakeRequest $request null , CakeResponse $response null )
Constructor
Parameters
-
CakeRequest
$request
optional null - Request instance.
-
CakeResponse
$response
optional null - Response instance.
Overrides
Controller::__construct()
Methods inherited from Controller
__get()source public
__get( string $name )
Provides backwards compatibility access to the request object properties. Also provides the params alias.
Parameters
- string
$name
- The name of the requested value
Returns
mixedThe requested value for valid variables/aliases else null
__isset()source public
__isset( string $name )
Provides backwards compatibility to avoid problems with empty and isset to alias properties. Lazy loads models using the loadModel() method if declared in $uses
Parameters
- string
$name
- Property name to check.
Returns
boolean__set()source public
__set( string $name , mixed $value )
Provides backwards compatibility access for setting values to the request object.
Parameters
- string
$name
- Property name to set.
- mixed
$value
- Value to set.
_afterScaffoldSave()source protected
_afterScaffoldSave( string $method )
Alias to afterScaffoldSave()
Deprecated
3.0.0 Will be removed in 3.0.Parameters
- string
$method
- Method name.
Returns
booleanSee
Controller::afterScaffoldSave()_afterScaffoldSaveError()source protected
_afterScaffoldSaveError( string $method )
Alias to afterScaffoldSaveError()
Deprecated
3.0.0 Will be removed in 3.0.Parameters
- string
$method
- Method name.
Returns
booleanSee
Controller::afterScaffoldSaveError()_beforeScaffold()source protected
_beforeScaffold( string $method )
Alias to beforeScaffold()
Deprecated
3.0.0 Will be removed in 3.0.Parameters
- string
$method
- Method name.
Returns
booleanSee
Controller::beforeScaffold()_getScaffold()source protected
_getScaffold( CakeRequest $request )
Returns a scaffold object to use for dynamically scaffolded controllers.
Parameters
-
CakeRequest
$request
- Request instance.
Returns
Scaffold
_getViewObject()source protected
_getViewObject( )
Constructs the view class instance based on the controller property
Returns
View
_isPrivateAction()source protected
_isPrivateAction( ReflectionMethod $method , CakeRequest $request )
Check if the request's action is marked as private, with an underscore, or if the request is attempting to directly accessing a prefixed action.
Parameters
- ReflectionMethod
$method
- The method to be invoked.
-
CakeRequest
$request
- The request to check.
Returns
boolean_mergeControllerVars()source protected
_mergeControllerVars( )
Merge components, helpers, and uses vars from Controller::$_mergeParent and PluginAppController.
_mergeUses()source protected
_mergeUses( array $merge )
Helper method for merging the $uses property together.
Merges the elements not already in $this->uses into $this->uses.
Parameters
- array
$merge
- The data to merge in.
_parseBeforeRedirect()source protected
_parseBeforeRedirect( mixed $response , string|array $url , integer $status , boolean $exit )
Parse beforeRedirect Response
Parameters
- mixed
$response
- Response from beforeRedirect callback
- string|array
$url
- The same value of beforeRedirect
- integer
$status
- The same value of beforeRedirect
- boolean
$exit
- The same value of beforeRedirect
Returns
arrayArray with keys url, status and exit
_scaffoldError()source protected
_scaffoldError( string $method )
Alias to scaffoldError()
Deprecated
3.0.0 Will be removed in 3.0.Parameters
- string
$method
- Method name.
Returns
booleanSee
Controller::scaffoldError()afterFilter()source public
afterFilter( )
Called after the controller action is run and rendered.
Link
http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacksafterScaffoldSave()source public
afterScaffoldSave( string $method )
This method should be overridden in child classes.
Parameters
- string
$method
- name of method called either edit or update.
Returns
booleanSuccess
Link
http://book.cakephp.org/2.0/en/controllers.html#callbacksafterScaffoldSaveError()source public
afterScaffoldSaveError( string $method )
This method should be overridden in child classes.
Parameters
- string
$method
- name of method called either edit or update.
Returns
booleanSuccess
Link
http://book.cakephp.org/2.0/en/controllers.html#callbacksbeforeFilter()source public
beforeFilter( )
Called before the controller action. You can use this method to configure and customize components or perform logic that needs to happen before each controller action.
Link
http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacksbeforeRedirect()source public
beforeRedirect( string|array $url , integer $status null , boolean $exit true )
The beforeRedirect method is invoked when the controller's redirect method is called but before any further action.
If this method returns false the controller will not continue on to redirect the request. The $url, $status and $exit variables have same meaning as for the controller's method. You can also return a string which will be interpreted as the URL to redirect to or return associative array with key 'url' and optionally 'status' and 'exit'.
Parameters
- string|array
$url
A string or array-based URL pointing to another location within the app, or an absolute URL
- integer
$status
optional null - Optional HTTP status code (eg: 404)
- boolean
$exit
optional true - If true, exit() will be called after the redirect
Returns
mixedfalse to stop redirection event, string controllers a new redirection URL or array with the keys url, status and exit to be used by the redirect method.
Link
http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacksbeforeRender()source public
beforeRender( )
Called after the controller action is run, but before the view is rendered. You can use this method to perform logic or set view variables that are required on every request.
Link
http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacksbeforeScaffold()source public
beforeScaffold( string $method )
This method should be overridden in child classes.
Parameters
- string
$method
- name of method called example index, edit, etc.
Returns
booleanSuccess
Link
http://book.cakephp.org/2.0/en/controllers.html#callbacksconstructClasses()source public
constructClasses( )
Loads Model classes based on the uses property see Controller::loadModel(); for more info. Loads Components and prepares them for initialization.
Returns
mixedtrue if models found and instance created.
Throws
MissingModelException
See
Controller::loadModel()Link
http://book.cakephp.org/2.0/en/controllers.html#Controller::constructClassesdisableCache()source public
disableCache( )
Forces the user's browser not to cache the results of the current request.
Deprecated
3.0.0 Will be removed in 3.0. Use CakeResponse::disableCache().Link
http://book.cakephp.org/2.0/en/controllers.html#Controller::disableCacheflash()source public
flash( string $message , string|array $url , integer $pause 1 , string $layout 'flash' )
Shows a message to the user for $pause seconds, then redirects to $url. Uses flash.ctp as the default layout for the message. Does not work if the current debug level is higher than 0.
Deprecated
3.0.0 Will be removed in 3.0. Use Flash::set() with version 2.7+ or Session::setFlash() prior to 2.7.Parameters
- string
$message
- Message to display to the user
- string|array
$url
- Relative string or array-based URL to redirect to after the time expires
- integer
$pause
optional 1 - Time to show the message
- string
$layout
optional 'flash' - Layout you want to use, defaults to 'flash'
Link
http://book.cakephp.org/2.0/en/controllers.html#Controller::flashgetEventManager()source public
getEventManager( )
Returns the CakeEventManager manager instance that is handling any callbacks. You can use this instance to register any new listeners or callbacks to the controller events, or create your own events and trigger them at will.
Returns
CakeEventManager
header()source public
header( string $status )
Convenience and object wrapper method for CakeResponse::header().
Deprecated
3.0.0 Will be removed in 3.0. Use CakeResponse::header().Parameters
- string
$status
- The header message that is being set.
httpCodes()source public
httpCodes( integer|array $code null )
Queries & sets valid HTTP response codes & messages.
Deprecated
3.0.0 Since 2.4. Will be removed in 3.0. Use CakeResponse::httpCodes().Parameters
- integer|array
$code
optional null -
If $code is an integer, then the corresponding code/message is returned if it exists, null if it does not exist. If $code is an array, then the 'code' and 'message' keys of each nested array are added to the default HTTP codes. Example:
httpCodes(404); // returns array(404 => 'Not Found') httpCodes(array( 701 => 'Unicorn Moved', 800 => 'Unexpected Minotaur' )); // sets these new values, and returns true
Returns
arrayAssociative array of the HTTP codes as keys, and the message strings as values, or null of the given $code does not exist.
implementedEvents()source public
implementedEvents( )
Returns a list of all events that will fire in the controller during its lifecycle. You can override this function to add your own listener callbacks
Returns
arrayImplementation of
CakeEventListener::implementedEvents()
invokeAction()source public
invokeAction( CakeRequest $request )
Dispatches the controller action. Checks that the action exists and isn't private.
Parameters
-
CakeRequest
$request
- Request instance.
Returns
mixedThe resulting response.
Throws
PrivateActionException
When actions are not public or prefixed by _
MissingActionException
When actions are not defined and scaffolding is not enabled.
loadModel()source public
loadModel( string $modelClass null , integer|string $id null )
Loads and instantiates models required by this controller. If the model is non existent, it will throw a missing database table error, as CakePHP generates dynamic models for the time being.
Parameters
- string
$modelClass
optional null - Name of model class to load
- integer|string
$id
optional null - Initial ID the instanced model class should have
Returns
booleanTrue if the model was found
Throws
MissingModelException
if the model class cannot be found.
paginate()source public
paginate( Model|string $object null , string|array $scope array() , array $whitelist array() )
Handles automatic pagination of model records.
Parameters
-
Model
|string$object
optional null - Model to paginate (e.g: model instance, or 'Model', or 'Model.InnerModel')
- string|array
$scope
optional array() - Conditions to use while paginating
- array
$whitelist
optional array() - List of allowed options for paging
Returns
arrayModel query results
Link
http://book.cakephp.org/2.0/en/controllers.html#Controller::paginatepostConditions()source public
postConditions( array $data array() , string|array $op null , string $bool 'AND' , boolean $exclusive false )
Converts POST'ed form data to a model conditions array, suitable for use in a Model::find() call.
Deprecated
3.0.0 Will be removed in 3.0.Parameters
- array
$data
optional array() - POST'ed data organized by model and field
- string|array
$op
optional null A string containing an SQL comparison operator, or an array matching operators to fields
- string
$bool
optional 'AND' - SQL boolean operator: AND, OR, XOR, etc.
- boolean
$exclusive
optional false If true, and $op is an array, fields not included in $op will not be included in the returned conditions
Returns
array|nullAn array of model conditions
redirect()source public
redirect( string|array $url , integer|array|null $status null , boolean $exit true )
Redirects to given $url, after turning off $this->autoRender. Script execution is halted after the redirect.
Parameters
- string|array
$url
A string or array-based URL pointing to another location within the app, or an absolute URL
- integer|array|null
$status
optional null - HTTP status code (eg: 301). Defaults to 302 when null is passed.
- boolean
$exit
optional true - If true, exit() will be called after the redirect
Returns
Cake\Network\Response|nullTriggers
Controller.beforeRedirect $this, array($url, $status, $exit)Link
http://book.cakephp.org/2.0/en/controllers.html#Controller::redirectreferer()source public
referer( string $default null , boolean $local false )
Returns the referring URL for this request.
Parameters
- string
$default
optional null - Default URL to use if HTTP_REFERER cannot be read from headers
- boolean
$local
optional false - If true, restrict referring URLs to local server
Returns
stringReferring URL
Link
http://book.cakephp.org/2.0/en/controllers.html#Controller::refererrender()source public
render( string $view null , string $layout null )
Instantiates the correct view class, hands it its data, and uses it to render the view output.
Parameters
- string
$view
optional null - View to use for rendering
- string
$layout
optional null - Layout to use
Returns
CakeResponse
A response object containing the rendered view.
Triggers
Controller.beforeRender $thisLink
http://book.cakephp.org/2.0/en/controllers.html#Controller::renderscaffoldError()source public
scaffoldError( string $method )
This method should be overridden in child classes. If not it will render a scaffold error. Method MUST return true in child classes
Parameters
- string
$method
- name of method called example index, edit, etc.
Returns
booleanSuccess
Link
http://book.cakephp.org/2.0/en/controllers.html#callbacksset()source public
set( string|array $one , string|array $two null )
Saves a variable for use inside a view template.
Parameters
- string|array
$one
- A string or an array of data.
- string|array
$two
optional null Value in case $one is a string (which then works as the key). Unused if $one is an associative array, otherwise serves as the values to $one's keys.
Link
http://book.cakephp.org/2.0/en/controllers.html#interacting-with-viewssetAction()source public
setAction( string $action )
Internally redirects one action to another. Does not perform another HTTP request unlike Controller::redirect()
Examples:
setAction('another_action'); setAction('action_with_parameters', $parameter1);
Parameters
- string
$action
The new action to be 'redirected' to. Any other parameters passed to this method will be passed as parameters to the new action.
Returns
mixedReturns the return value of the called action
setRequest()source public
setRequest( CakeRequest $request )
Sets the request objects and configures a number of controller properties based on the contents of the request. The properties that get set are
- $this->request - To the $request parameter
- $this->plugin - To the $request->params['plugin']
- $this->view - To the $request->params['action']
- $this->autoLayout - To the false if $request->params['bare']; is set.
- $this->autoRender - To false if $request->params['return'] == 1
- $this->passedArgs - The the combined results of params['named'] and params['pass]
Parameters
-
CakeRequest
$request
- Request instance.
shutdownProcess()source public
shutdownProcess( )
Perform the various shutdown processes for this controller. Fire the Components and Controller callbacks in the correct order.
- triggers the component
shutdown
callback. - calls the Controller's
afterFilter
method.
Triggers
Controller.shutdown $thisstartupProcess()source public
startupProcess( )
Perform the startup process for this controller. Fire the Components and Controller callbacks in the correct order.
- Initializes components, which fires their
initialize
callback - Calls the controller
beforeFilter
. - triggers Component
startup
methods.
Triggers
Controller.initialize $thisController.startup $this
validate()source public
validate( )
Returns number of errors in a submitted FORM.
Deprecated
3.0.0 This method will be removed in 3.0Returns
integerNumber of errors
validateErrors()source public
validateErrors( )
Validates models passed by parameters. Takes a list of models as a variable argument. Example:
$errors = $this->validateErrors($this->Article, $this->User);
Deprecated
3.0.0 This method will be removed in 3.0Returns
arrayValidation errors, or false if none
Methods inherited from Object
_mergeVars()source protected
_mergeVars( array $properties , string $class , boolean $normalize true )
Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'
This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.
Parameters
- array
$properties
- The name of the properties to merge.
- string
$class
- The class to merge the property with.
- boolean
$normalize
optional true - Set to true to run the properties through Hash::normalize() before merging.
_set()source protected
_set( array $properties array() )
Allows 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.
_stop()source protected
_stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- integer|string
$status
optional 0 - see http://php.net/exit for values
dispatchMethod()source public
dispatchMethod( string $method , array $params array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array
Parameters
- string
$method
- Name of the method to call
- array
$params
optional array() - Parameter list to use when calling $method
Returns
mixedReturns the result of the method call
log()source public
log( string $msg , integer $type LOG_ERR , null|string|array $scope null )
Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
Parameters
- string
$msg
- Log message
- integer
$type
optional LOG_ERR - Error type constant. Defined in app/Config/core.php.
- null|string|array
$scope
optional null The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
Returns
booleanSuccess of log write
requestAction()source public
requestAction( string|array $url , array $extra array() )
Calls 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.
Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()
Passing POST and GET data
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
Parameters
- string|array
$url
String or array-based URL. Unlike other URL arrays in CakePHP, this URL will not automatically handle passed and named arguments in the $url parameter.
- array
$extra
optional array() if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.
Returns
mixedBoolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString()source public
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
stringThe name of this class
Properties detail
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.8/class-CakeErrorController.html