This document is for a version of CakePHP that is no longer supported. Please upgrade to a newer release!
Contents¶
- Welcome
- Installation
- Getting Started
- Blog Tutorial
- Blog Tutorial - Adding a layer
- CakePHP Overview
- Controllers
- The App Controller
- Request parameters
- Controller actions
- Request Life-cycle callbacks
- Controller Methods
- Controller Attributes
- More on controllers
- Request and Response objects
- CakeRequest
- Accessing request parameters
- Accessing Querystring parameters
- Accessing POST data
- Accessing PUT or POST data
- Accessing XML or JSON data
- Accessing path information
- Inspecting the request
- CakeRequest and RequestHandlerComponent
- Interacting with other aspects of the request
- CakeRequest API
CakeRequestCakeRequest::domain()CakeRequest::subdomains()CakeRequest::host()CakeRequest::method()CakeRequest::onlyAllow()CakeRequest::allowMethod()CakeRequest::referer()CakeRequest::clientIp()CakeRequest::header()CakeRequest::input()CakeRequest::data()CakeRequest::query()CakeRequest::is()CakeRequest::addDetector()CakeRequest::accepts()CakeRequest::acceptLanguageCakeRequest::param()CakeRequest::$dataCakeRequest::$queryCakeRequest::$paramsCakeRequest::$hereCakeRequest::$baseCakeRequest::$webroot
- CakeResponse
- Changing the response class
- Dealing with content types
- Sending files
- Sending a string as file
- Setting headers
- Interacting with browser caching
- Fine tuning HTTP cache
- CakeResponse and testing
- CakeResponse API
CakeResponseCakeResponse::header()CakeResponse::location()CakeResponse::charset()CakeResponse::type()CakeResponse::cache()CakeResponse::disableCache()CakeResponse::sharable()CakeResponse::expires()CakeResponse::etag()CakeResponse::modified()CakeResponse::checkNotModified()CakeResponse::compress()CakeResponse::download()CakeResponse::statusCode()CakeResponse::body()CakeResponse::send()CakeResponse::file()
- Scaffolding
- The Pages Controller
- Components
- Views
- View Templates
- Using view blocks
- Layouts
- Elements
- Creating your own view classes
- View API
ViewView::set()View::get()View::getVar()View::getVars()View::element()View::uuid()View::addScript()View::blocks()View::start()View::end()View::append()View::prepend()View::startIfEmpty()View::assign()View::fetch()View::extend()View::$layoutView::$elementCacheView::$requestView::$outputView::$Blocks
- More about Views
- Themes
- Media Views
- JSON and XML views
- Helpers
- CacheHelper
- FlashHelper
- FormHelper
FormHelper- Creating Forms
- Closing the Form
- Creating form elements
- Generating specific types of inputs
- Form Element-Specific Methods
- Creating buttons and submit elements
- Creating date and time inputs
- Displaying and checking errors
- Setting Defaults for all fields
- Working with SecurityComponent
- 2.0 updates
- HtmlHelper
HtmlHelper- Inserting Well-Formatted elements
HtmlHelper::charset()HtmlHelper::css()HtmlHelper::meta()HtmlHelper::docType()HtmlHelper::style()HtmlHelper::image()HtmlHelper::link()HtmlHelper::media()HtmlHelper::tag()HtmlHelper::div()HtmlHelper::para()HtmlHelper::script()HtmlHelper::scriptBlock()HtmlHelper::scriptStart()HtmlHelper::scriptEnd()HtmlHelper::nestedList()HtmlHelper::tableHeaders()HtmlHelper::tableCells()HtmlHelper::url()HtmlHelper::useTag()
- Changing the tags output by HtmlHelper
- Creating breadcrumb trails with HtmlHelper
- JsHelper
JsHelper- Using a specific JavaScript engine
- Creating a JavaScript Engine
- JavaScript engine usage
- Other Methods
JsHelper::object()JsHelper::sortable()JsHelper::request()JsHelper::get()JsHelper::set()JsHelper::drag()JsHelper::drop()JsHelper::slider()JsHelper::effect()JsHelper::event()JsHelper::domReady()JsHelper::each()JsHelper::alert()JsHelper::confirm()JsHelper::prompt()JsHelper::submit()JsHelper::link()JsHelper::serializeForm()JsHelper::redirect()JsHelper::value()
- AJAX Pagination
- NumberHelper
- PaginatorHelper
- RssHelper
- SessionHelper
- TextHelper
- TimeHelper
TimeHelper- Using the Helper
- Formatting
TimeHelper::convert()TimeHelper::convertSpecifiers()TimeHelper::dayAsSql()TimeHelper::daysAsSql()TimeHelper::format()TimeHelper::fromString()TimeHelper::gmt()TimeHelper::i18nFormat()TimeHelper::nice()TimeHelper::niceShort()TimeHelper::serverOffset()TimeHelper::timeAgoInWords()TimeHelper::toAtom()TimeHelper::toQuarter()TimeHelper::toRSS()TimeHelper::toUnix()TimeHelper::toServer()TimeHelper::timezone()TimeHelper::listTimezones()
- Testing Time
- Using and Configuring Helpers
- Using Helpers
- Callback methods
- Creating Helpers
- Creating Functionality for All Helpers
- Helper API
- Models
- Understanding Models
- More on models
- Associations: Linking Models Together
- Retrieving Your Data
- Saving Your Data
- Model::set($one, $two = null)
- Model::clear()
- Model::save(array $data = null, boolean $validate = true, array $fieldList = array())
- Model::create(array $data = array())
- Model::saveField(string $fieldName, string $fieldValue, $validate = false)
- Model::updateAll(array $fields, mixed $conditions)
- Model::saveMany(array $data = null, array $options = array())
- Model::saveAssociated(array $data = null, array $options = array())
- Model::saveAll(array $data = null, array $options = array())
- Saving Related Model Data (hasOne, hasMany, belongsTo)
- Saving hasMany through data
- Datatables
- Deleting Data
- Data Validation
- Simple Rules
- One Rule Per Field
- Multiple Rules per Field
- Custom Validation Rules
- Dynamically change validation rules
- Core Validation Rules
ValidationValidation::alphaNumericValidation::lengthBetweenValidation::blankValidation::booleanValidation::ccValidation::comparisonValidation::customValidation::dateValidation::datetimeValidation::decimalValidation::emailValidation::equalToValidation::extensionValidation::fileSizeValidation::inListValidation::ipValidation::luhnValidation::maxLengthValidation::maxLengthBytesValidation::mimeTypeValidation::minLengthValidation::minLengthBytesValidation::moneyValidation::multipleValidation::notEmptyValidation::notBlankValidation::numericValidation::naturalNumberValidation::phoneValidation::postalValidation::rangeValidation::ssnValidation::timeValidation::uploadErrorValidation::urlValidation::userDefinedValidation::uuid
Model::Validation::isUnique()
- Localized Validation
- Callback Methods
- Behaviors
- ACL
- Containable
- Translate
- Tree
- Using Behaviors
- Creating Behaviors
- Creating behavior methods
- Behavior callbacks
- DataSources
- Model Attributes
- Additional Methods and Properties
Model::associations()Model::buildQuery(string $type = 'first', array $query = array())Model::deconstruct(string $field, mixed $data)Model::escapeField(string $field = null, string $alias = null)Model::exists($id)Model::getAffectedRows()Model::getAssociated(string $type = null)Model::getColumnType(string $column)Model::getColumnTypes()Model::getID(integer $list = 0)Model::getInsertID()Model::getLastInsertID()
- Virtual fields
- Transactions
- Core Libraries
- General Purpose
- General Purpose
- Global Constants and Functions
- App Class
App- Packages
- Loading classes
- Finding paths to packages using App::path()
- Adding paths for App to find packages in
- Finding which objects CakePHP knows about
- Locating plugins
- Locating themes
- Including files with App::import()
- Overriding classes in CakePHP
- Loading Vendor Files
- App Init/Load/Shutdown Methods
- Events System
- Example Event Usage
- Accessing Event Managers
- Dispatching Events
- Registering Listeners
- Conclusion
- Additional Reading
- Collections
- Behaviors
- ACL
- Containable
- Translate
- Tree
- Using Behaviors
- Creating Behaviors
- Creating behavior methods
- Behavior callbacks
- Components
- Helpers
- CacheHelper
- FlashHelper
- FormHelper
FormHelper- Creating Forms
- Closing the Form
- Creating form elements
- Generating specific types of inputs
- Form Element-Specific Methods
- Creating buttons and submit elements
- Creating date and time inputs
- Displaying and checking errors
- Setting Defaults for all fields
- Working with SecurityComponent
- 2.0 updates
- HtmlHelper
HtmlHelper- Inserting Well-Formatted elements
HtmlHelper::charset()HtmlHelper::css()HtmlHelper::meta()HtmlHelper::docType()HtmlHelper::style()HtmlHelper::image()HtmlHelper::link()HtmlHelper::media()HtmlHelper::tag()HtmlHelper::div()HtmlHelper::para()HtmlHelper::script()HtmlHelper::scriptBlock()HtmlHelper::scriptStart()HtmlHelper::scriptEnd()HtmlHelper::nestedList()HtmlHelper::tableHeaders()HtmlHelper::tableCells()HtmlHelper::url()HtmlHelper::useTag()
- Changing the tags output by HtmlHelper
- Creating breadcrumb trails with HtmlHelper
- JsHelper
JsHelper- Using a specific JavaScript engine
- Creating a JavaScript Engine
- JavaScript engine usage
- Other Methods
JsHelper::object()JsHelper::sortable()JsHelper::request()JsHelper::get()JsHelper::set()JsHelper::drag()JsHelper::drop()JsHelper::slider()JsHelper::effect()JsHelper::event()JsHelper::domReady()JsHelper::each()JsHelper::alert()JsHelper::confirm()JsHelper::prompt()JsHelper::submit()JsHelper::link()JsHelper::serializeForm()JsHelper::redirect()JsHelper::value()
- AJAX Pagination
- NumberHelper
- PaginatorHelper
- RssHelper
- SessionHelper
- TextHelper
- TimeHelper
TimeHelper- Using the Helper
- Formatting
TimeHelper::convert()TimeHelper::convertSpecifiers()TimeHelper::dayAsSql()TimeHelper::daysAsSql()TimeHelper::format()TimeHelper::fromString()TimeHelper::gmt()TimeHelper::i18nFormat()TimeHelper::nice()TimeHelper::niceShort()TimeHelper::serverOffset()TimeHelper::timeAgoInWords()TimeHelper::toAtom()TimeHelper::toQuarter()TimeHelper::toRSS()TimeHelper::toUnix()TimeHelper::toServer()TimeHelper::timezone()TimeHelper::listTimezones()
- Testing Time
- Using and Configuring Helpers
- Using Helpers
- Callback methods
- Creating Helpers
- Creating Functionality for All Helpers
- Helper API
- Collections
- General Purpose
- Behaviors
- Behaviors
- ACL
- Containable
- Translate
- Tree
- Behaviors
- Components
- Components
- Pagination
- Flash
- Sessions
- Authentication
AuthComponent- Suggested Reading Before Continuing
- Authentication
- Choosing an Authentication type
- Configuring Authentication handlers
- Identifying users and logging them in
- Creating Custom Authentication objects
- Using custom authentication objects
- Creating stateless authentication systems
- Handling unauthenticated requests
- Displaying auth related flash messages
- Hashing passwords
- Using bcrypt for passwords
- Creating custom password hasher classes
- Manually logging users in
- Accessing the logged in user
- Logging users out
- Authorization
- AuthComponent API
AuthComponent::$ajaxLoginAuthComponent::$allowedActionsAuthComponent::$authenticateAuthComponent::$authErrorAuthComponent::$authorizeAuthComponent::$componentsAuthComponent::$flashAuthComponent::$loginActionAuthComponent::$loginRedirectAuthComponent::$logoutRedirectAuthComponent::$unauthorizedRedirectAuthComponent::$requestAuthComponent::$responseAuthComponent::$sessionKeyAuthComponent::allow()AuthComponent::constructAuthenticate()AuthComponent::constructAuthorize()AuthComponent::deny()AuthComponent::identify()AuthComponent::initialize()AuthComponent::isAuthorized()AuthComponent::loggedIn()AuthComponent::login()AuthComponent::logout()AuthComponent::mapActions()AuthComponent::passwordAuthComponent::redirect()AuthComponent::redirectUrl()AuthComponent::shutdown()AuthComponent::startup()AuthComponent::user
- Security
- Request Handling
- Cookie
- Access Control Lists
- Components
- Helpers
- Helpers
- CacheHelper
- FlashHelper
- FormHelper
FormHelper- Creating Forms
- Closing the Form
- Creating form elements
- Generating specific types of inputs
- Form Element-Specific Methods
- Creating buttons and submit elements
- Creating date and time inputs
- Displaying and checking errors
- Setting Defaults for all fields
- Working with SecurityComponent
- 2.0 updates
- HtmlHelper
HtmlHelper- Inserting Well-Formatted elements
HtmlHelper::charset()HtmlHelper::css()HtmlHelper::meta()HtmlHelper::docType()HtmlHelper::style()HtmlHelper::image()HtmlHelper::link()HtmlHelper::media()HtmlHelper::tag()HtmlHelper::div()HtmlHelper::para()HtmlHelper::script()HtmlHelper::scriptBlock()HtmlHelper::scriptStart()HtmlHelper::scriptEnd()HtmlHelper::nestedList()HtmlHelper::tableHeaders()HtmlHelper::tableCells()HtmlHelper::url()HtmlHelper::useTag()
- Changing the tags output by HtmlHelper
- Creating breadcrumb trails with HtmlHelper
- JsHelper
JsHelper- Using a specific JavaScript engine
- Creating a JavaScript Engine
- JavaScript engine usage
- Other Methods
JsHelper::object()JsHelper::sortable()JsHelper::request()JsHelper::get()JsHelper::set()JsHelper::drag()JsHelper::drop()JsHelper::slider()JsHelper::effect()JsHelper::event()JsHelper::domReady()JsHelper::each()JsHelper::alert()JsHelper::confirm()JsHelper::prompt()JsHelper::submit()JsHelper::link()JsHelper::serializeForm()JsHelper::redirect()JsHelper::value()
- AJAX Pagination
- NumberHelper
- PaginatorHelper
- RssHelper
- SessionHelper
- TextHelper
- TimeHelper
TimeHelper- Using the Helper
- Formatting
TimeHelper::convert()TimeHelper::convertSpecifiers()TimeHelper::dayAsSql()TimeHelper::daysAsSql()TimeHelper::format()TimeHelper::fromString()TimeHelper::gmt()TimeHelper::i18nFormat()TimeHelper::nice()TimeHelper::niceShort()TimeHelper::serverOffset()TimeHelper::timeAgoInWords()TimeHelper::toAtom()TimeHelper::toQuarter()TimeHelper::toRSS()TimeHelper::toUnix()TimeHelper::toServer()TimeHelper::timezone()TimeHelper::listTimezones()
- Testing Time
- Helpers
- Utilities
- Utilities
- Caching
- CakeEmail
- Folder & File
- Basic usage
- Folder API
FolderFolder::$pathFolder::$sortFolder::$modeFolder::addPathElementFolder::cd()Folder::chmod()Folder::copy()Folder::correctSlashForFolder::create()Folder::delete()Folder::dirsize()Folder::errors()Folder::find()Folder::findRecursive()Folder::inCakePath()Folder::inPath()Folder::isAbsoluteFolder::isSlashTermFolder::isWindowsPathFolder::messages()Folder::move()Folder::normalizePathFolder::pwd()Folder::read()Folder::realpath()Folder::slashTermFolder::tree()
- File API
FileFile::$FolderFile::$nameFile::$infoFile::$handleFile::$lockFile::$pathFile::append()File::close()File::copy()File::create()File::delete()File::executable()File::exists()File::ext()File::Folder()File::group()File::info()File::lastAccess()File::lastChange()File::md5()File::name()File::offset()File::open()File::owner()File::perms()File::prepareFile::pwd()File::read()File::readable()File::safe()File::size()File::writable()File::write()File::mime()File::replaceText()
- Hash
Hash- Hash path syntax
- Expression Types
- Attribute Matching Types
Hash::getHash::extractHash::insertHash::removeHash::combineHash::formatHash::containsHash::checkHash::filterHash::flattenHash::expandHash::mergeHash::numericHash::dimensionsHash::maxDimensionsHash::mapHash::reduceHash::applyHash::sortHash::diffHash::mergeDiffHash::normalizeHash::nest
- HttpSocket
- Inflector
- Internationalization & Localization
- Logging
- CakeNumber
- Router
- Data Sanitization
- Security
- Set
- CakeText
- CakeTime
CakeTime- Formatting
CakeTime::convert()CakeTime::convertSpecifiers()CakeTime::dayAsSql()CakeTime::daysAsSql()CakeTime::format()CakeTime::fromString()CakeTime::gmt()CakeTime::i18nFormat()CakeTime::nice()CakeTime::niceShort()CakeTime::serverOffset()CakeTime::timeAgoInWords()CakeTime::toAtom()CakeTime::toQuarter()CakeTime::toRSS()CakeTime::toUnix()CakeTime::toServer()CakeTime::timezone()CakeTime::listTimezones()
- Testing Time
- Xml
- Utilities
- General Purpose
- Plugins
- Shells, Tasks & Console Tools
- The CakePHP console
- Creating a shell
- Shell tasks
- Invoking other shells from your shell
- Console output levels
- Styling output
- Configuring options and generating help
- Routing in shells / CLI
- Shell API
AppShellShellShell::$tasksShell::$usesShell::clear()Shell::param()Shell::createFile()Shell::dispatchShell()Shell::err()Shell::error()Shell::getOptionParser()Shell::hasMethod()Shell::hasTask()Shell::hr()Shell::in()Shell::initialize()Shell::loadTasks()Shell::nl()Shell::out()Shell::overwrite()Shell::runCommand()Shell::shortPath()Shell::startup()Shell::wrapText()
- More topics
- Development
- Configuration
- Routing
- Sessions
- Exceptions
- Exception configuration
- Exception classes
- Built-in Exceptions for CakePHP
BadRequestExceptionUnauthorizedExceptionForbiddenExceptionNotFoundExceptionMethodNotAllowedExceptionInternalErrorExceptionNotImplementedExceptionCakeExceptionCakeBaseExceptionMissingViewExceptionMissingLayoutExceptionMissingHelperExceptionMissingBehaviorExceptionMissingComponentExceptionMissingTaskExceptionMissingShellExceptionMissingShellMethodExceptionMissingDatabaseExceptionMissingConnectionExceptionMissingTableExceptionMissingActionExceptionMissingControllerExceptionPrivateActionException
- Using HTTP exceptions in your controllers
- Exception Renderer
- Creating your own application exceptions
- Extending and implementing your own Exception handlers
- Create your own Exception handler with Exception.handler
- Using AppController::appError()
- Using a custom renderer with Exception.renderer to handle application exceptions
- Error Handling
- Debugging
- Testing
- Installing PHPUnit
- Test Database Setup
- Checking the Test Setup
- Test Case Conventions
- Creating Your First Test Case
- Running Tests
- Test Case Lifecycle Callbacks
- Fixtures
- Testing Models
- Testing Controllers
- Testing Views
- Testing Components
- Testing Helpers
- Creating Test Suites
- Creating Tests for Plugins
- Integration with Jenkins
- REST
- Dispatcher Filters
- Deployment
- Tutorials & Examples
- Contributing
- Documentation
- Tickets
- Code
- Coding Standards
- Backwards Compatibility Guide
- CakePHP Development Process
- Appendices
- 2.10 Migration Guide
- 2.9 Migration Guide
- 2.8 Migration Guide
- 2.7 Migration Guide
- 2.6 Migration Guide
- 2.5 Migration Guide
- 2.4 Migration Guide
- 2.3 Migration Guide
- 2.2 Migration Guide
- 2.1 Migration Guide
- 2.0 Migration Guide
- 2.0 Migration Guide
- PHP Version Support
- File and Folder naming
- htaccess (URL Rewriting)
- AppController / AppModel / AppHelper / AppShell
- Internationalization / Localization
- Class location and constants changed
- Basics.php
- CakeRequest
- Request handling, $_GET[‘url’] and .htaccess files
- Components
- cakeError removed
- Error handling
- Lib classes
- Helpers
- Controller
- View
- PHPUnit instead of SimpleTest
- Model
- Behaviors
- Plugins
- Console
- Debugging
- ConnectionManager
- New Features in CakePHP 2.0
- PHPUnit Migration Hints
- 2.0 Migration Guide
- Migration from 1.2 to 1.3
- General Information