Class Controller

Properties summary

• $Components public
  ComponentCollection
  Instance of ComponentCollection used to handle callbacks.
• $View public
  View

  Instance of the View created during rendering. Won't be set until after Controller::render() is called.

• $_eventManager protected
  CakeEventManager

  Instance of the CakeEventManager this controller is using to dispatch inner events.

• $_mergeParent protected
  string

  The class name of the parent class you wish to merge with. Typically this is AppController, but you may wish to merge vars with a different parent class.

• $_responseClass protected
  string
  The class name to use for creating the response object.
• $autoLayout public
  boolean
  Set to true to automatically render the layout around views.
• $autoRender public
  boolean

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

• $cacheAction public
  mixed

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

• $components public
  array

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

• $ext public
  string
  File extension for view templates. Defaults to CakePHP's conventional ".ctp".
• $helpers public
  mixed

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

• $layout public
  string|boolean

  The name of the layout file to render the view inside of. The name specified is the filename of the layout in /app/View/Layouts without the .ctp extension. If false then no layout is rendered.

• $layoutPath public
  string
  The name of the layouts subfolder containing layouts for this controller.
• $methods public
  array

  Holds current methods of the controller. This is a list of all the methods reachable via URL. Modifying this array will allow you to change which methods can be reached.

• $modelClass public
  string

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

• $modelKey public
  string
  This controller's model key name, an underscored version of the controller's $modelClass property.
• $name public
  string
  The name of this controller. Controller names are plural, named after the model they manipulate.
• $passedArgs public
  mixed
  Holds all params passed and named.
• $plugin public
  string
  Automatically set to the name of a plugin.
• $request public
  CakeRequest

  An instance of a CakeRequest object that contains information about the current request. This object contains all the information about a request and several methods for reading additional information about the request.

• $response public
  CakeResponse
  An instance of a CakeResponse object that contains information about the impending response
• $scaffold public
  mixed
  Triggers Scaffolding
• $uses public
  boolean|array
  An array containing the class names of models this controller uses.
• $validationErrors public
  array|boolean

  Holds any validation errors produced by the last call of the validateErrors() method. Contains false if no validation errors happened.

• $view public
  string

  The name of the view file to render. The name specified is the filename in /app/View/ without the .ctp extension.

• $viewClass public
  string
  The name of the View class this controller sends output to.
• $viewPath public
  string
  The name of the views subfolder containing views for this controller.
• $viewVars public
  array
  Contains variables to be handed to the view.

Magic properties summary

• $Acl public
  AclComponent
• $Auth public
  AuthComponent
• $Cookie public
  CookieComponent
• $Email public
  EmailComponent
• $Flash public
  FlashComponent
• $Paginator public
  PaginatorComponent
• $RequestHandler public
  RequestHandlerComponent
• $Security public
  SecurityComponent
• $Session public
  SessionComponent
• $action public
  string
  The action handling the current request. Deprecated, use CakeRequest::$action instead.
• $base public
  string
  Base URL path. Deprecated, use CakeRequest::$base instead.
• $data public
  array
  POST data. Deprecated, use CakeRequest::$data instead.
• $here public
  string
  The full address to the current request. Deprecated, use CakeRequest::$here instead.
• $paginate public
  array
  Pagination settings.
• $params public
  array
  Array of parameters parsed from the URL. Deprecated, use CakeRequest::$params instead.
• $webroot public
  string
  Webroot path segment for the request.

Method Summary

• __construct() public

  Constructor.

• __get() public

  Provides backwards compatibility access to the request object properties. Also provides the params alias.

• __isset() public

  Provides backwards compatibility to avoid problems with empty and isset to alias properties. Lazy loads models using the loadModel() method if declared in $uses

• __set() public

  Provides backwards compatibility access for setting values to the request object.

• _afterScaffoldSave() protected deprecated

  Alias to afterScaffoldSave()

• _afterScaffoldSaveError() protected deprecated

  Alias to afterScaffoldSaveError()

• _beforeScaffold() protected deprecated

  Alias to beforeScaffold()

• _getScaffold() protected

  Returns a scaffold object to use for dynamically scaffolded controllers.

• _getViewObject() protected

  Constructs the view class instance based on the controller property

• _isPrivateAction() protected

  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.

• _mergeControllerVars() protected

  Merge components, helpers, and uses vars from Controller::$_mergeParent and PluginAppController.

• _mergeUses() protected

  Helper method for merging the $uses property together.

• _parseBeforeRedirect() protected

  Parse beforeRedirect Response

• _scaffoldError() protected deprecated

  Alias to scaffoldError()

• afterFilter() public

  Called after the controller action is run and rendered.

• afterScaffoldSave() public

  This method should be overridden in child classes.

• afterScaffoldSaveError() public

  This method should be overridden in child classes.

• beforeFilter() public

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

  The beforeRedirect method is invoked when the controller's redirect method is called but before any further action.

• beforeRender() public

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

  This method should be overridden in child classes.

• constructClasses() public

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

• disableCache() public deprecated

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

• flash() public deprecated

  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.

• getEventManager() public

  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.

• header() public deprecated

  Convenience and object wrapper method for CakeResponse::header().

• httpCodes() public deprecated

  Queries & sets valid HTTP response codes & messages.

• implementedEvents() public

  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

• invokeAction() public

  Dispatches the controller action. Checks that the action exists and isn't private.

• loadModel() public

  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.

• paginate() public

  Handles automatic pagination of model records.

• postConditions() public deprecated

  Converts POST'ed form data to a model conditions array.

• redirect() public

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

• referer() public

  Returns the referring URL for this request.

• render() public

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

• scaffoldError() public

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

• set() public

  Saves a variable for use inside a view template.

• setAction() public

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

• setRequest() public

  Sets the request objects and configures a number of controller properties based on the contents of the request. The properties that get set are

• shutdownProcess() public

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

• startupProcess() public

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

• validate() public deprecated

  Returns number of errors in a submitted FORM.

• validateErrors() public deprecated

  Validates models passed by parameters. Takes a list of models as a variable argument. Example:

Method Detail

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

Methods inherited from CakeObject

Properties detail

null

null

'AppController'

'CakeResponse'

true

true

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

false

array('Session', 'Flash')

'.ctp'

array()

'default'

null

array()

null

null

null

array()

null

false

true

null

null

'View'

null

array()

Magic properties detail