CakePHP: API Generator

Called after the controller action is run and rendered.

This method should be overridden in child classes.

This method should be overridden in child classes.

This method should be overridden in child classes.

Used 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.

Constructor.

Loads Model classes based on the the uses property see Controller::loadModel(); for more info. Loads Components and prepares them for initialization.

Forces the user's browser not to cache the results of the current request.

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

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.

Convenience and object wrapper method for header(). Useful when doing tests and asserting that particular headers have been set.

Queries & sets valid HTTP response codes & messages.

httpCodes(404); // returns array(404 => 'Not Found')

   httpCodes(array(
       701 => 'Unicorn Moved',
       800 => 'Unexpected Minotaur'

)); // sets these new values, and returns true

Controller callback to tie into Auth component. Only called when AuthComponent::$authorize is set to 'controller'.

Loads and instantiates models required by this controller. If Controller::$persistModel; is true, controller will cache model instances on first request, additional request will used cached models. If the model is non existent, it will throw a missing database table error, as Cake generates dynamic models for the time being.

Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Merge components, helpers, and uses vars from AppController and PluginAppController.

A 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()

Open the persistent class file for reading Used by Object::_persist()

Handles automatic pagination of model records.

Checks 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

Converts POST'ed form data to a model conditions array, suitable for use in a Model::find() call.

Redirects to given $url, after turning off $this->autoRender. Script execution is halted after the redirect.

Returns the referring URL for this request.

Instantiates the correct view class, hands it its data, and uses it to render the view output.

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.

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

This method should be overridden in child classes. If not it will render a scaffold error. Method MUST return true in child classes

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.

Saves a variable for use inside a view template.

Internally redirects one action to another. Does not perform another HTTP request unlike Controller::redirect()

Examples:

setAction('another_action');
setAction('action_with_parameters', $parameter1);

Perform the various shutdown processes for this controller. Fire the Component and Controller callbacks in the correct order.

• triggers the component shutdown callback.
• calls the Controller's afterFilter method.

Perform the startup process for this controller. Fire the Component and Controller callbacks in the correct order.

• Initializes components, which fires their initialize callback
• Calls the controller beforeFilter.
• triggers Component startup methods.

Stop execution of the current script. Wraps exit() making testing easier.

Object-to-string conversion. Each class can override this method as necessary.

Returns number of errors in a submitted FORM.

Validates models passed by parameters. Example:

$errors = $this->validateErrors($this->Article, $this->User);