CakePHP: API Generator

The name of the currently requested controller action.

Set to true to automatically render the layout around views.

Set to true to automatically render the view after action logic.

Base URL path.

Used to define methods a controller that will be cached. To cache a single action, the value is set to an array containing keys that match action names and values that denote cache expiration times (in seconds).

Example:

var $cacheAction = array(
        'view/23/' => 21600,
        'recalled/' => 86400
    );

$cacheAction can also be set to a strtotime() compatible string. This marks all the actions in the controller for view caching.

Instance of Component used to handle callbacks.

Array containing the names of components this controller uses. Component names should not contain the "Component" portion of the classname.

Example: var $components = array('Session', 'RequestHandler', 'Acl');

Data POSTed to the controller using the HtmlHelper. Data here is accessible using the $this->data['ModelName']['fieldName'] pattern.

File extension for view templates. Defaults to Cake's conventional ".ctp".

An array containing the names of helpers this controller uses. The array elements should not contain the "Helper" part of the classname.

Example: var $helpers = array('Html', 'Javascript', 'Time', 'Ajax');

Stores the current URL, relative to the webroot of the application.

Contains a list of the HTTP codes that CakePHP recognizes. These may be queried and/or modified through Controller::httpCodes(), which is also tasked with their lazy-loading.

The name of the layout file to render the view inside of. The name specified is the filename of the layout in /app/views/layouts without the .ctp extension.

The name of the layouts subfolder containing layouts for this controller.

Holds current methods of the controller

This controller's primary model class name, the Inflector::classify()'ed version of the controller's $name property.

Example: For a controller named 'Comments', the modelClass would be 'Comment'

This controller's model key name, an underscored version of the controller's $modelClass property.

Example: For a controller named 'ArticleComments', the modelKey would be 'article_comment'

An array containing the class names of the models this controller uses.

The name of this controller. Controller names are plural, named after the model they manipulate.

The output of the requested action. Contains either a variable returned from the action, or the data of the rendered view; You can use this var in child controllers' afterFilter() callbacks to alter output.

Holds pagination defaults for controller actions. The keys that can be included in this array are: 'conditions', 'fields', 'order', 'limit', 'page', and 'recursive', similar to the keys in the second parameter of Model::find().

Pagination defaults can also be supplied in a model-by-model basis by using the name of the model as a key for a pagination array:

var $paginate = array(
        'Post' => array(...),
        'Comment' => array(...)
    );

Parameters received in the current request: GET and POST data, information about the request, etc.

Holds all params passed and named.

Used to create cached instances of models a controller uses. When set to true, all models related to the controller will be cached. This can increase performance in many cases.

Automatically set to the name of a plugin.

Triggers Scaffolding

An array containing the class names of models this controller uses.

Example: var $uses = array('Product', 'Post', 'Comment');

Can be set to array() to use no models. Can be set to false to use no models and prevent the merging of $uses with AppController

Holds any validation errors produced by the last call of the validateErrors() method/

The name of the View class this controller sends output to.

The name of the views subfolder containing views for this controller.

Contains variables to be handed to the view.

The webroot of the application.