CakePHP Naming Conventions Global Functions

config ('file_name') up ('string')

Models
Class Name: singular, camel cased
(LineItem, Person)
(LineItemsController, People Controller)
File Name: singular, underscored
(line_item.php, person.php)
Table Name: plural, underscored
(line_items, people)
Controllers
Class Name: plural, camel cased,
ends in "Controller"
File Name: plural, underscored
(line_items_controller.php,
people_controller.php)
Views
Path: controller name, underscored
(app/views/line_items/<file>, app/
views/people/<file>)
File Name: action name, lowercase
(index.thtml, view.thtml)
uses ('file_name') r ('search', 'replace', 'text')
vendor ('file_name') pr (array)
debug ('message') am (array, [array, array])
a (element, [element, element]) env ('HTTP_HEADER')
aa (key, value, [key, value]) cache (path, data, expires, [target])
e ('message')
clearCache ([params, type, ext])
low ('STRING') countdim (array)

Model Controller View

Properties Properties Properties
$cacheQueries $recursive Association Properties $name $action $action $autoLayout
$data $useDbConfig $belongsTo $autoLayout $autoRender $autoRender $base
$displayField $useTable $hasAndBelongsToMany $base $beforeFilter $controller $ext
$id $validate $hasMany $cacheAction $components $hasRendered $helpers
$name $validationErrors $hasOne $data $helpers $here $layout
$primaryKey $_tableInfo $here $layout $loaded $models
$output $pageTitle $name $pageTitle
Methods
getLastInsertID ( ) $params $persistModel $params $parent
bindModel (params)
create ( ) getNumRows ( ) $plugin $uses $plugin $subDir
$view $viewPath $themeWeb $uses
delete (id, [cascade]) hasAny ([conditions])
$webroot $viewPath
escapeField (field) hasField (name)
execute (data) invalidate (field) Methods Methods
exists ( ) invalidFields ([data]) cleanUpFields ( ) element (name)
field (name, conditions, order) isForeignKey (field) constructClasses ( ) error (code, name, message)
find ([conditions, fields, order, recursive]) loadInfo ( ) flash (message, url, [pause]) pluginView (action, layout)
findAll ([conditions, fields, order, limit, page, recur...]) query ([sql]) flashOut (message, url, [pause]) render ([action, layout, file])
findAllThreaded([conditions, fields, sort]) read ([fields, id]) generateFieldNames (data, doCreateO...) renderCache (filename, timeStart)
findCount ([conditions, recursive]) remove ([id, cascade]) postConditions (data) renderElement (name, [params])
findNeighbours (conditions, field, value) save ([data, validate, fieldList]) redirect (url, [status]) renderLayout (content_for_layout)
generateList ([conditions, order, limit, keyPath, val...]) saveField ([name, value, validate]) referer ([default, local]) setLayout (layout)
getAffectedRows ( ) set (one, [two]) render([action, layout, file])
getColumnType (column) setDataSource (dataSource) set (one, [two])
getColumnTypes ( ) setSource (tableName)
setAction (action, [param, param, param])
getDisplayField ( ) unbindModel (params)
validate ( ) Helper
getID ([list]) validates ([data])
validateErrors ( )
Callbacks Availability: View only
beforeDelete ( ) afterDelete ( ) beforeSave ( ) afterSave ( ) Callbacks
Properties
beforeFind (&qu..) afterFind (results) beforeValidate ( ) beforeFilter ( ) beforeRender ( )
$tags
afterFilter ( )
$base
$here
Global Constants $action
$themeWeb
Core Defines Paths Component $view
ACL_CLASSNAME CAKE_SESSION_STRING APP INFLECTIONS
Availability: Controller / View $webroot
ACL_FILENAME CAKE_SESSION_TABLE APP_DIR JS
Properties $params
AUTO_SESSION CAKE_SESSION_TIMEOUT APP_PATH LAYOUTS
$disableStartup $data
CACHE_CHECK COMPRESS_CSS CACHE LIB_TESTS
$plugin
CAKE_ADMIN DEBUG CAKE LIBS Callbacks
CAKE_SECURITY LOG_ERROR COMPONENTS LOGS startup (&controller) Callbacks
CAKE_SESSION_COOKIE MAX_MD5SIZE CONFIGS MODEL_TESTS afterRender ( )
CAKE_SESSION_SAVE WEBSERVICES CONTROLLER_TESTS MODELS Conventions
Class Name: MyCoolComponent Conventions
CONTROLLERS SCRIPTS
Path: app/controllers/components/my_cool.php Class Name: MyCoolHelper
Webroot Configurable Paths CSS TESTS
Path: app/views/helpers/my_cool.php
CORE_PATH ROOT ELEMENTS TMP Usage
WWW_ROOT WEBROOT_DIR HELPER_TESTS VENDORS Controller: $this->MyCool->method( ); Usage
CAKE_CORE_INCLUDE_PATH HELPERS VIEWS View: $this->controller->MyCool->method( ); View: $myCool->method( );

Copyright © 2006, Cake Software Foundation