Application Controller
Add your application-wide methods in the class below, your controllers will inherit them.
Components
, View
, _eventManager
, _mergeParent
, _responseClass
, autoLayout
, autoRender
, cacheAction
, components
, ext
, helpers
, layout
, layoutPath
, methods
, modelClass
, modelKey
, name
, passedArgs
, plugin
, request
, response
, scaffold
, uses
, validationErrors
, view
, viewClass
, viewPath
, viewVars
__construct( CakeRequest $request null , CakeResponse $response null )
Constructor.
CakeRequest
$request
optional null Request object for this controller. Can be null for testing, but expect that features that use the request parameters will not work.
CakeResponse
$response
optional null Object::__construct()
__get( string $name )
Provides backwards compatibility access to the request object properties. Also provides the params alias.
$name
__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
$name
__set( string $name , mixed $value )
Provides backwards compatibility access for setting values to the request object.
$name
$value
_afterScaffoldSave( string $method )
Alias to afterScaffoldSave()
$method
_afterScaffoldSaveError( string $method )
Alias to afterScaffoldSaveError()
$method
_beforeScaffold( string $method )
Alias to beforeScaffold()
$method
_getScaffold( CakeRequest $request )
Returns a scaffold object to use for dynamically scaffolded controllers.
CakeRequest
$request
Scaffold
_getViewObject( )
Constructs the view class instance based on the controller property
View
_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.
$method
CakeRequest
$request
_mergeControllerVars( )
Merge components, helpers, and uses vars from Controller::$_mergeParent and PluginAppController.
_mergeUses( array $merge )
Helper method for merging the $uses property together.
Merges the elements not already in $this->uses into $this->uses.
$merge
_parseBeforeRedirect( mixed $response , string|array $url , integer $status , boolean $exit )
Parse beforeRedirect Response
$response
$url
$status
$exit
_scaffoldError( string $method )
Alias to scaffoldError()
$method
afterFilter( )
Called after the controller action is run and rendered.
afterScaffoldSave( string $method )
This method should be overridden in child classes.
$method
afterScaffoldSaveError( string $method )
This method should be overridden in child classes.
$method
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.
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'.
$url
A string or array-based URL pointing to another location within the app, or an absolute URL
$status
optional null $exit
optional true false 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.
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.
beforeScaffold( string $method )
This method should be overridden in child classes.
$method
constructClasses( )
Loads Model classes based on the uses property see Controller::loadModel(); for more info. Loads Components and prepares them for initialization.
MissingModelException
disableCache( )
Forces the user's browser not to cache the results of the current request.
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.
$message
$url
$pause
optional 1 $layout
optional 'flash' 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.
CakeEventManager
header( string $status )
Convenience and object wrapper method for CakeResponse::header().
$status
httpCodes( integer|array $code null )
Queries & sets valid HTTP response codes & messages.
$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
Associative array of the HTTP codes as keys, and the message strings as values, or null of the given $code does not exist.
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
CakeEventListener::implementedEvents()
invokeAction( CakeRequest $request )
Dispatches the controller action. Checks that the action exists and isn't private.
CakeRequest
$request
PrivateActionException
MissingActionException
When actions are not defined and scaffolding is not enabled.
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.
$modelClass
optional null $id
optional null MissingModelException
paginate( Model|string $object null , string|array $scope array() , array $whitelist array() )
Handles automatic pagination of model records.
Model
|string $object
optional null $scope
optional array() $whitelist
optional array() 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.
$data
optional array() $op
optional null A string containing an SQL comparison operator, or an array matching operators to fields
$bool
optional 'AND' $exclusive
optional false If true, and $op is an array, fields not included in $op will not be included in the returned conditions
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.
$url
A string or array-based URL pointing to another location within the app, or an absolute URL
$status
optional null $exit
optional true referer( string $default null , boolean $local false )
Returns the referring URL for this request.
$default
optional null $local
optional false render( string $view null , string $layout null )
Instantiates the correct view class, hands it its data, and uses it to render the view output.
$view
optional null $layout
optional null CakeResponse
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
$method
set( string|array $one , string|array $two null )
Saves a variable for use inside a view template.
$one
$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.
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);
$action
The new action to be 'redirected' to. Any other parameters passed to this method will be passed as parameters to the new action.
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
CakeRequest
$request
shutdownProcess( )
Perform the various shutdown processes for this controller. Fire the Components and Controller callbacks in the correct order.
shutdown
callback.afterFilter
method.startupProcess( )
Perform the startup process for this controller. Fire the Components and Controller callbacks in the correct order.
initialize
callbackbeforeFilter
.startup
methods.validate( )
Returns number of errors in a submitted FORM.
validateErrors( )
Validates models passed by parameters. Takes a list of models as a variable argument. Example:
$errors = $this->validateErrors($this->Article, $this->User);
_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.
$properties
$class
$normalize
optional true _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.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 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
$method
$params
optional array() 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.
$msg
$type
optional LOG_ERR $scope
optional null The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
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()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$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.
$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.
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString( )
Object-to-string conversion. Each class can override this method as necessary.
© 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-AppController.html