CakePHP

https://github.com/cakephp/cakephp
Admin
CakePHP is a rapid development framework for PHP that uses MVC patterns and conventions over...
Tokens:602,155
Snippets:4,412
Trust Score:7.5
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Define entry point script bin/tool.php

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Console/README.md

Create an entry point script that builds a CommandRunner with your Application and executes it with the provided arguments.

```php
#!/usr/bin/php -q
<?php
// Check platform requirements
require dirname(__DIR__) . '/vendor/autoload.php';

use App\Application;
use Cake\Console\CommandRunner;

// Build the runner with an application and root executable name.
$runner = new CommandRunner(new Application(), 'tool');
exit($runner->run($argv));
```

--------------------------------

### Install CakePHP Console via Composer

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Console/README.md

Install the cakephp/console package using Composer in your project.

```bash
composer require cakephp/console
```

--------------------------------

### Create a new query with selectQuery()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Gets a new query builder instance from a database connection. Use this as the starting point for building SELECT queries.

```php
$query = $connection->selectQuery();
```

--------------------------------

### Define HelloCommand with option parser and execute method

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Console/README.md

Create a command that accepts a required 'name' argument and an optional 'color' option, then outputs a greeting with optional styling.

```php
<?php
namespace App\Command;

use Cake\Console\Arguments;
use Cake\Console\BaseCommand;
use Cake\Console\ConsoleIo;
use Cake\Console\ConsoleOptionParser;

class HelloCommand extends BaseCommand
{
    protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
    {
        $parser
            ->addArgument('name', [
                'required' => true,
                'help' => 'The name to say hello to',
            ])
            ->addOption('color', [
                'choices' => ['none', 'green'],
                'default' => 'none',
                'help' => 'The color to use.'
            ]);

        return $parser;
    }

    public function execute(Arguments $args, ConsoleIo $io): ?int
    {
        $color = $args->getOption('color');
        if ($color === 'none') {
            $io->out("Hello {$args->getArgument('name')}");
        } elseif ($color == 'green') {
            $io->out("<success>Hello {$args->getArgument('name')}</success>");
        }

        return static::CODE_SUCCESS;
    }
}
```

--------------------------------

### Define Application class with console method

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Console/README.md

Implement ConsoleApplicationInterface to define bootstrap logic and register commands via the console method.

```php
<?php
namespace App;

use App\Command\HelloCommand;
use Cake\Core\ConsoleApplicationInterface;
use Cake\Console\CommandCollection;

class Application implements ConsoleApplicationInterface
{
    /**
     * Load all the application configuration and bootstrap logic.
     *
     * @return void
     */
    public function bootstrap(): void
    {
        // Load configuration here. This is the first
        // method Cake\Console\CommandRunner will call on your application.
    }


    /**
     * Define the console commands for an application.
     *
     * @param \Cake\Console\CommandCollection $commands The CommandCollection to add commands into.
     * @return \Cake\Console\CommandCollection The updated collection.
     */
    public function console(CommandCollection $commands): CommandCollection
    {
        $commands->add('hello', HelloCommand::class);

        return $commands;
    }
}
```

--------------------------------

### Retrieve results by iterating or fetching

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Two ways to get results: iterate the query directly, or execute and fetch all rows as an associative array.

```php
// Iterate the query
foreach ($query as $row) {
    // Do stuff.
}

// Get the statement and fetch all results
$results = $query->execute()->fetchAll(\PDO::FETCH_ASSOC);
```

--------------------------------

### Complex conditions with closures and ExpressionInterface

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Uses a closure with an ExpressionInterface to build complex conditions. The example generates a WHERE clause with multiple AND conditions.

```php
$query->where(function (ExpressionInterface $exp) {
        return $exp
            ->eq('author_id', 2)
            ->eq('published', true)
            ->notEq('spam', true)
            ->gt('view_count', 10);
    });
```

```sql
SELECT * FROM articles
WHERE
	author_id = 2
	AND published = 1
	AND spam != 1
	AND view_count > 10
```

--------------------------------

### Starting the Http Server with index.php

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Http/README.md

Shows how to bootstrap the application and run the server from webroot/index.php.

```php
<?php
// in webroot/index.php
require dirname(__DIR__) . '/vendor/autoload.php';

use App\Application;
use Cake\Http\Server;

// Bind your application to the server.
$server = new Server(new Application());

// Run the request/response through the application and emit the response.
$server->emit($server->run());
```

--------------------------------

### Install CakePHP via Composer

Source: https://github.com/cakephp/cakephp/blob/5.x/README.md

Use this command to add the CakePHP framework to an existing PHP project. Requires Composer to be installed. For new projects, the app skeleton is recommended instead.

```bash
composer require cakephp/cakephp
```

--------------------------------

### SQL generated by update() with datetime condition

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Shows the SQL that the previous update() example generates. The condition uses the created field with datetime values.

```sql
UPDATE articles SET title = 'New Title' WHERE created >= '2014-10-10 00:00:00' AND created < '2014-10-13 00:00:00';
```

--------------------------------

### Using the Http Client for GET requests

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Http/README.md

Shows how to create a CakePHP HTTP client and perform GET requests with optional query strings and headers.

```php
use Cake\Http\Client;

$http = new Client();

// Simple get
$response = $http->get('http://example.com/test.html');

// Simple get with querystring
$response = $http->get('http://example.com/search', ['q' => 'widget']);

// Simple get with querystring & additional headers
$response = $http->get('http://example.com/search', ['q' => 'widget'], [
  'headers' => ['X-Requested-With' => 'XMLHttpRequest'],
]);
```

--------------------------------

### SQL generated by delete() with date condition

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Shows the SQL that the previous delete() example generates. The condition uses the created field with a date value.

```sql
DELETE FROM articles where created < '2014-10-10'
```

--------------------------------

### Running the server with PHP built-in webserver

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Http/README.md

Command to start the application using PHP's built-in web server.

```bash
php -S localhost:8765 -t ./webroot ./webroot/index.php
```

--------------------------------

### Format Number with Number::format

Source: https://github.com/cakephp/cakephp/blob/5.x/src/I18n/README.md

Formats a number according to the current locale. The example formats 100100100, but the output is not shown.

```php
echo Number::format(100100100);
```

--------------------------------

### Combining expressions with or() and not()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Combines expression objects using or() and not() to create negated OR conditions. The example generates a WHERE clause with NOT (author_id = 2 OR author_id = 5) AND view_count <= 10.

```php
$query->where(function (ExpressionInterface $exp) {
        $orConditions = $exp->or(['author_id' => 2])
            ->eq('author_id', 5);
        return $exp
            ->not($orConditions)
            ->lte('view_count', 10);
    });
```

```sql
SELECT *
FROM articles
WHERE
	NOT (author_id = 2 OR author_id = 5)
	AND view_count <= 10
```

--------------------------------

### Implementing HttpApplicationInterface

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Http/README.md

Minimal example of an application class implementing Cake\Http\HttpApplicationInterface with bootstrap, middleware, and handle methods.

```php
namespace App;

use Cake\Core\HttpApplicationInterface;
use Cake\Http\MiddlewareQueue;
use Cake\Http\Response;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

class Application implements HttpApplicationInterface
{
    /**
     * Load all the application configuration and bootstrap logic.
     *
     * @return void
     */
    public function bootstrap(): void
    {
        // Load configuration here. This is the first
        // method Cake\Http\Server will call on your application.
    }

    /**
     * Define the HTTP middleware layers for an application.
     *
     * @param \Cake\Http\MiddlewareQueue $middlewareQueue The middleware queue to set in your App Class
     * @return \Cake\Http\MiddlewareQueue
     */
    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
    {
        // Add middleware for your application.
        return $middlewareQueue;
    }

    /**
     * Handle incoming server request and return a response.
     *
     * @param \Psr\Http\Message\ServerRequestInterface $request The request
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        return new Response(['body'=>'Hello World!']);
    }
}
```

--------------------------------

### Xml::build from array

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Utility/README.md

Builds an XML object from an array structure representing a post.

```php
$data = [
    'post' => [
        'id' => 1,
        'title' => 'Best post',
        'body' => ' ... '
    ]
];
$xml = Xml::build($data);
```

--------------------------------

### Create MySQL and SQLite connections with Cake\Database\Connection

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Shows how to instantiate a connection object for MySQL and SQLite using the CakePHP database library. The driver class must be specified before performing any operations. The MySQL example uses database 'test', username 'root', and password 'secret'; the SQLite example uses a file path as the database.

```php
use Cake\Database\Connection;
use Cake\Database\Driver\Mysql;
use Cake\Database\Driver\Sqlite;

$connection = new Connection([
	'driver' => Mysql::class,
	'database' => 'test',
	'username' => 'root',
	'password' => 'secret',
]);

$connection2 = new Connection([
	'driver' => Sqlite::class,
	'database' => '/path/to/file.db'
]);
```

--------------------------------

### Aggregate with count()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Uses the func() method to create a COUNT(*) aggregate and aliases it as 'count'.

```php
$query->select(['count' => $query->func()->count('*')]);
```

--------------------------------

### Reuse prepared statement by rebinding values

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Prepared statements can be reused by calling bind() again with new values and then fetching rows again. The example rebinds the same value but shows the pattern.

```php
$statement = $connection->prepare('SELECT * from articles WHERE id = :id');
$statement->bind(['id' => 1], ['id' => 'integer']);
$results = $statement->fetchAll(\PDO::FETCH_ASSOC);

$statement->bind(['id' => 1], ['id' => 'integer']);
$results = $statement->fetchAll(\PDO::FETCH_ASSOC);
```

--------------------------------

### Insert rows with insert() method

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Use the connection's insert() method to add a new row. The example inserts an article with a datetime type for the created field.

```php
$connection->insert(
	'articles',
	['title' => 'My Title', 'body' => 'Some paragraph', 'created' => new DateTime()],
	['created' => 'datetime']
);
```

--------------------------------

### OR conditions

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Generates OR conditions by wrapping an array of conditions under the 'OR' key.

```php
$query->where(['OR' => ['id >' => 1, 'title' => 'My title']]);
```

--------------------------------

### Text::insert and Text::wrap

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Utility/README.md

Shows Text::insert replacing placeholders and Text::wrap wrapping text to a specified width. The wrap example returns 'This is the song\nthat never ends.'

```php
Text::insert(
    'My name is :name and I am :age years old.',
    ['name' => 'Bob', 'age' => '65']
);
// Returns: "My name is Bob and I am 65 years old."

$text = 'This is the song that never ends.';
$result = Text::wrap($text, 22);

// Returns
This is the song
that never ends.
```

--------------------------------

### Format Current Time with Time::now()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/I18n/README.md

Creates a Time instance for the current moment and echoes it. The output format depends on the current locale; the example shows '4/20/14, 10:10 PM' for en-US.

```php
$time = Time::now();
echo $time; // shows '4/20/14, 10:10 PM' for the en-US locale
```

--------------------------------

### Multiple conditions with andWhere()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Adds multiple conditions using andWhere() or by passing an array to where(). Both approaches are equivalent.

```php
$query->where(['id >' => 1])->andWhere(['title' => 'My Title']);

// Equivalent to
$query->where(['id >' => 1, 'title' => 'My title']);
```

--------------------------------

### Update rows with update() method

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Use the connection's update() method to update rows matching a condition. The example updates the title of the article with id = 1.

```php
$connection->update('articles', ['title' => 'New title'], ['id' => 1]);
```

--------------------------------

### Prepare statement manually and fetch all rows

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Use prepare() to create a statement, bind values with bind(), and fetch all rows with fetchAll(). The bind() method accepts a types array as the second parameter.

```php
$statement = $connection->prepare('SELECT * from articles WHERE id != :id');
$statement->bind(['id' => 1], ['id' => 'integer']);
$results = $statement->fetchAll(\PDO::FETCH_ASSOC);
```

--------------------------------

### Select fields with select()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Adds fields to the SELECT clause. Supports plain field names, aliases via key-value pairs, and closures for dynamic field selection.

```php
$query->select(['id', 'title', 'body']);

// Results in SELECT id AS pk, title AS aliased_title, body ...
$query->select(['pk' => 'id', 'aliased_title' => 'title', 'body']);

// Use a closure
$query->select(function ($query) {
	return ['id', 'title', 'body'];
});
```

--------------------------------

### Format Currency with Number::currency

Source: https://github.com/cakephp/cakephp/blob/5.x/src/I18n/README.md

Formats a number as currency in the specified currency code. The example formats 123456.7890 as EUR and outputs €123,456.79.

```php
echo Number::currency(123456.7890, 'EUR');
// outputs €123,456.79
```

--------------------------------

### Reading Data with CakePHP ORM

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Use the LocatorAwareTrait to get a table object and iterate over query results. This example fetches all articles and prints their titles.

```php
use Cake\ORM\Locator\LocatorAwareTrait;

$articles = $this->getTableLocator()->get('Articles');
foreach ($articles->find() as $article) {
	echo $article->title;
}
```

--------------------------------

### Inflector pluralize and singularize

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Utility/README.md

Demonstrates pluralizing 'Apple' to 'Apples' and singularizing 'People' to 'Person'.

```php
echo Inflector::pluralize('Apple'); // echoes Apples

echo Inflector::singularize('People'); // echoes Person
```

--------------------------------

### Execute SELECT query with execute() and fetch rows

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Use the connection's execute() method to run a raw SQL query and fetch rows as an associative array. The returned statement implements Cake\Database\StatementInterface.

```php
$statement = $connection->execute('SELECT * FROM articles');

while($row = $statement->fetch(\PDO::FETCH_ASSOC)) {
	echo $row['title'] . PHP_EOL;
}
```

--------------------------------

### Security::encrypt and Security::decrypt

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Utility/README.md

Encrypts a value with a key and then decrypts it back. The key is a sample string.

```php
$key = 'wt1U5MACWJFTXGenFoZoiLwQGrLgdbHA';
$result = Security::encrypt($value, $key);

Security::decrypt($result, $key);
```

--------------------------------

### Update rows with datetime types

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Pass a types array as the last parameter to update() to specify how values should be converted. The example uses a datetime type for the created field.

```php
$connection->update(
	'articles',
	['title' => 'New title'],
	['created >=' => new DateTime('-3 day'), 'created <' => new DateTime('now')],
	['created' => 'datetime']
);
```

--------------------------------

### Translate a Message with __()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/I18n/README.md

Translates a message using the __() function with ICU message formatting. The example shows placeholders for string, date, and currency, and the expected output for the en-US locale.

```php
echo __(
    'Hi {0,string}, your balance on the {1,date} is {2,number,currency}',
    ['Charles', '2014-01-13 11:12:00', 1354.37]
);

// Returns
Hi Charles, your balance on the Jan 13, 2014, 11:12 AM is $ 1,354.37
```

--------------------------------

### Delete rows with delete() method

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Use the connection's delete() method to remove rows matching a condition. The example deletes articles created before now, using a date type.

```php
$connection->delete('articles', ['created <' => DateTime('now')], ['created' => 'date']);
```

--------------------------------

### Basic where conditions

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Generates WHERE conditions. Operators can be specified by appending them to the field name with a space (e.g., 'id >').

```php
// WHERE id = 1
$query->where(['id' => 1]);

// WHERE id > 1
$query->where(['id >' => 1]);
```

--------------------------------

### Execute parametrized query with execute() and types

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Bind values to named parameters in execute() using an array of values and an array of types. Without types, all arguments are interpreted as strings.

```php
$statement = $connection->execute('SELECT * FROM articles WHERE id = :id', ['id' => 1], ['id' => 'integer']);
$results = $statement->fetch(\PDO::FETCH_ASSOC);
```

--------------------------------

### Create Custom Translator with I18n::translator

Source: https://github.com/cakephp/cakephp/blob/5.x/src/I18n/README.md

Registers a custom translator for the 'animals' domain in French (fr_FR) using a Package with ICU formatting. The example includes a partial message list and shows how to use __d() to retrieve a translation.

```php
use Cake\I18n\I18n;
use Cake\I18n\Package;

I18n::translator('animals', 'fr_FR', function () {
    $package = new Package(
        'default', // The formatting strategy (ICU)
        'default', // The fallback domain
    );
    $package->setMessages([
        'Dog' => 'Chien',
        'Cat' => 'Chat',
        'Bird' => 'Oiseau'
        ...
    ]);

    return $package;
});

I18n::getLocale('fr_FR');
__d('animals', 'Dog'); // Returns "Chien"
```

--------------------------------

### Store and read configuration with Configure::write and Configure::read

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Core/README.md

Use the Configure class to store arbitrary configuration data. The example writes a value and then reads it back, returning 'Pizza, Inc.'.

```php
use Cake\Core\Configure;
use Cake\Core\Configure\Engine\PhpConfig;

Configure::write('Company.name','Pizza, Inc.');
Configure::read('Company.name'); // Returns: 'Pizza, Inc.'
```

--------------------------------

### Build and run PHP-FPM image locally

Source: https://github.com/cakephp/cakephp/blob/5.x/docker/php-fpm/README.md

Builds the PHP-FPM image with PHP 8.5 and runs it to list installed PHP modules. Use this to verify the image locally before publishing.

```sh
docker build --build-arg PHP_IMAGE_TAG=8.5-fpm-alpine -t cakephp-php-fpm:8.5 docker/php-fpm
```

```sh
docker run --rm cakephp-php-fpm:8.5 php -m
```

--------------------------------

### Define services with concrete classes, shared instances, and interface mappings

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Container/README.md

Creates a PSR-11 compatible container and demonstrates adding a concrete class, a shared singleton via a factory function, and an interface-to-class mapping. The example then retrieves the BillingService instance. Requires the CakePHP Container library and the referenced service classes.

```php
use App\Service\AuditLogService;
use App\Service\AuditLogServiceInterface;
use App\Service\ApiClient;
use App\Service\BillingService;
use Cake\Container\Container;

$container = new Container();

// Add a concrete class.
$container->add(BillingService::class);

// Add a singleton service.
$container->addShared('apiClient', fn () => new ApiClient('https://example.com'));

// Add an implementation for an interface.
$container->add(AuditLogServiceInterface::class, AuditLogService::class);

$billing = $container->get(BillingService::class);
```

--------------------------------

### SQL function with literal and bound parameters

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Database/README.md

Creates a CONCAT function using a literal column reference and a bound parameter. The literal is marked with 'literal', and the bound parameter is auto-generated (e.g., :c0).

```php
$concat = $query->func()->concat([
    'title' => 'literal',
    ' NEW'
]);
$query->select(['title' => $concat]);
```

```sql
SELECT CONCAT(title, :c0) ...;
```

--------------------------------

### Configure Path to PO Files with App.paths.locales

Source: https://github.com/cakephp/cakephp/blob/5.x/src/I18n/README.md

Sets the folder path where translation PO files are located. The path must end with a trailing slash. Refer to the CakePHP Manual for expected folder structure and file naming.

```php
use Cake\Core\Configure;

Configure::write('App.paths.locales', ['/path/with/trailing/slash/']);
```

--------------------------------

### Hash::extract with age filter DSL

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Utility/README.md

Extracts names from an array of people where age is greater than 21 using the Hash DSL. The result is ['Susan', 'Lucy'].

```php
$things = [
    ['name' => 'Mark', 'age' => 15],
    ['name' => 'Susan', 'age' => 30],
    ['name' => 'Lucy', 'age' => 25]
];

$bigPeople = Hash::extract($things, '{n}[age>21].name');

// $bigPeople will contain ['Susan', 'Lucy']
```

--------------------------------

### Write log message with Log::write

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Log/README.md

Sends a message to all logging engines subscribed to the specified log level. In this example, only the 'local' engine receives the message because it subscribes to 'debug'.

```php
Log::write('debug', 'Something did not work');
```

--------------------------------

### Use LocatorAwareTrait for easy table access

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Uses the LocatorAwareTrait to get a table instance via the getTableLocator() method. By default, classes using this trait share a global locator instance.

```php
use Cake\ORM\Locator\LocatorAwareTrait;

$articles = $this->getTableLocator()->get('Articles');
```

--------------------------------

### Set Current Locale with I18n::setLocale

Source: https://github.com/cakephp/cakephp/blob/5.x/src/I18n/README.md

Sets the current locale to 'en_US' using the I18n service locator. This is the first step for internationalizing your application.

```php
use Cake\I18n\I18n;

I18n::setLocale('en_US');
```

--------------------------------

### Read and Write Cache with Cache::remember()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Cache/README.md

Use Cache::remember() to retrieve data under a key, executing the callback if the key is not found and caching the returned data for future calls. The example uses 'my_cache_key' and a callback that calls Service::expensiveCall().

```php
$data = Cache::remember('my_cache_key', function () {
	return Service::expensiveCall();
});
```

--------------------------------

### Define a custom form class with schema, validation, and execution

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Form/README.md

Extend Cake\Form\Form and implement the three hook methods: _buildSchema() to define fields, validationDefault() to attach validators, and _execute() to handle valid data. The example shows a contact form with name, email, and body fields, requiring a minimum name length and a valid email format.

```php
use Cake\Form\Form;
use Cake\Form\Schema;
use Cake\Validation\Validator;

class ContactForm extends Form
{

    protected function _buildSchema(Schema $schema)
    {
        return $schema->addField('name', 'string')
            ->addField('email', ['type' => 'string'])
            ->addField('body', ['type' => 'text']);
    }

    public function validationDefault(Validator $validator)
    {
        return $validator->add('name', 'length', [
                'rule' => ['minLength', 10],
                'message' => 'A name is required'
            ])->add('email', 'format', [
                'rule' => 'email',
                'message' => 'A valid email address is required',
            ]);
    }

    protected function _execute(array $data)
    {
        // Send an email.
        return true;
    }
}
```

--------------------------------

### Saving Data with Associations in CakePHP ORM

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Marshal request data into an entity with associated records (Tags and Comments) and save it. The example shows how to pass associated data and save the entity along with its associations.

```php
use Cake\ORM\Locator\LocatorAwareTrait;

$data = [
	'title' => 'My first article',
	'body' => 'It is a great article',
	'user_id' => 1,
	'tags' => [
		'_ids' => [1, 2, 3]
	],
	'comments' => [
		['comment' => 'Good job'],
		['comment' => 'Awesome work'],
	]
];

$articles = $this->getTableLocator()->get('Articles');
$article = $articles->newEntity($data, [
	'associated' => ['Tags', 'Comments']
]);
$articles->save($article, [
	'associated' => ['Tags', 'Comments']
])
```

--------------------------------

### Fetch a connection with ConnectionManager::get()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Datasource/README.md

Retrieves a configured connection by name. The manager constructs and loads the connection if it hasn't been built yet, otherwise returns the existing instance.

```php
use Cake\Datasource\ConnectionManager;
$conn = ConnectionManager::get('master');
```

--------------------------------

### Load configuration from external files with Configure::config and Configure::load

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Core/README.md

Load configuration from external files by first configuring a PhpConfig engine with a folder path, then loading files. The third argument to Configure::load is optional; passing false prevents the configuration from being merged with existing data.

```php
Configure::config('default', new PhpConfig('/path/to/config/folder'));
Configure::load('app', 'default', false);
Configure::load('other_config', 'default');
```

--------------------------------

### Configure metadata cache with FileEngine

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Recommended for production to avoid performance issues. Uses Cake\Cache\Engine\FileEngine with a one-year duration and serialization. Requires the cachephp/cache package.

```php
use Cake\Cache\Engine\FileEngine;

$cacheConfig = [
   'className' => FileEngine::class,
   'duration' => '+1 year',
   'serialize' => true,
   'prefix'    => 'orm_',
];
Cache::setConfig('_cake_model_', $cacheConfig);
```

--------------------------------

### Write configuration back to files with Configure::dump

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Core/README.md

Use Configure::dump to write the current configuration back into a file using the specified engine.

```php
Configure::dump('my_config', 'default');
```

--------------------------------

### Configure loggers with Log::setConfig

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Log/README.md

Defines two logging engines: 'local' using the File engine with levels notice, info, debug, and 'production' using the fully namespaced SyslogLog engine with higher severity levels. Use this to set up multiple backends for different log levels.

```php
use Cake\Log\Log;

// Short classname
Log::setConfig('local', [
    'className' => 'File',
    'levels' => ['notice', 'info', 'debug'],
    'file' => '/path/to/file.log',
]);

// Fully namespaced name.
Log::setConfig('production', [
    'className' => \Cake\Log\Engine\SyslogLog::class,
    'levels' => ['warning', 'error', 'critical', 'alert', 'emergency'],
]);
```

--------------------------------

### Configure connections with ConnectionManager::config()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Datasource/README.md

Registers two named connections with the ConnectionManager, passing custom parameters that will be supplied to the connection class constructor. Use this to set up multiple data source connections for your application.

```php
use Cake\Datasource\ConnectionManager;

ConnectionManager::config('connection-one', [
    'className' => 'MyApp\Connections\CustomConnection',
    'param1' => 'value',
    'param2' => 'another value'
]);

ConnectionManager::config('connection-two', [
    'className' => 'MyApp\Connections\CustomConnection',
    'param1' => 'different value',
    'param2' => 'another value'
]);
```

--------------------------------

### Dispatch and listen to an event with EventDispatcherTrait

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Event/README.md

Shows how to dispatch an event using the EventDispatcherTrait and register a listener with the manager's on() method. The event object carries data and can stop propagation. Useful for notifying other parts of the application after an action like placing an order.

```php
use Cake\Event\Event;
use Cake\Event\EventDispatcherTrait;

class Orders
{

	use EventDispatcherTrait;

	public function placeOrder($order)
	{
		$this->doStuff();
		$event = new Event('Orders.afterPlace', $this, [
			'order' => $order
		]);
		$this->getEventManager()->dispatch($event);
	}
}

$orders = new Orders();
$orders->getEventManager()->on(function ($event) {
	// Do something after the order was placed
	...
}, 'Orders.afterPlace');

$orders->placeOrder($order);
```

--------------------------------

### Store a connection instance with ConnectionManager::config()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Datasource/README.md

Registers an existing connection object directly with the manager by passing the instance instead of a configuration array. This allows you to store pre-built connections for later retrieval.

```php
use Cake\Datasource\ConnectionManager;
$conn = ConnectionManager::config('other', $connectionInstance);
```

--------------------------------

### Create logger with closure

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Log/README.md

Creates a logger by providing a closure that returns any PSR-3 compatible logger instance. Useful for custom logger instantiation logic.

```php
Log::setConfig('special', function () {
	// Return any PSR-3 compatible logger
	return new MyPSR3CompatibleLogger();
});
```

--------------------------------

### Copy text to clipboard with fallback

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Error/Debug/dumpHeader.html

Creates a temporary textarea, selects its content, and uses document.execCommand('copy') to copy the given string. Restores the previous selection range after copying. Based on a 30secondsofcode snippet.

```JavaScript
function copyToClipboard (str) { let el = document.createElement('textarea'); el.value = str; el.setAttribute('readonly', ''); el.style.position = 'absolute'; el.style.left = '-9999px'; document.body.appendChild(el); let selected = document.getSelection().rangeCount > 0 ? document.getSelection().getRangeAt(0) : false; el.select(); document.execCommand('copy'); document.body.removeChild(el); if (selected) { document.getSelection().removeAllRanges(); document.getSelection().addRange(selected); } }
```

--------------------------------

### Configure Cache with Cache::config()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Cache/README.md

Configure caching engines using the Cache::config() method. Supports short names, fully namespaced class names, and constructed objects. The 'default' configuration uses the File engine with a duration of '+1 hours' and a prefix 'my_app_'. The 'long' configuration uses ApcuEngine with a duration of '+1 week'. The 'other' configuration uses a constructed FileEngine object.

```php
use Cake\Cache\Cache;

// Using a short name
Cache::config('default', [
    'className' => 'File',
    'duration' => '+1 hours',
    'path' => sys_get_tmp_dir(),
    'prefix' => 'my_app_'
]);

// Using a fully namespaced name.
Cache::config('long', [
    'className' => \Cake\Cache\Engine\ApcuEngine::class,
    'duration' => '+1 week',
    'prefix' => 'my_app_'
]);

// Using a constructed object.
$object = new FileEngine($config);
Cache::config('other', $object);
```

--------------------------------

### Set App.namespace for conventions-based loading

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Configures the application namespace so the ORM can locate custom table and entity classes under the Model sub-namespace.

```php
<?php
use Cake\Core\Configure;

Configure::write('App.namespace', 'Acme');
```

--------------------------------

### Inject logger instance directly

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Log/README.md

Configures a logger by injecting an instance directly, bypassing the need for a closure or class name.

```php
Log::setConfig('special', new MyPSR3CompatibleLogger());
```

--------------------------------

### Load custom table class with TableLocator

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Instantiates a TableLocator and retrieves the custom ArticlesTable by specifying its class name.

```php
<?php
use Acme\Data\Table\ArticlesTable;
use Cake\ORM\Locator\TableLocator;

$locator = new TableLocator();
$articles = $locator->get('Articles', ['className' => ArticlesTable::class]);
```

--------------------------------

### Create a Collection and Filter Elements

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Collection/README.md

Shows how to instantiate a Collection from an array and use the filter() method to create a new collection containing only elements with a value greater than one. The CollectionTrait can also integrate collection-like features into any Traversable object.

```php
use Cake\Collection\Collection;

$items = ['a' => 1, 'b' => 2, 'c' => 3];
$collection = new Collection($items);

// Create a new collection containing elements
// with a value greater than one.
$overOne = $collection->filter(function ($value, $key, $iterator) {
    return $value > 1;
});
```

--------------------------------

### Custom table class with entity and association

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Defines a custom Table subclass in the Data folder, setting the entity class and a belongsTo association. Connects to the 'articles' table and returns Article instances.

```php
<?php
// in src/Data/Table/ArticlesTable.php
namespace Acme\Data\Table;

use Acme\Data\Entity\Article;
use Acme\Data\Table\UsersTable;
use Cake\ORM\Table;

class ArticlesTable extends Table
{
    public function initialize()
    {
        $this->setEntityClass(Article::class);
        $this->belongsTo('Users', ['className' => UsersTable::class]);
    }
}
```

--------------------------------

### Set longer App.namespace for nested Model folder

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Allows a longer namespace up to the location of the Model folder, e.g., 'My\Log\SubNamespace'.

```php
<?php
use Cake\Core\Configure;

Configure::write('App.namespace', 'My\Log\SubNamespace');
```

--------------------------------

### Inject a custom TableLocator into an object

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Shows how to inject your own TableLocator instance into an object that uses LocatorAwareTrait, overriding the default global locator. After injection, getTableLocator() returns the custom instance.

```php
use Cake\ORM\Locator\TableLocator;
use Cake\ORM\Locator\LocatorAwareTrait;

$locator = new TableLocator();
$this->setTableLocator($locator);

$articles = $this->getTableLocator()->get('Articles');
```

--------------------------------

### Register a default database connection with ConnectionManager::setConfig

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Registers a 'default' connection using the MySQL driver. Once registered, all Table mappers use this connection unless an explicit one is defined. The configuration includes database name, username, password, cacheMetadata, and quoteIdentifiers options.

```php
use Cake\Datasource\ConnectionManager;

ConnectionManager::setConfig('default', [
	'className' => \Cake\Database\Connection::class,
	'driver' => \Cake\Database\Driver\Mysql::class,
	'database' => 'test',
	'username' => 'root',
	'password' => 'secret',
	'cacheMetadata' => true,
	'quoteIdentifiers' => false,
]);
```

--------------------------------

### Access table instances using TableLocator

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Creates a new TableLocator instance and retrieves the 'Articles' table. This is the standard way to access table objects when you need a custom locator.

```php
use Cake\ORM\Locator\TableLocator;

$locator = new TableLocator();
$articles = $locator->get('Articles');
```

--------------------------------

### Attach copy buttons to debug containers

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Error/Debug/dumpHeader.html

Adds a 'Copy' link to each container node. On click, it copies the container's text content (excluding the button text) to the clipboard, optionally prefixing with the line number from the parent .cake-debug span. The button is styled with .cake-debug-copy.

```JavaScript
function attachCopyButton(nodes) { nodes.forEach(function (container) { let copy = doc.createElement('a'); copy.classList.add('cake-debug-copy'); copy.setAttribute('href', '#'); copy.setAttribute('title', 'Copy contents of debug output'); copy.appendChild(doc.createTextNode('Copy')); // Add copy behavior copy.addEventListener('click', function (event) { event.preventDefault(); event.stopPropagation(); let lineNo = ''; if (container.parentNode && container.parentNode.classList.contains('cake-debug')) { let line = container.parentNode.querySelector('span'); lineNo = line.textContent + "\n"; } // Chop off last 4 to exclude copy button text. copyToClipboard(lineNo + container.textContent.substring(0, container.textContent.length - 4)); }); container.appendChild(copy); }); }
```

--------------------------------

### Execute the form and retrieve errors

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Form/README.md

Instantiate the custom form class and call execute() with the data array. The method returns a boolean success flag, and getErrors() provides validation errors if the data is invalid.

```php
$contact = new ContactForm();
$success = $contact->execute($data);
$errors = $contact->getErrors();
```

--------------------------------

### Delete an entity with Table::delete()

Source: https://github.com/cakephp/cakephp/blob/5.x/src/ORM/README.md

Deletes a record by fetching an entity and passing it to the table's delete() method. Requires a reference to the entity.

```php
$articles = $this->getTableLocator()->get('Articles');
$article = $articles->get(2);
$articles->delete($article);
```

--------------------------------

### Initialize debug header on DOMContentLoaded

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Error/Debug/dumpHeader.html

Registers the initialize function to run when the DOM is fully loaded, wiring up the debug header interactions.

```JavaScript
doc.addEventListener('DOMContentLoaded', initialize);
```

--------------------------------

### Expand parent debug containers on click

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Error/Debug/dumpHeader.html

Walks up the DOM from the current node to the container, expanding any collapsed cake-debug-object or cake-debug-array ancestors by clicking their .cake-debug-collapse element when dataset.open is 'false'. Used to reveal nested debug output when a child is clicked.

```JavaScript
while (true) { let parent = current.parentNode; if (parent == container) { break; } if (parent.classList.contains('cake-debug-object') || parent.classList.contains('cake-debug-array')) { expander = parent.querySelector('.cake-debug-collapse'); if (expander.dataset.open === 'false') { expander.click(); } } current = parent; }
```

--------------------------------

### Filter messages with scopes

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Log/README.md

Configures a 'payments' logger to receive only messages with the 'payments' scope, then writes a warning with that scope. Only the 'payments' engine receives the message.

```php
// Configure /logs/payments.log to receive all levels, but only
// those with `payments` scope.
Log::setConfig('payments', [
    'className' => 'File',
    'levels' => ['error', 'info', 'warning'],
    'scopes' => ['payments'],
    'file' => '/logs/payments.log',
]);

Log::warning('this gets written only to payments.log', ['scope' => ['payments']]);
```

--------------------------------

### Create a Validator and Validate POST Data

Source: https://github.com/cakephp/cakephp/blob/5.x/src/Validation/README.md

Defines validation rules for email, name, and comment fields using Cake\Validation\Validator. The validate() method returns an array of errors, which can be checked to display errors.

```php
use Cake\Validation\Validator;

$validator = new Validator();
$validator
    ->requirePresence('email')
    ->add('email', 'validFormat', [
        'rule' => 'email',
        'message' => 'E-mail must be valid'
    ])
    ->requirePresence('name')
    ->notEmptyString('name', 'We need your name.')
    ->requirePresence('comment')
    ->notEmptyString('comment', 'You need to give a comment.');

$errors = $validator->validate($_POST);
if ($errors) {
    // display errors.
}
```
Tokens:
Raw