Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/en/appendices.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Appendices"
description: "CakePHP appendices: access migration guides, glossary, upgrade paths, development process info, and version-specific documentation."
---

# Appendices

Appendices contain information regarding the new features
Expand Down
5 changes: 5 additions & 0 deletions docs/en/appendices/5-0-migration-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "5.0 Migration Guide"
description: "Upgrade to CakePHP 5.0: migrate from 4.x, handle breaking changes, update code, understand new requirements and deprecation removals."
---

# 5.0 Migration Guide

CakePHP 5.0 contains breaking changes, and is not backwards compatible with 4.x
Expand Down
5 changes: 5 additions & 0 deletions docs/en/appendices/5-0-upgrade-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "5.0 Upgrade Guide"
description: "Upgrade to CakePHP 5.0 from 4.x. Fix deprecations, update to PHP 8.1+, run rector tool, and update dependencies following this step-by-step guide."
---

# 5.0 Upgrade Guide

First, check that your application is running on latest CakePHP 4.x version.
Expand Down
5 changes: 5 additions & 0 deletions docs/en/appendices/5-1-migration-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "5.1 Migration Guide"
description: "Migrate to CakePHP 5.1: explore new features, deprecations, improvements, and upgrade your 5.0 application with this comprehensive guide."
---

# 5.1 Migration Guide

The 5.1.0 release is backwards compatible with 5.0. It adds new functionality
Expand Down
5 changes: 5 additions & 0 deletions docs/en/appendices/5-2-migration-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "5.2 Migration Guide"
description: "Migrate to CakePHP 5.2: understand new features, deprecations, breaking changes, and upgrade your application from 5.0/5.1 smoothly."
---

# 5.2 Migration Guide

The 5.2.0 release is backwards compatible with 5.0. It adds new functionality
Expand Down
5 changes: 5 additions & 0 deletions docs/en/appendices/5-3-migration-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "5.3 Migration Guide"
description: "Upgrade to CakePHP 5.3: discover new features, deprecations, improvements, and migrate from 5.0-5.2 with this detailed guide."
---

# 5.3 Migration Guide

The 5.3.0 release is backwards compatible with 5.0. It adds new functionality
Expand Down
5 changes: 5 additions & 0 deletions docs/en/appendices/cakephp-development-process.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "CakePHP Development Process"
description: "Understand CakePHP development: release cycles, semantic versioning, contribution workflow, and how the framework evolves over time."
---

# CakePHP Development Process

CakePHP projects broadly follow [semver](https://semver.org/). This means that:
Expand Down
37 changes: 19 additions & 18 deletions docs/en/appendices/glossary.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,34 @@
# Glossary
---
title: "Glossary"
description: "CakePHP terminology reference: understand common abbreviations, technical terms, and framework-specific vocabulary used in documentation."
---

<div class="glossary">
# Glossary

CDN
## CDN
Content Delivery Network. A 3rd party vendor you can pay to help
distribute your content to data centers around the world. This helps
put your static assets closer to geographically distributed users.

columns
## columns
Used in the ORM when referring to the table columns in an database
table.

CSRF
## CSRF
Cross Site Request Forgery. Prevents replay attacks, double
submissions and forged requests from other domains.

DI Container
## DI Container
In `Application::services()` you can configure application services
and their dependencies. Application services are automatically injected
into Controller actions, and Command Constructors. See
[Dependency Injection](../development/dependency-injection).

DSN
## DSN
Data Source Name. A connection string format that is formed like a URI.
CakePHP supports DSNs for Cache, Database, Log and Email connections.

dot notation
## dot notation
Dot notation defines an array path, by separating nested levels with `.`
For example:

Expand All @@ -43,17 +46,17 @@ Would point to the following value:
]
```

DRY
## DRY
Don't repeat yourself. Is a principle of software development aimed at
reducing repetition of information of all kinds. In CakePHP DRY is used
to allow you to code things once and re-use them across your
application.

fields
## fields
A generic term used to describe both entity properties, or database
columns. Often used in conjunction with the FormHelper.

HTML attributes
## HTML attributes
An array of key => values that are composed into HTML attributes. For example:

``` php
Expand All @@ -75,15 +78,15 @@ can be used:
checked="checked"
```

PaaS
## PaaS
Platform as a Service. Platform as a Service providers will provide
cloud based hosting, database and caching resources. Some popular
providers include Heroku, EngineYard and PagodaBox

properties
## properties
Used when referencing columns mapped onto an ORM entity.

plugin syntax
## plugin syntax
Plugin syntax refers to the dot separated class name indicating classes
are part of a plugin:

Expand All @@ -95,18 +98,16 @@ are part of a plugin:
'AcmeCorp/Tools.Toolbar'
```

routes.php
## routes.php
A file in the `config/` directory that contains routing configuration.
This file is included before each request is processed.
It should connect all the routes your application needs so
requests can be routed to the correct controller + action.

routing array
## routing array
An array of attributes that are passed to `Router::url()`.
They typically look like:

``` php
['controller' => 'Posts', 'action' => 'view', 5]
```

</div>
5 changes: 5 additions & 0 deletions docs/en/appendices/migration-guides.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Migration Guides"
description: "Upgrade CakePHP versions: follow migration guides for each release, understand breaking changes, and smoothly transition between versions."
---

# Migration Guides

Migration guides contain information regarding the new features introduced in
Expand Down
5 changes: 5 additions & 0 deletions docs/en/appendices/phpunit-upgrade.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "PHPUnit Upgrade"
description: "Upgrade PHPUnit in CakePHP 5.x: migrate tests to PHPUnit 11+, update assertions, configure test suites, and maintain compatibility."
---

# PHPUnit Upgrade

This guide covers the PHPUnit version requirements and migration steps for CakePHP 5.x applications.
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Console Commands"
description: "Build CLI tools with CakePHP console framework: create commands, handle I/O, use option parsers, schedule cron jobs, and manage application tasks."
---

# Console Commands

In addition to a web framework, CakePHP also provides a console framework for
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/cache.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Cache Tool"
description: "Manage cache from CLI in CakePHP: clear all caches, specific cache configs, and maintain cached data via console commands."
---

# Cache Tool

To help you better manage cached data from a CLI environment, a console command
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/commands.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Command Objects"
description: "Create CakePHP commands: build custom CLI tools, handle arguments, implement execute logic, and automate development tasks efficiently."
---

# Command Objects

`class` Cake\\Console\\**Command**
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/completion.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Completion Tool"
description: "Enable CakePHP CLI autocompletion: install shell completion, configure for bash/zsh, and improve developer experience with command suggestions."
---

# Completion Tool

Working with the console gives the developer a lot of possibilities but having
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/counter-cache.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "CounterCache Tool"
description: "Rebuild counter caches in CakePHP: use CLI tool to recalculate cached counts, fix data inconsistencies, and maintain counter cache integrity."
---

# CounterCache Tool

The CounterCacheCommand provides a CLI tool for rebuilding the counter caches
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/cron-jobs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Running Shells as Cron Jobs"
description: "Schedule CakePHP commands: run console commands as cron jobs, automate tasks, configure scheduling, and manage periodic operations."
---

# Running Shells as Cron Jobs

A common thing to do with a shell is making it run as a cronjob to
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/i18n.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "I18N Tool"
description: "Extract translations in CakePHP: generate PO files, extract translatable strings, integrate with Poedit, and manage i18n via CLI."
---

# I18N Tool

The i18n features of CakePHP use [po files](https://en.wikipedia.org/wiki/GNU_gettext)
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/input-output.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Command Input/Output"
description: "Handle CLI I/O in CakePHP: format console output, create progress bars, prompt users, display tables, and style terminal text."
---

# Command Input/Output

`class` Cake\\Console\\**ConsoleIo**
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/option-parsers.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Option Parsers"
description: "Parse CLI options in CakePHP: define command arguments, options, subcommands, help text, and validate console input effectively."
---

# Option Parsers

`class` Cake\\Console\\**ConsoleOptionParser**
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/plugin.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Plugin Tool"
description: "Manage plugins via CLI in CakePHP: load/unload plugins, configure hooks, enable features, and manage plugin dependencies from terminal."
---

<a id="plugin-shell"></a>

# Plugin Tool
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/repl.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Interactive Console (REPL)"
description: "Explore CakePHP interactively: use REPL console to test code, inspect objects, debug queries, and experiment with application logic."
---

# Interactive Console (REPL)

CakePHP offers
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/routes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Routes Tool"
description: "Debug CakePHP routes: test URL parsing, check route matches, inspect routing configuration, and troubleshoot request routing issues via CLI."
---

# Routes Tool

The routes tool provides a simple to use CLI interface for testing and debugging
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/schema-cache.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Schema Cache Tool"
description: "Manage schema caches in CakePHP: clear, build, warm up metadata caches via CLI to improve ORM performance and reduce queries."
---

# Schema Cache Tool

The SchemaCacheCommand provides a simple CLI tool for managing your application's
Expand Down
5 changes: 5 additions & 0 deletions docs/en/console-commands/server.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Server Tool"
description: "Run development server in CakePHP: use built-in PHP webserver, configure host/port, and quickly test applications locally via CLI."
---

# Server Tool

The `ServerCommand` lets you stand up a simple webserver using the built in PHP
Expand Down
5 changes: 5 additions & 0 deletions docs/en/contributing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Contributing"
description: "Join CakePHP development: contribute code, documentation, report bugs, follow coding standards, submit pull requests, and help build the framework."
---

# Contributing

There are a number of ways you can contribute to CakePHP. The following sections
Expand Down
5 changes: 5 additions & 0 deletions docs/en/contributing/backwards-compatibility.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Backwards Compatibility Guide"
description: "Understand CakePHP backwards compatibility: semantic versioning promises, interface stability, class changes, and upgrade guidelines per release."
---

# Backwards Compatibility Guide

Ensuring that you can upgrade your applications easily and smoothly is important
Expand Down
Loading