This document is for CakePHP's development version, which can be significantly different
from previous releases.
You may want to read
current stable release documentation instead.
Contents¶
Preface
- CakePHP at a Glance
- Quick Start Guide
- Migration Guides
- 4.0 Upgrade Guide
- 4.0 Migration Guide
- 4.1 Migration Guide
- 4.2 Migration Guide
- 4.3 Migration Guide
- 4.4 Migration Guide
- 4.5 Migration Guide
- 4.6 Migration Guide
- Tutorials & Examples
- Contributing
- Documentation
- Tickets
- Code
- Coding Standards
- Backwards Compatibility Guide
- Release Policy
Getting Started
- Installation
- Configuration
- Configuring your Application
- Additional Class Paths
- Inflection Configuration
- Configure Class
- Reading and writing configuration files
- Disabling Generic Tables
- Application
- Dependency Injection
- Routing
RouterBuilder- Quick Tour
- Connecting Routes
- Route Elements
- Reserved Route Elements
- Configuring Route Options
- Passing Parameters to Action
- Using Path Routing
- Using Named Routes
- Prefix Routing
- Creating Links to Prefix Routes
- Plugin Routing
- Creating Links to Plugin Routes
- SEO-Friendly Routing
- Matching Specific HTTP Methods
- Matching Specific Hostnames
- Routing File Extensions
- Route Scoped Middleware
- RESTful Routing
- Passed Arguments
- Generating URLs
- Generating Asset URLs
- Redirect Routing
- Entity Routing
- Custom Route Classes
- Creating Persistent URL Parameters
- Request & Response Objects
- Request
ServerRequest- Request Parameters
- Query String Parameters
- Request Body Data
- File Uploads
- PUT, PATCH or DELETE Data
- Environment Variables (from $_SERVER and $_ENV)
- XML or JSON Data
- Path Information
- Checking Request Conditions
- Session Data
- Host and Domain Name
- Reading the HTTP Method
- Restricting Which HTTP method an Action Accepts
- Reading HTTP Headers
- Trusting Proxy Headers
- Checking Accept Headers
- Reading Cookies
- Uploaded Files
- Manipulating URIs
- Response
- Setting Cross Origin Request Headers (CORS)
- Common Mistakes with Immutable Responses
- Cookie Collections
- Request
- Middleware
- Controllers
Controller- The App Controller
- Request Flow
- Controller Actions
- Interacting with Views
- Content Type Negotiation
- Content Type Negotiation Fallbacks
- Redirecting to Other Pages
- Loading Additional Models
- Paginating a Model
- Configuring Components to Load
- Request Life-cycle Callbacks
- Controller Middleware
- More on Controllers
- The Pages Controller
- Components
- AuthComponent
AuthComponent- Suggested Reading Before Continuing
- Authentication
- Choosing an Authentication Type
- Configuring Authentication Handlers
- Customizing Find Query
- Identifying Users and Logging Them In
- Redirecting Users After Login
- Creating Stateless Authentication Systems
- Using Basic Authentication
- Using Digest Authentication
- Creating Custom Authentication Objects
- Using Custom Authentication Objects
- Handling Unauthenticated Requests
- Displaying Auth Related Flash Messages
- Hashing Passwords
- Creating Custom Password Hasher Classes
- Changing Hashing Algorithms
- Manually Logging Users In
- Accessing the Logged In User
- Logging Users Out
- Deciding When to run Authentication
- Authorization
- Configuration options
- Testing Actions Protected By AuthComponent
- Flash
- Security
- Pagination
- Request Handling
- FormProtection
- Checking HTTP Cache
- Configuring Components
- Using Components
- Creating a Component
- Component Callbacks
- Using Redirects in Component Events
- AuthComponent
- Views
View- The App View
- View Templates
- Using View Blocks
- Layouts
- Elements
- View Events
- Creating Your Own View Classes
- More About Views
- View Cells
- Themes
- JSON and XML views
- Helpers
- Breadcrumbs
- Flash
- Form
FormHelper- Starting a Form
- Creating Form Controls
- Generating Specific Types of Controls
- Creating Input Elements
- Creating Labels
- Displaying and Checking Errors
- Creating Buttons and Submit Elements
- Closing the Form
- Creating Standalone Buttons and POST Links
- Customizing the Templates FormHelper Uses
- Generating Entire Forms
- Creating Inputs for Associated Data
- Adding Custom Widgets
- Working with SecurityComponent
- Html
HtmlHelper- Inserting Well-Formatted Elements
- Changing the Tags Output by HtmlHelper
- Number
- Paginator
PaginatorHelper- PaginatorHelper Templates
- Creating Sort Links
- Creating Page Number Links
- Creating Jump Links
- Creating Header Link Tags
- Checking the Pagination State
- Creating a Page Counter
- Generating Pagination URLs
- Creating a Limit Selectbox Control
- Configuring Pagination Options
- Example Usage
- Paginating Multiple Results
- Text
- Time
- Url
- Configuring Helpers
- Using Helpers
- Callback Methods
- Creating Helpers
- Helper Class
- Database Access & ORM
- Quick Example
- More Information
- Database Basics
- Query Builder
- Table Objects
- Basic Usage
- Lifecycle Callbacks
- Behaviors
- Configuring Connections
- Using the TableLocator
- Entities
- Retrieving Data & Results Sets
Table- Debugging Queries and ResultSets
- Getting a Single Entity by Primary Key
- Using Finders to Load Data
- Getting the First Result
- Getting a Count of Results
- Finding Key/Value Pairs
- Finding Threaded Data
- Custom Finder Methods
- Dynamic Finders
- Retrieving Associated Data
- Eager Loading Associations Via Contain
- Filtering by Associated Data Via Matching And Joins
- Changing Fetching Strategies
- Lazy Loading Associations
- Working with Result Sets
- Modifying Results with Map/Reduce
- Validating Data
- Saving Data
- A Glance Over Saving Data
- Converting Request Data into Entities
- Converting BelongsToMany Data
- Converting HasMany Data
- Converting Multiple Records
- Changing Accessible Fields
- Merging Request Data Into Entities
- Modifying Request Data Before Building Entities
- Modifying Entities After Updating From Request Data
- Validating Data Before Building Entities
- Avoiding Property Mass Assignment Attacks
- Saving Entities
- Strict Saving
- Find or Create an Entity
- Creating with an existing primary key
- Saving Multiple Entities
- Bulk Updates
- Deleting Data
- Associations - Linking Tables Together
- Behaviors
- Using Behaviors
- Core Behaviors
- Creating a Behavior
- Transforming Request Data into Entity Properties
- Removing Loaded Behaviors
- Accessing Loaded Behaviors
- Schema System
- Schema Cache Tool
Using CakePHP
- Caching
- Console Commands
- The CakePHP Console
- Console Applications
- Renaming Commands
- Commands
- Command Objects
- Command Input/Output
- Option Parsers
- Running Shells as Cron Jobs
- CakePHP Provided Commands
- Cache Tool
- Completion Tool
- I18N Tool
- Plugin Tool
- Schema Cache Tool
- Routes Tool
- Server Tool
- Interactive Console (REPL)
- Shells
- Routing in the Console Environment
- Debugging
- Deployment
- Mailer
- Error & Exception Handling
- Error & Exception Configuration
- Changing Exception Handling
- Listen to Events
- Custom Error Templates
- Custom ErrorController
- Custom ExceptionRenderer
- Custom Error Logging
- Custom Error Rendering
- Creating your own Application Exceptions
- Built in Exceptions for CakePHP
- HTTP Exceptions
- Using HTTP Exceptions in your Controllers
- Other Built In Exceptions
MissingViewExceptionMissingTemplateExceptionMissingLayoutExceptionMissingHelperExceptionMissingElementExceptionMissingCellExceptionMissingCellViewExceptionMissingComponentExceptionMissingActionExceptionPrivateActionExceptionConsoleExceptionMissingTaskExceptionMissingShellExceptionMissingShellMethodExceptionMissingConnectionExceptionMissingDriverExceptionMissingExtensionExceptionMissingTableExceptionMissingEntityExceptionMissingBehaviorExceptionPersistenceFailedExceptionRecordNotFoundExceptionMissingControllerExceptionMissingRouteExceptionMissingDispatcherFilterExceptionException
- Creating your Own Error Handler
- Events System
- Internationalization & Localization
- Logging
- Modelless Forms
- Pagination
- Plugins
- Installing a Plugin With Composer
- Manually Installing a Plugin
- Loading a Plugin
- Plugin Hook Configuration
- Using Plugin Classes
- Creating Your Own Plugins
- Plugin Objects
- Plugin Routes
- Plugin Controllers
- Plugin Models
- Plugin Templates
- Plugin Assets
- Components, Helpers and Behaviors
- Commands
- Testing your Plugin
- Publishing your Plugin
- Plugin Map File
- Manage Your Plugins using Mixer
- REST
- Security
- Sessions
- 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
- Loading Routes in Tests
- Testing Table Classes
- Controller Integration Testing
- Setting up the Request
- Testing Actions That Require Authentication
- Testing Stateless Authentication and APIs
- Testing Actions Protected by CsrfComponent or SecurityComponent
- Integration Testing PSR-7 Middleware
- Testing with Encrypted Cookies
- Testing Flash Messages
- Testing a JSON Responding Controller
- Testing with file uploads
- Disabling Error Handling Middleware in Tests
- Assertion methods
- Comparing test results to a file
- Console Integration Testing
- Mocking Injected Dependencies
- Mocking HTTP Client Responses
- Testing Views
- Testing Components
- Testing Helpers
- Testing Events
- Testing Email
- Creating Test Suites
- Creating Tests for Plugins
- Generating Tests with Bake
- Validation
Utility Classes
- App Class
- Collections
Collection- Quick Example
- List of Methods
- Iterating
- Filtering
- Aggregation
- Sorting
- Working with Tree Data
- Other Methods
- 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::normalizeFullPathFolder::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
- Http Client
- Inflector
- Number
- Plugin Class
- Registry Objects
- Text
- Date & Time
- Xml
Plugins & Packages
Other
- Constants & Functions
- Appendices
- 4.x Migration Guide
- Backwards Compatibility Shimming
- Forwards Compatibility Shimming
- General Information