CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 1.2 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 1.2
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Classes

  • AclBase
  • AclBehavior
  • AclComponent
  • AclNode
  • AclShell
  • Aco
  • AcoAction
  • AjaxHelper
  • ApcEngine
  • ApiShell
  • App
  • AppController
  • AppHelper
  • AppModel
  • Aro
  • AuthComponent
  • BakeShell
  • BehaviorCollection
  • Cache
  • CacheEngine
  • CacheHelper
  • CakeErrorController
  • CakeLog
  • CakeSchema
  • CakeSession
  • CakeSocket
  • ClassRegistry
  • Component
  • Configure
  • ConnectionManager
  • ConsoleShell
  • ContainableBehavior
  • Controller
  • ControllerTask
  • CookieComponent
  • DataSource
  • DbAcl
  • DbAclSchema
  • DbConfigTask
  • DboAdodb
  • DboDb2
  • DboFirebird
  • DboMssql
  • DboMysql
  • DboMysqlBase
  • DboMysqli
  • DboOdbc
  • DboOracle
  • DboPostgres
  • DboSource
  • DboSqlite
  • DboSybase
  • Debugger
  • EmailComponent
  • ErrorHandler
  • ExtractTask
  • File
  • FileEngine
  • Flay
  • Folder
  • FormHelper
  • Helper
  • HtmlHelper
  • HttpSocket
  • I18n
  • I18nModel
  • i18nSchema
  • I18nShell
  • Inflector
  • IniAcl
  • JavascriptHelper
  • JsHelper
  • JsHelperObject
  • L10n
  • MagicDb
  • MagicFileResource
  • MediaView
  • MemcacheEngine
  • Model
  • ModelBehavior
  • ModelTask
  • Multibyte
  • NumberHelper
  • Object
  • Overloadable
  • Overloadable2
  • PagesController
  • PaginatorHelper
  • Permission
  • PluginTask
  • ProjectTask
  • RequestHandlerComponent
  • Router
  • RssHelper
  • Sanitize
  • Scaffold
  • ScaffoldView
  • SchemaShell
  • Security
  • SecurityComponent
  • SessionComponent
  • SessionHelper
  • SessionsSchema
  • Set
  • Shell
  • String
  • TestSuiteShell
  • TestTask
  • TextHelper
  • ThemeView
  • TimeHelper
  • TranslateBehavior
  • TreeBehavior
  • Validation
  • View
  • ViewTask
  • XcacheEngine
  • Xml
  • XmlElement
  • XmlHelper
  • XmlManager
  • XmlNode
  • XmlTextNode

Functions

  • __enclose
  • make_clean_css
  • mb_encode_mimeheader
  • mb_stripos
  • mb_stristr
  • mb_strlen
  • mb_strpos
  • mb_strrchr
  • mb_strrichr
  • mb_strripos
  • mb_strrpos
  • mb_strstr
  • mb_strtolower
  • mb_strtoupper
  • mb_substr
  • mb_substr_count
  • write_css_cache

Class Controller

Controller

Application controller class for organization of business logic. Provides basic functionality, such as rendering views inside layouts, automatic model availability, redirection, callbacks, and more.

Object
Extended by Controller
Package: cake\cake\libs\controller
Link: http://book.cakephp.org/view/49/Controllers
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: controller/controller.php

Properties summary

  • $Component public
    string
    Instance of Component used to handle callbacks.
  • $action public
    string
    The name of the currently requested controller action.
  • $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.

  • $base public
    string
    Base URL path.
  • $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 classname.

  • $data public
    array

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

  • $ext public
    string
    File extension for view templates. Defaults to Cake'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 classname.

  • $here public
    string
    Stores the current URL, relative to the webroot of the application.
  • $layout public
    string

    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.

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

    This controller's primary model class name, the Inflector::classify()'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.
  • $modelNames public
    array
    An array containing the class names of the models this controller uses.
  • $name public
    string
    The name of this controller. Controller names are plural, named after the model they manipulate.
  • $output public
    string

    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.

  • $pageTitle public
    boolean

    Text to be used for the $title_for_layout layout variable (usually placed inside tags.)</p> </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$paginate">$paginate</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>array</code></div> <div class="description"> <p>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().</p> </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$params">$params</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>array</code></div> <div class="description"> <p>Parameters received in the current request: GET and POST data, information about the request, etc.</p> </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$passedArgs">$passedArgs</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>mixed</code></div> <div class="description"> Holds all params passed and named. </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$persistModel">$persistModel</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>boolean</code></div> <div class="description"> <p>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.</p> </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$plugin">$plugin</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>string</code></div> <div class="description"> Automatically set to the name of a plugin. </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$scaffold">$scaffold</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>mixed</code></div> <div class="description"> Triggers Scaffolding </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$uses">$uses</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>mixed</code></div> <div class="description"> An array containing the class names of models this controller uses. </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$validationErrors">$validationErrors</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>array</code></div> <div class="description"> Holds any validation errors produced by the last call of the validateErrors() method/ </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$view">$view</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>string</code></div> <div class="description"> The name of the View class this controller sends output to. </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$viewPath">$viewPath</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>string</code></div> <div class="description"> The name of the views subfolder containing views for this controller. </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$viewVars">$viewVars</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>array</code></div> <div class="description"> Contains variables to be handed to the view. </div> </li> <li class="clearfix"> <div class="name"> <code><a href="class-Controller.html#$webroot">$webroot</a></code> <span class="attributes"> <span class="label">public</span> </span> </div> <div class="property-type"><code>string</code></div> <div class="description"> The webroot of the application. Helpful if your application is placed in a folder under the current domain name. </div> </li> </ul> </div> <div class="section"> <h2>Inherited Properties</h2> <ul class="member-summary used"> <li> <code><a href="class-Object.html#$_log"><!-- -->_log<!-- --></a></code> </li> </ul> </div> <div class="section"> <h2>Method Summary</h2> <ul class="member-summary"> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#___construct">__construct()</a> <span class="label">public</span> </h3> <div class="description detailed"> Constructor. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#___mergeVars">__mergeVars()</a> <span class="label">public</span> </h3> <div class="description detailed"> Merge components, helpers, and uses vars from AppController and PluginAppController. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#__afterScaffoldSave">_afterScaffoldSave()</a> <span class="label">public</span> </h3> <div class="description detailed"> This method should be overridden in child classes. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#__afterScaffoldSaveError">_afterScaffoldSaveError()</a> <span class="label">public</span> </h3> <div class="description detailed"> This method should be overridden in child classes. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#__beforeScaffold">_beforeScaffold()</a> <span class="label">public</span> </h3> <div class="description detailed"> This method should be overridden in child classes. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#__scaffoldError">_scaffoldError()</a> <span class="label">public</span> </h3> <div class="description detailed"> <p>This method should be overridden in child classes. If not it will render a scaffold error. Method MUST return true in child classes</p> </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_afterFilter">afterFilter()</a> <span class="label">public</span> </h3> <div class="description detailed"> Called after the controller action is run and rendered. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_beforeFilter">beforeFilter()</a> <span class="label">public</span> </h3> <div class="description detailed"> Called before the controller action. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_beforeRender">beforeRender()</a> <span class="label">public</span> </h3> <div class="description detailed"> Called after the controller action is run, but before the view is rendered. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_constructClasses">constructClasses()</a> <span class="label">public</span> </h3> <div class="description detailed"> <p>Loads Model classes based on the the uses property see Controller::loadModel(); for more info. Loads Components and prepares them for initialization.</p> </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_disableCache">disableCache()</a> <span class="label">public</span> </h3> <div class="description detailed"> Forces the user's browser not to cache the results of the current request. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_flash">flash()</a> <span class="label">public</span> </h3> <div class="description detailed"> <p>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.</p> </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_header">header()</a> <span class="label">public</span> </h3> <div class="description detailed"> Convenience method for header() </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_isAuthorized">isAuthorized()</a> <span class="label">public</span> </h3> <div class="description detailed"> Controller callback to tie into Auth component. Only called when AuthComponent::authorize is set to 'controller'. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_loadModel">loadModel()</a> <span class="label">public</span> </h3> <div class="description detailed"> <p>Loads and instantiates models required by this controller. If Controller::persistModel; is true, controller will create cached 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.</p> </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_paginate">paginate()</a> <span class="label">public</span> </h3> <div class="description detailed"> Handles automatic pagination of model records. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_postConditions">postConditions()</a> <span class="label">public</span> </h3> <div class="description detailed"> Converts POST'ed form data to a model conditions array, suitable for use in a Model::find() call. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_redirect">redirect()</a> <span class="label">public</span> </h3> <div class="description detailed"> <p>Redirects to given $url, after turning off $this->autoRender. Script execution is halted after the redirect.</p> </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_referer">referer()</a> <span class="label">public</span> </h3> <div class="description detailed"> Returns the referring URL for this request. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_render">render()</a> <span class="label">public</span> </h3> <div class="description detailed"> Instantiates the correct view class, hands it its data, and uses it to render the view output. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_set">set()</a> <span class="label">public</span> </h3> <div class="description detailed"> Saves a variable for use inside a view template. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_setAction">setAction()</a> <span class="label">public</span> </h3> <div class="description detailed"> Internally redirects one action to another. Examples: </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_validate">validate()</a> <span class="label">public</span> </h3> <div class="description detailed"> Returns number of errors in a submitted FORM. </div> </li> <li class="clearfix"> <h5 class="method-name"> <a href="class-Controller.html#_validateErrors">validateErrors()</a> <span class="label">public</span> </h3> <div class="description detailed"> Validates models passed by parameters. Example: </div> </li> </ul> </div> <div class="section"> <h2>Method Detail</h2> <div class="method-detail"> <a id="___construct"></a> <a id="method-Controller__construct"></a> <h3 class="method-name"> <a href="source-class-Controller.html#322-354" title="Go to source code">__construct()</a> <span class="label">public</span> <a href="#___construct" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> __construct( ) </p> <div class="description detailed"> <p>Constructor.</p> <h6>Overrides</h6> <div class="list"><code><a href="class-Object.html#___construct">Object::__construct()</a></code></div> </div> </div> <div class="method-detail"> <a id="___mergeVars"></a> <a id="method-Controller__mergeVars"></a> <h3 class="method-name"> <a href="source-class-Controller.html#355-431" title="Go to source code">__mergeVars()</a> <span class="label">public</span> <a href="#___mergeVars" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> __mergeVars( ) </p> <div class="description detailed"> <p>Merge components, helpers, and uses vars from AppController and PluginAppController.</p> </div> </div> <div class="method-detail"> <a id="__afterScaffoldSave"></a> <a id="method-Controller_afterScaffoldSave"></a> <h3 class="method-name"> <a href="source-class-Controller.html#1156-1166" title="Go to source code">_afterScaffoldSave()</a> <span class="label">public</span> <a href="#__afterScaffoldSave" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> _afterScaffoldSave( string <var>$method</var> ) </p> <div class="description detailed"> <p>This method should be overridden in child classes.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$method</var> </dt> <dd>name of method called either edit or update.</dd> </dl> </div> <h6>Returns</h6> <div class="list"> boolean<br>Success<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/60/Callbacks">http://book.cakephp.org/view/60/Callbacks</a><br> </div> </div> </div> <div class="method-detail"> <a id="__afterScaffoldSaveError"></a> <a id="method-Controller_afterScaffoldSaveError"></a> <h3 class="method-name"> <a href="source-class-Controller.html#1167-1177" title="Go to source code">_afterScaffoldSaveError()</a> <span class="label">public</span> <a href="#__afterScaffoldSaveError" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> _afterScaffoldSaveError( string <var>$method</var> ) </p> <div class="description detailed"> <p>This method should be overridden in child classes.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$method</var> </dt> <dd>name of method called either edit or update.</dd> </dl> </div> <h6>Returns</h6> <div class="list"> boolean<br>Success<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/60/Callbacks">http://book.cakephp.org/view/60/Callbacks</a><br> </div> </div> </div> <div class="method-detail"> <a id="__beforeScaffold"></a> <a id="method-Controller_beforeScaffold"></a> <h3 class="method-name"> <a href="source-class-Controller.html#1145-1155" title="Go to source code">_beforeScaffold()</a> <span class="label">public</span> <a href="#__beforeScaffold" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> _beforeScaffold( string <var>$method</var> ) </p> <div class="description detailed"> <p>This method should be overridden in child classes.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$method</var> </dt> <dd>name of method called example index, edit, etc.</dd> </dl> </div> <h6>Returns</h6> <div class="list"> boolean<br>Success<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/60/Callbacks">http://book.cakephp.org/view/60/Callbacks</a><br> </div> </div> </div> <div class="method-detail"> <a id="__scaffoldError"></a> <a id="method-Controller_scaffoldError"></a> <h3 class="method-name"> <a href="source-class-Controller.html#1178-1190" title="Go to source code">_scaffoldError()</a> <span class="label">public</span> <a href="#__scaffoldError" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> _scaffoldError( string <var>$method</var> ) </p> <div class="description detailed"> <p>This method should be overridden in child classes. If not it will render a scaffold error. Method MUST return true in child classes</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$method</var> </dt> <dd>name of method called example index, edit, etc.</dd> </dl> </div> <h6>Returns</h6> <div class="list"> boolean<br>Success<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/60/Callbacks">http://book.cakephp.org/view/60/Callbacks</a><br> </div> </div> </div> <div class="method-detail"> <a id="_afterFilter"></a> <a id="method-ControllerafterFilter"></a> <h3 class="method-name"> <a href="source-class-Controller.html#1137-1144" title="Go to source code">afterFilter()</a> <span class="label">public</span> <a href="#_afterFilter" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> afterFilter( ) </p> <div class="description detailed"> <p>Called after the controller action is run and rendered.</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/60/Callbacks">http://book.cakephp.org/view/60/Callbacks</a><br> </div> </div> </div> <div class="method-detail"> <a id="_beforeFilter"></a> <a id="method-ControllerbeforeFilter"></a> <h3 class="method-name"> <a href="source-class-Controller.html#1121-1128" title="Go to source code">beforeFilter()</a> <span class="label">public</span> <a href="#_beforeFilter" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> beforeFilter( ) </p> <div class="description detailed"> <p>Called before the controller action.</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/60/Callbacks">http://book.cakephp.org/view/60/Callbacks</a><br> </div> </div> </div> <div class="method-detail"> <a id="_beforeRender"></a> <a id="method-ControllerbeforeRender"></a> <h3 class="method-name"> <a href="source-class-Controller.html#1129-1136" title="Go to source code">beforeRender()</a> <span class="label">public</span> <a href="#_beforeRender" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> beforeRender( ) </p> <div class="description detailed"> <p>Called after the controller action is run, but before the view is rendered.</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/60/Callbacks">http://book.cakephp.org/view/60/Callbacks</a><br> </div> </div> </div> <div class="method-detail"> <a id="_constructClasses"></a> <a id="method-ControllerconstructClasses"></a> <h3 class="method-name"> <a href="source-class-Controller.html#432-468" title="Go to source code">constructClasses()</a> <span class="label">public</span> <a href="#_constructClasses" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> constructClasses( ) </p> <div class="description detailed"> <p>Loads Model classes based on the the uses property see Controller::loadModel(); for more info. Loads Components and prepares them for initialization.</p> <h6>Returns</h6> <div class="list"> mixed<br>true if models found and instance created, or cakeError if models not found.<br> </div> <h6>See</h6> <div class="list"> Controller::loadModel()<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/429/constructClasses">http://book.cakephp.org/view/429/constructClasses</a><br> </div> </div> </div> <div class="method-detail"> <a id="_disableCache"></a> <a id="method-ControllerdisableCache"></a> <h3 class="method-name"> <a href="source-class-Controller.html#841-854" title="Go to source code">disableCache()</a> <span class="label">public</span> <a href="#_disableCache" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> disableCache( ) </p> <div class="description detailed"> <p>Forces the user's browser not to cache the results of the current request.</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/431/disableCache">http://book.cakephp.org/view/431/disableCache</a><br> </div> </div> </div> <div class="method-detail"> <a id="_flash"></a> <a id="method-Controllerflash"></a> <h3 class="method-name"> <a href="source-class-Controller.html#855-874" title="Go to source code">flash()</a> <span class="label">public</span> <a href="#_flash" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> flash( string <var>$message</var> , mixed <var>$url</var> , integer <var>$pause</var> = <span class="php-num">1</span> ) </p> <div class="description detailed"> <p>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.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$message</var> </dt> <dd>Message to display to the user</dd> <dt> mixed <var>$url</var> </dt> <dd>Relative string or array-based URL to redirect to after the time expires</dd> <dt> integer <var>$pause</var> <span class="label">optional</span> <span class="php-num">1</span> </dt> <dd>Time to show the message</dd> </dl> </div> <h6>Returns</h6> <div class="list"> <br>Renders flash layout<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/426/flash">http://book.cakephp.org/view/426/flash</a><br> </div> </div> </div> <div class="method-detail"> <a id="_header"></a> <a id="method-Controllerheader"></a> <h3 class="method-name"> <a href="source-class-Controller.html#638-647" title="Go to source code">header()</a> <span class="label">public</span> <a href="#_header" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> header( string <var>$status</var> ) </p> <div class="description detailed"> <p>Convenience method for header()</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$status</var> </dt> <dd></dd> </dl> </div> </div> </div> <div class="method-detail"> <a id="_isAuthorized"></a> <a id="method-ControllerisAuthorized"></a> <h3 class="method-name"> <a href="source-class-Controller.html#701-711" title="Go to source code">isAuthorized()</a> <span class="label">public</span> <a href="#_isAuthorized" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> isAuthorized( ) </p> <div class="description detailed"> <p>Controller callback to tie into Auth component. Only called when AuthComponent::authorize is set to 'controller'.</p> <h6>Returns</h6> <div class="list"> boolean<br>true if authorized, false otherwise<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/396/authorize">http://book.cakephp.org/view/396/authorize</a><br> </div> </div> </div> <div class="method-detail"> <a id="_loadModel"></a> <a id="method-ControllerloadModel"></a> <h3 class="method-name"> <a href="source-class-Controller.html#469-526" title="Go to source code">loadModel()</a> <span class="label">public</span> <a href="#_loadModel" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> loadModel( string <var>$modelClass</var> = <span class="php-keyword1">null</span> , mixed <var>$id</var> = <span class="php-keyword1">null</span> ) </p> <div class="description detailed"> <p>Loads and instantiates models required by this controller. If Controller::persistModel; is true, controller will create cached 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.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$modelClass</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd>Name of model class to load</dd> <dt> mixed <var>$id</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd>Initial ID the instanced model class should have</dd> </dl> </div> <h6>Returns</h6> <div class="list"> mixed<br>true when single model found and instance created error returned if models not found.<br> </div> </div> </div> <div class="method-detail"> <a id="_paginate"></a> <a id="method-Controllerpaginate"></a> <h3 class="method-name"> <a href="source-class-Controller.html#932-1120" title="Go to source code">paginate()</a> <span class="label">public</span> <a href="#_paginate" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> paginate( mixed <var>$object</var> = <span class="php-keyword1">null</span> , mixed <var>$scope</var> = <span class="php-keyword1">array</span>() , array <var>$whitelist</var> = <span class="php-keyword1">array</span>() ) </p> <div class="description detailed"> <p>Handles automatic pagination of model records.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> mixed <var>$object</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd>Model to paginate (e.g: model instance, or 'Model', or 'Model.InnerModel')</dd> <dt> mixed <var>$scope</var> <span class="label">optional</span> <span class="php-keyword1">array</span>() </dt> <dd>Conditions to use while paginating</dd> <dt> array <var>$whitelist</var> <span class="label">optional</span> <span class="php-keyword1">array</span>() </dt> <dd>List of allowed options for paging</dd> </dl> </div> <h6>Returns</h6> <div class="list"> array<br>Model query results<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/165/Controller-Setup">http://book.cakephp.org/view/165/Controller-Setup</a><br> </div> </div> </div> <div class="method-detail"> <a id="_postConditions"></a> <a id="method-ControllerpostConditions"></a> <h3 class="method-name"> <a href="source-class-Controller.html#875-931" title="Go to source code">postConditions()</a> <span class="label">public</span> <a href="#_postConditions" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> postConditions( array <var>$data</var> = <span class="php-keyword1">array</span>() , mixed <var>$op</var> = <span class="php-keyword1">null</span> , string <var>$bool</var> = <span class="php-quote">'AND'</span> , boolean <var>$exclusive</var> = <span class="php-keyword1">false</span> ) </p> <div class="description detailed"> <p>Converts POST'ed form data to a model conditions array, suitable for use in a Model::find() call.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> array <var>$data</var> <span class="label">optional</span> <span class="php-keyword1">array</span>() </dt> <dd>POST'ed data organized by model and field</dd> <dt> mixed <var>$op</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd>A string containing an SQL comparison operator, or an array matching operators to fields</dd> <dt> string <var>$bool</var> <span class="label">optional</span> <span class="php-quote">'AND'</span> </dt> <dd>SQL boolean operator: AND, OR, XOR, etc.</dd> <dt> boolean <var>$exclusive</var> <span class="label">optional</span> <span class="php-keyword1">false</span> </dt> <dd>If true, and $op is an array, fields not included in $op will not be included in the returned conditions</dd> </dl> </div> <h6>Returns</h6> <div class="list"> array<br>An array of model conditions<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/432/postConditions">http://book.cakephp.org/view/432/postConditions</a><br> </div> </div> </div> <div class="method-detail"> <a id="_redirect"></a> <a id="method-Controllerredirect"></a> <h3 class="method-name"> <a href="source-class-Controller.html#527-637" title="Go to source code">redirect()</a> <span class="label">public</span> <a href="#_redirect" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> redirect( mixed <var>$url</var> , integer <var>$status</var> = <span class="php-keyword1">null</span> , boolean <var>$exit</var> = <span class="php-keyword1">true</span> ) </p> <div class="description detailed"> <p>Redirects to given $url, after turning off $this->autoRender. Script execution is halted after the redirect.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> mixed <var>$url</var> </dt> <dd>A string or array-based URL pointing to another location within the app, or an absolute URL</dd> <dt> integer <var>$status</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd>Optional HTTP status code (eg: 404)</dd> <dt> boolean <var>$exit</var> <span class="label">optional</span> <span class="php-keyword1">true</span> </dt> <dd>If true, exit() will be called after the redirect</dd> </dl> </div> <h6>Returns</h6> <div class="list"> mixed<br>void if $exit = false. Terminates script if $exit = true<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/425/redirect">http://book.cakephp.org/view/425/redirect</a><br> </div> </div> </div> <div class="method-detail"> <a id="_referer"></a> <a id="method-Controllerreferer"></a> <h3 class="method-name"> <a href="source-class-Controller.html#812-840" title="Go to source code">referer()</a> <span class="label">public</span> <a href="#_referer" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> referer( string <var>$default</var> = <span class="php-keyword1">null</span> , boolean <var>$local</var> = <span class="php-keyword1">false</span> ) </p> <div class="description detailed"> <p>Returns the referring URL for this request.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$default</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd>Default URL to use if HTTP_REFERER cannot be read from headers</dd> <dt> boolean <var>$local</var> <span class="label">optional</span> <span class="php-keyword1">false</span> </dt> <dd>If true, restrict referring URLs to local server</dd> </dl> </div> <h6>Returns</h6> <div class="list"> string<br>Referring URL<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/430/referer">http://book.cakephp.org/view/430/referer</a><br> </div> </div> </div> <div class="method-detail"> <a id="_render"></a> <a id="method-Controllerrender"></a> <h3 class="method-name"> <a href="source-class-Controller.html#754-811" title="Go to source code">render()</a> <span class="label">public</span> <a href="#_render" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> render( string <var>$action</var> = <span class="php-keyword1">null</span> , string <var>$layout</var> = <span class="php-keyword1">null</span> , string <var>$file</var> = <span class="php-keyword1">null</span> ) </p> <div class="description detailed"> <p>Instantiates the correct view class, hands it its data, and uses it to render the view output.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$action</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd>Action name to render</dd> <dt> string <var>$layout</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd>Layout to use</dd> <dt> string <var>$file</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd>File to use for rendering</dd> </dl> </div> <h6>Returns</h6> <div class="list"> string<br>Full output string of view contents<br> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/428/render">http://book.cakephp.org/view/428/render</a><br> </div> </div> </div> <div class="method-detail"> <a id="_set"></a> <a id="method-Controllerset"></a> <h3 class="method-name"> <a href="source-class-Controller.html#648-682" title="Go to source code">set()</a> <span class="label">public</span> <a href="#_set" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> set( mixed <var>$one</var> , mixed <var>$two</var> = <span class="php-keyword1">null</span> ) </p> <div class="description detailed"> <p>Saves a variable for use inside a view template.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> mixed <var>$one</var> </dt> <dd>A string or an array of data.</dd> <dt> mixed <var>$two</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd><p>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.</p></dd> </dl> </div> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/427/set">http://book.cakephp.org/view/427/set</a><br> </div> </div> </div> <div class="method-detail"> <a id="_setAction"></a> <a id="method-ControllersetAction"></a> <h3 class="method-name"> <a href="source-class-Controller.html#683-700" title="Go to source code">setAction()</a> <span class="label">public</span> <a href="#_setAction" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> setAction( string <var>$action</var> ) </p> <div class="description detailed"> <p>Internally redirects one action to another. Examples:</p> <p>setAction('another_action'); setAction('action_with_parameters', $parameter1);</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$action</var> </dt> <dd>The new action to be redirected to</dd> </dl> </div> <h6>Returns</h6> <div class="list"> mixed<br>Returns the return value of the called action<br> </div> </div> </div> <div class="method-detail"> <a id="_validate"></a> <a id="method-Controllervalidate"></a> <h3 class="method-name"> <a href="source-class-Controller.html#712-726" title="Go to source code">validate()</a> <span class="label">public</span> <a href="#_validate" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> validate( ) </p> <div class="description detailed"> <p>Returns number of errors in a submitted FORM.</p> <h6>Returns</h6> <div class="list"> integer<br>Number of errors<br> </div> </div> </div> <div class="method-detail"> <a id="_validateErrors"></a> <a id="method-ControllervalidateErrors"></a> <h3 class="method-name"> <a href="source-class-Controller.html#727-753" title="Go to source code">validateErrors()</a> <span class="label">public</span> <a href="#_validateErrors" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> validateErrors( ) </p> <div class="description detailed"> <p>Validates models passed by parameters. Example:</p> <p>$errors = $this->validateErrors($this->Article, $this->User);</p> <h6>Returns</h6> <div class="list"> array<br>Validation errors, or false if none<br> </div> </div> </div> </div> <div class="section"> <h2>Methods inherited from <a href="class-Object.html#methods">Object</a></h2> <div class="method-detail"> <a id="_Object"></a> <a id="method-ControllerObject"></a> <h3 class="method-name"> <a href="source-class-Object.html#44-58" title="Go to source code">Object()</a> <span class="label">public</span> <a href="#_Object" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> Object( ) </p> <div class="description detailed"> <p>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()</p> <h6>Returns</h6> <div class="list"> <code><a href="class-Object.html">Object</a></code><br> </div> </div> </div> <div class="method-detail"> <a id="___openPersistent"></a> <a id="method-Controller__openPersistent"></a> <h3 class="method-name"> <a href="source-class-Object.html#257-295" title="Go to source code">__openPersistent()</a> <span class="label">public</span> <a href="#___openPersistent" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> __openPersistent( string <var>$name</var> , string <var>$type</var> = <span class="php-keyword1">null</span> ) </p> <div class="description detailed"> <p>Open the persistent class file for reading Used by Object::_persist()</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$name</var> </dt> <dd>Name of persisted class</dd> <dt> string <var>$type</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd>Type of persistance (e.g: registry)</dd> </dl> </div> </div> </div> <div class="method-detail"> <a id="__persist"></a> <a id="method-Controller_persist"></a> <h3 class="method-name"> <a href="source-class-Object.html#206-235" title="Go to source code">_persist()</a> <span class="label">public</span> <a href="#__persist" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> _persist( string <var>$name</var> , string <var>$return</var> , <var>$object</var> , <var>$type</var> = <span class="php-keyword1">null</span> ) </p> <div class="description detailed"> <p>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</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$name</var> </dt> <dd>name of the class to persist</dd> <dt> string <var>$return</var> </dt> <dd>$object the object to persist</dd> <dt> <var>$object</var> </dt> <dd></dd> <dt> <var>$type</var> <span class="label">optional</span> <span class="php-keyword1">null</span> </dt> <dd></dd> </dl> </div> <h6>Returns</h6> <div class="list"> boolean<br>Success<br> </div> </div> </div> <div class="method-detail"> <a id="__savePersistent"></a> <a id="method-Controller_savePersistent"></a> <h3 class="method-name"> <a href="source-class-Object.html#236-256" title="Go to source code">_savePersistent()</a> <span class="label">public</span> <a href="#__savePersistent" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> _savePersistent( string <var>$name</var> , object <var>$object</var> ) </p> <div class="description detailed"> <p>You should choose a unique name for the persistent file</p> <p>There are many uses for this method, see manual for examples</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$name</var> </dt> <dd>name used for object to cache</dd> <dt> object <var>$object</var> </dt> <dd>the object to persist</dd> </dl> </div> <h6>Returns</h6> <div class="list"> boolean<br>true on save, throws error if file can not be created<br> </div> </div> </div> <div class="method-detail"> <a id="__set"></a> <a id="method-Controller_set"></a> <h3 class="method-name"> <a href="source-class-Object.html#161-177" title="Go to source code">_set()</a> <span class="label">public</span> <a href="#__set" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> _set( array <var>$properties</var> = <span class="php-keyword1">array</span>() ) </p> <div class="description detailed"> <p>Allows setting of multiple properties of the object in a single line of code.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> array <var>$properties</var> <span class="label">optional</span> <span class="php-keyword1">array</span>() </dt> <dd>An associative array containing properties and corresponding values.</dd> </dl> </div> </div> </div> <div class="method-detail"> <a id="__stop"></a> <a id="method-Controller_stop"></a> <h3 class="method-name"> <a href="source-class-Object.html#131-140" title="Go to source code">_stop()</a> <span class="label">public</span> <a href="#__stop" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> _stop( <var>$status</var> = <span class="php-num">0</span> ) </p> <div class="description detailed"> <p>Stop execution of the current script</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> <var>$status</var> <span class="label">optional</span> <span class="php-num">0</span> </dt> <dd>http://php.net/exit for values</dd> </dl> </div> </div> </div> <div class="method-detail"> <a id="_cakeError"></a> <a id="method-ControllercakeError"></a> <h3 class="method-name"> <a href="source-class-Object.html#178-205" title="Go to source code">cakeError()</a> <span class="label">public</span> <a href="#_cakeError" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> cakeError( string <var>$method</var> , array <var>$messages</var> = <span class="php-keyword1">array</span>() ) </p> <div class="description detailed"> <p>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.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$method</var> </dt> <dd>Method to be called in the error class (AppError or ErrorHandler classes)</dd> <dt> array <var>$messages</var> <span class="label">optional</span> <span class="php-keyword1">array</span>() </dt> <dd>Message that is to be displayed by the error class</dd> </dl> </div> <h6>Returns</h6> <div class="list"> error<br>message<br> </div> </div> </div> <div class="method-detail"> <a id="_dispatchMethod"></a> <a id="method-ControllerdispatchMethod"></a> <h3 class="method-name"> <a href="source-class-Object.html#102-130" title="Go to source code">dispatchMethod()</a> <span class="label">public</span> <a href="#_dispatchMethod" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> dispatchMethod( string <var>$method</var> , array <var>$params</var> = <span class="php-keyword1">array</span>() ) </p> <div class="description detailed"> <p>Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$method</var> </dt> <dd>Name of the method to call</dd> <dt> array <var>$params</var> <span class="label">optional</span> <span class="php-keyword1">array</span>() </dt> <dd>Parameter list to use when calling $method</dd> </dl> </div> <h6>Returns</h6> <div class="list"> mixed<br>Returns the result of the method call<br> </div> </div> </div> <div class="method-detail"> <a id="_log"></a> <a id="method-Controllerlog"></a> <h3 class="method-name"> <a href="source-class-Object.html#141-160" title="Go to source code">log()</a> <span class="label">public</span> <a href="#_log" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> log( string <var>$msg</var> , integer <var>$type</var> = LOG_ERROR ) </p> <div class="description detailed"> <p>API for logging events.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> string <var>$msg</var> </dt> <dd>Log message</dd> <dt> integer <var>$type</var> <span class="label">optional</span> LOG_ERROR </dt> <dd>Error type constant. Defined in app/config/core.php.</dd> </dl> </div> <h6>Returns</h6> <div class="list"> boolean<br>Success of log write<br> </div> </div> </div> <div class="method-detail"> <a id="_requestAction"></a> <a id="method-ControllerrequestAction"></a> <h3 class="method-name"> <a href="source-class-Object.html#76-101" title="Go to source code">requestAction()</a> <span class="label">public</span> <a href="#_requestAction" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> requestAction( mixed <var>$url</var> , array <var>$extra</var> = <span class="php-keyword1">array</span>() ) </p> <div class="description detailed"> <p>Calls a controller's method from any location.</p> <h6>Parameters</h6> <div class="parameter-list list"> <dl> <dt> mixed <var>$url</var> </dt> <dd>String or array-based url.</dd> <dt> array <var>$extra</var> <span class="label">optional</span> <span class="php-keyword1">array</span>() </dt> <dd>if array includes the key "return" it sets the AutoRender to true.</dd> </dl> </div> <h6>Returns</h6> <div class="list"> mixed<br><p>Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.</p><br> </div> </div> </div> <div class="method-detail"> <a id="_toString"></a> <a id="method-ControllertoString"></a> <h3 class="method-name"> <a href="source-class-Object.html#65-75" title="Go to source code">toString()</a> <span class="label">public</span> <a href="#_toString" class="permalink" title="Permalink to this method">¶</a> </h3> <p class="method-signature"> toString( ) </p> <div class="description detailed"> <p>Object-to-string conversion. Each class can override this method as necessary.</p> <h6>Returns</h6> <div class="list"> string<br>The name of this class<br> </div> </div> </div> </div> <div class="section"> <h2>Properties detail</h2> <div class="property-detail"> <a id="$Component"></a> <h3 class="property-name"> <a href="source-class-Controller.html#198-204" title="Go to source code"><var>$Component</var></a> <a href="#$Component" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>Instance of Component used to handle callbacks.</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$action"></a> <h3 class="property-name"> <a href="source-class-Controller.html#63-69" title="Go to source code"><var>$action</var></a> <a href="#$action" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>The name of the currently requested controller action.</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$autoLayout"></a> <h3 class="property-name"> <a href="source-class-Controller.html#191-197" title="Go to source code"><var>$autoLayout</var></a> <a href="#$autoLayout" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> boolean </div> <div class="description detailed"> <p>Set to true to automatically render the layout around views.</p> <div> <pre><span class="php-keyword1">true</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$autoRender"></a> <h3 class="property-name"> <a href="source-class-Controller.html#183-190" title="Go to source code"><var>$autoRender</var></a> <a href="#$autoRender" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> boolean </div> <div class="description detailed"> <p>Set to true to automatically render the view after action logic.</p> <div> <pre><span class="php-keyword1">true</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$base"></a> <h3 class="property-name"> <a href="source-class-Controller.html#166-172" title="Go to source code"><var>$base</var></a> <a href="#$base" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>Base URL path.</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$cacheAction"></a> <h3 class="property-name"> <a href="source-class-Controller.html#246-263" title="Go to source code"><var>$cacheAction</var></a> <a href="#$cacheAction" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> mixed </div> <div class="description detailed"> <p>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).</p> <p>Example: var $cacheAction = array( 'view/23/' => 21600, 'recalled/' => 86400 );</p> <p>$cacheAction can also be set to a strtotime() compatible string. This marks all the actions in the controller for view caching.</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/346/Caching-in-the-Controller">http://book.cakephp.org/view/346/Caching-in-the-Controller</a><br> </div> <div> <pre><span class="php-keyword1">false</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$components"></a> <h3 class="property-name"> <a href="source-class-Controller.html#205-215" title="Go to source code"><var>$components</var></a> <a href="#$components" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> array </div> <div class="description detailed"> <p>Array containing the names of components this controller uses. Component names should not contain the "Component" portion of the classname.</p> <p>Example: var $components = array('Session', 'RequestHandler', 'Acl');</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/53/components-helpers-and-uses">http://book.cakephp.org/view/53/components-helpers-and-uses</a><br> </div> <div> <pre><span class="php-keyword1">array</span>()</pre> </div> </div> </div> <div class="property-detail"> <a id="$data"></a> <h3 class="property-name"> <a href="source-class-Controller.html#103-110" title="Go to source code"><var>$data</var></a> <a href="#$data" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> array </div> <div class="description detailed"> <p>Data POSTed to the controller using the HtmlHelper. Data here is accessible using the $this->data['ModelName']['fieldName'] pattern.</p> <div> <pre><span class="php-keyword1">array</span>()</pre> </div> </div> </div> <div class="property-detail"> <a id="$ext"></a> <h3 class="property-name"> <a href="source-class-Controller.html#223-229" title="Go to source code"><var>$ext</var></a> <a href="#$ext" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>File extension for view templates. Defaults to Cake's conventional ".ctp".</p> <div> <pre><span class="php-quote">'.ctp'</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$helpers"></a> <h3 class="property-name"> <a href="source-class-Controller.html#83-93" title="Go to source code"><var>$helpers</var></a> <a href="#$helpers" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> mixed </div> <div class="description detailed"> <p>An array containing the names of helpers this controller uses. The array elements should not contain the "Helper" part of the classname.</p> <p>Example: var $helpers = array('Html', 'Javascript', 'Time', 'Ajax');</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/53/components-helpers-and-uses">http://book.cakephp.org/view/53/components-helpers-and-uses</a><br> </div> <div> <pre><span class="php-keyword1">array</span>(<span class="php-quote">'Html'</span>, <span class="php-quote">'Form'</span>)</pre> </div> </div> </div> <div class="property-detail"> <a id="$here"></a> <h3 class="property-name"> <a href="source-class-Controller.html#49-55" title="Go to source code"><var>$here</var></a> <a href="#$here" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>Stores the current URL, relative to the webroot of the application.</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$layout"></a> <h3 class="property-name"> <a href="source-class-Controller.html#173-182" title="Go to source code"><var>$layout</var></a> <a href="#$layout" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>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.</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/54/Page-related-Attributes-layout-and-pageTitle">http://book.cakephp.org/view/54/Page-related-Attributes-layout-and-pageTitle</a><br> </div> <div> <pre><span class="php-quote">'default'</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$layoutPath"></a> <h3 class="property-name"> <a href="source-class-Controller.html#136-142" title="Go to source code"><var>$layoutPath</var></a> <a href="#$layoutPath" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>The name of the layouts subfolder containing layouts for this controller.</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$methods"></a> <h3 class="property-name"> <a href="source-class-Controller.html#288-295" title="Go to source code"><var>$methods</var></a> <a href="#$methods" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> array </div> <div class="description detailed"> <p>Holds current methods of the controller</p> <h6>Link</h6> <div class="list"> </div> <div> <pre><span class="php-keyword1">array</span>()</pre> </div> </div> </div> <div class="property-detail"> <a id="$modelClass"></a> <h3 class="property-name"> <a href="source-class-Controller.html#296-305" title="Go to source code"><var>$modelClass</var></a> <a href="#$modelClass" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>This controller's primary model class name, the Inflector::classify()'ed version of the controller's $name property.</p> <p>Example: For a controller named 'Comments', the modelClass would be 'Comment'</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$modelKey"></a> <h3 class="property-name"> <a href="source-class-Controller.html#306-314" title="Go to source code"><var>$modelKey</var></a> <a href="#$modelKey" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>This controller's model key name, an underscored version of the controller's $modelClass property.</p> <p>Example: For a controller named 'ArticleComments', the modelKey would be 'article_comment'</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$modelNames"></a> <h3 class="property-name"> <a href="source-class-Controller.html#159-165" title="Go to source code"><var>$modelNames</var></a> <a href="#$modelNames" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> array </div> <div class="description detailed"> <p>An array containing the class names of the models this controller uses.</p> <div> <pre><span class="php-keyword1">array</span>()</pre> </div> </div> </div> <div class="property-detail"> <a id="$name"></a> <h3 class="property-name"> <a href="source-class-Controller.html#41-48" title="Go to source code"><var>$name</var></a> <a href="#$name" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>The name of this controller. Controller names are plural, named after the model they manipulate.</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/52/name">http://book.cakephp.org/view/52/name</a><br> </div> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$output"></a> <h3 class="property-name"> <a href="source-class-Controller.html#230-238" title="Go to source code"><var>$output</var></a> <a href="#$output" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>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.</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$pageTitle"></a> <h3 class="property-name"> <a href="source-class-Controller.html#150-158" title="Go to source code"><var>$pageTitle</var></a> <a href="#$pageTitle" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> boolean </div> <div class="description detailed"> <p>Text to be used for the $title_for_layout layout variable (usually placed inside <title> tags.)</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/54/Page-related-Attributes-layout-and-pageTitle">http://book.cakephp.org/view/54/Page-related-Attributes-layout-and-pageTitle</a><br> </div> <div> <pre><span class="php-keyword1">false</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$paginate"></a> <h3 class="property-name"> <a href="source-class-Controller.html#111-128" title="Go to source code"><var>$paginate</var></a> <a href="#$paginate" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> array </div> <div class="description detailed"> <p>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().</p> <p>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:</p> <p>var $paginate = array( 'Post' => array(...), 'Comment' => array(...) );</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/164/Pagination">http://book.cakephp.org/view/164/Pagination</a><br> </div> <div> <pre><span class="php-keyword1">array</span>(<span class="php-quote">'limit'</span> => <span class="php-num">20</span>, <span class="php-quote">'page'</span> => <span class="php-num">1</span>)</pre> </div> </div> </div> <div class="property-detail"> <a id="$params"></a> <h3 class="property-name"> <a href="source-class-Controller.html#94-102" title="Go to source code"><var>$params</var></a> <a href="#$params" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> array </div> <div class="description detailed"> <p>Parameters received in the current request: GET and POST data, information about the request, etc.</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/55/The-Parameters-Attribute-params">http://book.cakephp.org/view/55/The-Parameters-Attribute-params</a><br> </div> <div> <pre><span class="php-keyword1">array</span>()</pre> </div> </div> </div> <div class="property-detail"> <a id="$passedArgs"></a> <h3 class="property-name"> <a href="source-class-Controller.html#273-279" title="Go to source code"><var>$passedArgs</var></a> <a href="#$passedArgs" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> mixed </div> <div class="description detailed"> <p>Holds all params passed and named.</p> <div> <pre><span class="php-keyword1">array</span>()</pre> </div> </div> </div> <div class="property-detail"> <a id="$persistModel"></a> <h3 class="property-name"> <a href="source-class-Controller.html#264-272" title="Go to source code"><var>$persistModel</var></a> <a href="#$persistModel" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> boolean </div> <div class="description detailed"> <p>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.</p> <div> <pre><span class="php-keyword1">false</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$plugin"></a> <h3 class="property-name"> <a href="source-class-Controller.html#239-245" title="Go to source code"><var>$plugin</var></a> <a href="#$plugin" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>Automatically set to the name of a plugin.</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$scaffold"></a> <h3 class="property-name"> <a href="source-class-Controller.html#280-287" title="Go to source code"><var>$scaffold</var></a> <a href="#$scaffold" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> mixed </div> <div class="description detailed"> <p>Triggers Scaffolding</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/105/Scaffolding">http://book.cakephp.org/view/105/Scaffolding</a><br> </div> <div> <pre><span class="php-keyword1">false</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$uses"></a> <h3 class="property-name"> <a href="source-class-Controller.html#70-82" title="Go to source code"><var>$uses</var></a> <a href="#$uses" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> mixed </div> <div class="description detailed"> <p>An array containing the class names of models this controller uses.</p> <p>Example: var $uses = array('Product', 'Post', 'Comment');</p> <p>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</p> <h6>Link</h6> <div class="list"> <a href="http://book.cakephp.org/view/53/components-helpers-and-uses">http://book.cakephp.org/view/53/components-helpers-and-uses</a><br> </div> <div> <pre><span class="php-keyword1">false</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$validationErrors"></a> <h3 class="property-name"> <a href="source-class-Controller.html#315-321" title="Go to source code"><var>$validationErrors</var></a> <a href="#$validationErrors" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> array </div> <div class="description detailed"> <p>Holds any validation errors produced by the last call of the validateErrors() method/</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$view"></a> <h3 class="property-name"> <a href="source-class-Controller.html#216-222" title="Go to source code"><var>$view</var></a> <a href="#$view" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>The name of the View class this controller sends output to.</p> <div> <pre><span class="php-quote">'View'</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$viewPath"></a> <h3 class="property-name"> <a href="source-class-Controller.html#129-135" title="Go to source code"><var>$viewPath</var></a> <a href="#$viewPath" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>The name of the views subfolder containing views for this controller.</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> <div class="property-detail"> <a id="$viewVars"></a> <h3 class="property-name"> <a href="source-class-Controller.html#143-149" title="Go to source code"><var>$viewVars</var></a> <a href="#$viewVars" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> array </div> <div class="description detailed"> <p>Contains variables to be handed to the view.</p> <div> <pre><span class="php-keyword1">array</span>()</pre> </div> </div> </div> <div class="property-detail"> <a id="$webroot"></a> <h3 class="property-name"> <a href="source-class-Controller.html#56-62" title="Go to source code"><var>$webroot</var></a> <a href="#$webroot" class="permalink" title="Permalink to this property">¶</a> </h3> <div class="attributes"> <span class="label">public</span> string </div> <div class="description detailed"> <p>The webroot of the application. Helpful if your application is placed in a folder under the current domain name.</p> <div> <pre><span class="php-keyword1">null</span></pre> </div> </div> </div> </div> </div> </div> </div> </div> </div> <section id="socials" class="back-3"> <div class="container-fluid"> <div class="row"> <div class="col-xs-12 col-sm-12 col-lg-12 social-footer text-center "> <a href="https://phpc.social/@cakephp" rel="me" aria-label="Twitter" data-toggle="tooltip" title="Mastodon"><i class="fa-brands icon-social fa-mastodon"></i></a> <a href="https://twitter.com/cakephp" aria-label="Twitter" data-toggle="tooltip" title="Twitter"><i class="fa-brands icon-social fa-twitter"></i></a> <a href="https://www.facebook.com/groups/cake.community" aria-label="Facebook" data-toggle="tooltip" title="Facebook"><i class="fa-brands icon-social fa-facebook"></i></a> <a href="https://www.youtube.com/user/CakePHP" aria-label="Youtube" data-toggle="tooltip" title="Youtube"><i class="fa-brands icon-social fa-youtube"></i></a> <a href="https://www.linkedin.com/groups/4623165" aria-label="Linkedin" data-toggle="tooltip" title="LinkedIn"><i class="fa-brands icon-social fa-linkedin-in"></i></a> <a href="https://github.com/cakephp" aria-label="Github" data-toggle="tooltip" title="Github"><i class="fa-brands icon-social fa-git"></i></a> <a href="https://slack-invite.cakephp.org" aria-label="Slack" target="_blank" title="Slack" data-toggle="tooltip"><i class="fa-brand fa-slack icon-social"></i></a> <a href="https://stackoverflow.com/tags/cakephp" aria-label="Stack Overflow" data-toggle="tooltip" title="Stack Overflow"><i class="fa-brand icon-social fa-stack-overflow"></i></a> <!-- need to upgrade font-awesome for this <a href="https://phpc.social/@cakephp" aria-label="CakePHP" data-toggle="tooltip" title="CakePHP"><i class="fa icon-social fa-stack-mastodon"></i></a> --> </div> </div> </div> </section> <footer id="footer" class="footer-wrapper"> <div class="container"> <div class="row col-p30"> <div class="col-sm-12 col-md-3"> <div class="footer-widget t-footer"> <div class="col-md-12"> <a href="https://www.openhub.net/p/cakephp"> <img alt="OpenHub" src="resources/open-hub.svg?f8a19d269d533821c6b08cb2cfa524bdef84d451" aria-label="openHub" style="opacity: .5"> </a> <div class="mt10"> <a href="https://pingping.io"> <img alt="Rackspace" src="resources/pingping.png?c78c4bffd8ef1049bdf51334a193fe50e523f6ba" aria-label="pingping.io"> </a> </div> <div class="mt10"> <a href="https://www.linode.com/"> <img alt="Rackspace" src="resources/linode.png?cb16ebd9b3f4cc9866e86bff6299032137279f6f" aria-label="Linode"> </a> </div> </div> </div> </div> <div class="col-sm-12 col-md-9"> <div class="col-md-3 col-sm-6 business-solution"> <ul class="footer-menu"> <li class="menu-title"> <a href="https://cakephp.org/business-solutions"><i class="fa fa-menu-title fa-briefcase"></i>Business Solutions</a> </li> <li class="menu-title mt30"> <a href="https://cakephp.org/showcase"><i class="fa fa-menu-title fa-desktop"></i>Showcase</a> </li> </ul> </div> <div class="col-md-3 col-sm-6"> <ul class="footer-menu"> <li class="menu-title"> <i class="fa fa-menu-title fa-book"></i>Documentation </li> <li><a href="https://book.cakephp.org"><i class="fa fa-menu fa-chevron-right"></i>Book</a></li> <li><a href="https://api.cakephp.org"><i class="fa fa-menu fa-chevron-right"></i>API</a></li> <li><a href="https://cakephp.org/documentation/videos"><i class="fa fa-menu fa-chevron-right"></i>Videos</a></li> <li><a href="https://github.com/cakephp/cakephp#security"><i class="fa fa-menu fa-chevron-right"></i>Reporting Security Issues</a></li> <li><a href="https://cakephp.org/privacy"><i class="fa fa-menu fa-chevron-right"></i>Privacy Policy</a></li> <li><a href="https://cakephp.org/pages/trademark"><i class="fa fa-menu fa-chevron-right"></i>Logos & Trademarks</a></li> </ul> </div> <div class="col-md-3 col-sm-6"> <ul class="footer-menu"> <li class="menu-title"><i class="fa fa-menu-title fa-users"></i>Community</li> <li><a href="https://cakephp.org/pages/get-involved"><i class="fa fa-menu fa-chevron-right"></i>Get Involved</a></li> <li><a href="https://github.com/cakephp/cakephp/issues"><i class="fa fa-menu fa-chevron-right"></i>Issues (GitHub)</a></li> <li><a href="https://bakery.cakephp.org"><i class="fa fa-menu fa-chevron-right"></i>Bakery</a></li> <li><a href="https://github.com/FriendsOfCake/awesome-cakephp"><i class="fa fa-menu fa-chevron-right"></i>Featured Resources</a></li> <li><a href="https://training.cakephp.org/"><i class="fa fa-menu fa-chevron-right"></i>Training</a></li> <li><a href="https://cakephp.org/pages/meetups"><i class="fa fa-menu fa-chevron-right"></i>Meetups</a></li> <li><a href="https://my.cakephp.org/login"><i class="fa fa-menu fa-chevron-right"></i>My CakePHP</a></li> <li><a href="https://cakefest.org"><i class="fa fa-menu fa-chevron-right"></i>CakeFest</a></li> <li><a href="https://cakephp.org/pages/newsletter"><i class="fa fa-menu fa-chevron-right"></i>Newsletter</a></li> <li><a href="https://www.linkedin.com/groups/4623165"><i class="fa fa-menu fa-chevron-right"></i>Linkedin</a></li> <li><a href="https://www.youtube.com/user/CakePHP"><i class="fa fa-menu fa-chevron-right"></i>YouTube</a></li> <li><a href="https://www.facebook.com/CakePHP/"><i class="fa fa-menu fa-chevron-right"></i>Facebook</a></li> <li><a href="https://twitter.com/cakephp"><i class="fa fa-menu fa-chevron-right"></i>Twitter</a></li> <li><a href="https://phpc.social/@cakephp"><i class="fa fa-menu fa-chevron-right"></i>Mastodon</a></li> </ul> </div> <div class="col-md-3 col-sm-6"> <ul class="footer-menu"> <li class="menu-title"><i class="fa fa-menu-title fa-comments-o"></i>Help & Support</li> <li><a href="https://discourse.cakephp.org"><i class="fa fa-menu fa-chevron-right"></i>Forum</a></li> <li><a href="https://stackoverflow.com/tags/cakephp"><i class="fa fa-menu fa-chevron-right"></i>Stack Overflow</a></li> <li><a href="https://slack-invite.cakephp.org/"><i class="fa fa-menu fa-chevron-right"></i>Slack</a></li> <li><a href="https://cakedc.com"><i class="fa fa-menu fa-chevron-right"></i>Paid Support</a></li> </ul> </div> </div> </div> <div class="row"> <div class="col-md-12 text-center mt30"> <p class="copyright"> Generated using <a href="https://github.com/cakephp/cakephp-api-docs">CakePHP API Docs</a> </p> </div> </div> </div> </footer> </body> </html>