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
2 changes: 0 additions & 2 deletions docs/en/console-commands/completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ Save the file, then restart your console.
> The target directory for the **cake** file will be
> **/usr/local/etc/bash_completion.d/**.

<a id="bash-completion-file-content"></a>

### Bash Completion file content

This is the code you need to put inside the **cake** file in the correct location
Expand Down
2 changes: 0 additions & 2 deletions docs/en/console-commands/input-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
CakePHP provides the `ConsoleIo` object to commands so that they can
interactively read user input and output information to the user.

<a id="command-helpers"></a>

## Command Helpers

Formatting console output can be tedious and lead to maintenance issues. To
Expand Down
2 changes: 0 additions & 2 deletions docs/en/contributing/backwards-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,8 +283,6 @@ value:

Will disable runtime deprecation warnings.

<a id="experimental-features"></a>

## Experimental Features

Experimental features are **not included** in the above backwards compatibility
Expand Down
4 changes: 0 additions & 4 deletions docs/en/controllers/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ chapter for each component:
- [Form Protection Component](../controllers/components/form-protection)
- [Checking HTTP Cache](../controllers/components/check-http-cache)

<a id="configuring-components"></a>

## Configuring Components

Many of the core components require configuration. One example would be
Expand Down Expand Up @@ -152,8 +150,6 @@ class PostsController extends AppController
Components are able to use [Dependency Injection](../development/dependency-injection) to receive services.
:::

<a id="creating-a-component"></a>

## Creating a Component

Suppose our application needs to perform a complex mathematical operation in
Expand Down
8 changes: 0 additions & 8 deletions docs/en/controllers/middleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,6 @@ CakePHP provides several middleware to handle common tasks in web applications:
provides configurable rate limiting to protect against abuse and ensure fair
usage of resources.

<a id="using-middleware"></a>

## Using Middleware

Middleware can be applied to your application globally, to individual
Expand Down Expand Up @@ -234,8 +232,6 @@ class Application
}
```

<a id="routing-middleware"></a>

## Routing Middleware

Routing middleware is responsible for applying your application's routes and
Expand All @@ -250,8 +246,6 @@ public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
}
```

<a id="encrypted-cookie-middleware"></a>

## Encrypted Cookie Middleware

If your application has cookies that contain data you want to obfuscate and
Expand All @@ -278,8 +272,6 @@ $middlewareQueue->add($cookies);
The encryption algorithms and padding style used by the cookie middleware are
backwards compatible with `CookieComponent` from earlier versions of CakePHP.

<a id="body-parser-middleware"></a>

## Body Parser Middleware

If your application accepts JSON, XML or other encoded request bodies, the
Expand Down
4 changes: 0 additions & 4 deletions docs/en/controllers/pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,6 @@ class ArticlesController extends AppController
When using the `SimplePaginator` you will not be able to generate page
numbers, counter data, links to the last page, or total record count controls.

<a id="paginating-multiple-queries"></a>

## Paginating Multiple Queries

You can paginate multiple models in a single controller action, using the
Expand Down Expand Up @@ -213,8 +211,6 @@ $unpublishedArticles = $this->paginate(
);
```

<a id="control-which-fields-used-for-ordering"></a>

## Control which Fields Used for Ordering

By default, sorting can be done on any non-virtual column a table has. This is
Expand Down
4 changes: 0 additions & 4 deletions docs/en/controllers/request-response.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ CakePHP's request object implements the [PSR-7
ServerRequestInterface](https://www.php-fig.org/psr/psr-7/) making it easier to
use libraries from outside of CakePHP.

<a id="request-parameters"></a>

### Request Parameters

The request exposes routing parameters through the `getParam()` method:
Expand Down Expand Up @@ -1353,8 +1351,6 @@ $this->response = $this->response->withHeader('X-CakePHP', 'yes!');
They let you interact with groups of cookies using immutable patterns, which
allow the immutability of the request and response to be preserved.

<a id="creating-cookies"></a>

### Creating Cookies

`class` Cake\\Http\\Cookie\\**Cookie**
Expand Down
2 changes: 0 additions & 2 deletions docs/en/core-libraries/caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -686,8 +686,6 @@ The required API for a CacheEngine is

`method` Cake\\Cache\\CacheEngine::**increment**($key, $offset = 1): int|false

<a id="cache-events"></a>

## Cache Events

::: info Added in version 5.3.0
Expand Down
4 changes: 0 additions & 4 deletions docs/en/core-libraries/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,6 @@ object along. The listeners will handle all the extra logic around the
possibly in separate objects and even delegating it to offline tasks if you have
the need.

<a id="tracking-events"></a>

### Tracking Events

To keep a list of events that are fired on a particular `EventManager`, you
Expand Down Expand Up @@ -527,8 +525,6 @@ be an argument of any type, we recommend passing an associative array.
The `Cake\Event\EventManager::dispatch()` method accepts an event
object as an argument and notifies all subscribed listeners.

<a id="stopping-events"></a>

### Stopping Events

Much like DOM events, you may want to stop an event to prevent additional
Expand Down
2 changes: 0 additions & 2 deletions docs/en/core-libraries/hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ to do just that.
CakePHP's Hash class can be called from any model or controller in
the same way Inflector is called. Example: `Hash::combine()`.

<a id="hash-path-syntax"></a>

## Hash Path Syntax

The path syntax described below is used by all the methods in `Hash`. Not all
Expand Down
2 changes: 0 additions & 2 deletions docs/en/core-libraries/inflector.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,8 +224,6 @@ generating code or doing work based on conventions:
Inflector::variable('apple_pie');
```

<a id="inflection-configuration"></a>

## Inflection Configuration

CakePHP's naming conventions can be really nice - you can name your database
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -516,8 +516,6 @@ I18n::setTranslator(
);
```

<a id="creating-generic-translators"></a>

### Creating Generic Translators

Configuring translators by calling `I18n::setTranslator()` for each domain and
Expand Down
6 changes: 0 additions & 6 deletions docs/en/core-libraries/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,6 @@ values in your **config/app.php** file. Errors will be displayed when debug is
`log` option to `true`. See [Configuration](../development/configuration) for more
information.

<a id="writing-to-logs"></a>

## Writing to Logs

Writing to the log files can be done in two different ways. The first
Expand Down Expand Up @@ -171,8 +169,6 @@ exception.
> When `levels` is set to an empty value in a logger's configuration, it
> will take messages of any level.

<a id="logging-scopes"></a>

### Logging Scopes

Often times you'll want to configure different logging behavior for different
Expand Down Expand Up @@ -361,8 +357,6 @@ CakePHP requires that all logging engine implement `Psr\Log\LoggerInterface`.
The class `Cake\Log\Engine\BaseLog` is an easy way to satisfy the
interface as it only requires you to implement the `log()` method.

<a id="logging-formatters"></a>

## Logging Formatters

Logging formatters allow you to control how log messages are formatted
Expand Down
6 changes: 0 additions & 6 deletions docs/en/core-libraries/validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ The validation package in CakePHP provides features to build validators that can
validate arbitrary arrays of data with ease. You can find a [list of available
Validation rules in the API](https://api.cakephp.org/5.x/class-Cake.Validation.Validation.html).

<a id="creating-validators"></a>

## Creating Validators

`class` Cake\\Validation\\**Validator**
Expand Down Expand Up @@ -244,8 +242,6 @@ $validator->add('length', 'custom', [
]);
```

<a id="conditional-validation"></a>

### Conditional Validation

When defining validation rules, you can use the `on` key to define when
Expand Down Expand Up @@ -374,8 +370,6 @@ When enabled all fields will stop validation on the first failing rule instead
of checking all possible rules. In this case only a single error message will
appear under the form field.

<a id="adding-validation-providers"></a>

### Adding Validation Providers

The `Validator`, `ValidationSet` and `ValidationRule` classes do not
Expand Down
8 changes: 0 additions & 8 deletions docs/en/development/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ Configure::load('app', 'default', false);
Configure::load('other_config', 'default');
```

<a id="environment-variables"></a>

## Environment Variables

Many modern cloud providers, like Heroku, let you define environment
Expand Down Expand Up @@ -78,8 +76,6 @@ $debug = env('APP_DEBUG', false);
The second value passed to the env function is the default value. This value
will be used if no environment variable exists for the given key.

<a id="general-configuration"></a>

### General Configuration

Below is a description of the variables and how they affect your CakePHP
Expand Down Expand Up @@ -229,8 +225,6 @@ handling in CakePHP.
See the [Routes Configuration](../development/routing#routes-configuration) for more information
on configuring routing and creating routes for your application.

<a id="additional-class-paths"></a>

## Additional Class Paths

Additional class paths are setup through the autoloaders your application uses.
Expand Down Expand Up @@ -465,8 +459,6 @@ files with that engine would fail:
Configure::drop('default');
```

<a id="loading-configuration-files"></a>

### Loading Configuration Files

`static` Cake\\Core\\Configure::**load**(string $key, string $config = 'default', bool $merge = true): bool
Expand Down
2 changes: 0 additions & 2 deletions docs/en/development/dependency-injection.md
Original file line number Diff line number Diff line change
Expand Up @@ -725,8 +725,6 @@ class BillingServiceProvider extends ServiceProvider
}
```

<a id="mocking-services-in-tests"></a>

## Mocking Services in Tests

In tests that use `ConsoleIntegrationTestTrait` or `IntegrationTestTrait`
Expand Down
4 changes: 0 additions & 4 deletions docs/en/development/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,6 @@ message, file and line (`debug` enabled).
> If you use a custom error handler, the supported options will
> depend on your handler.

<a id="deprecation-warnings"></a>

## Deprecation Warnings

CakePHP uses deprecation warnings to indicate when features have been
Expand Down Expand Up @@ -236,8 +234,6 @@ class ErrorController extends AppController
Exception specific controller methods and templates were added.
:::

<a id="custom-exceptionrenderer"></a>

## Custom ExceptionRenderer

If you want to control the entire exception rendering and logging process you
Expand Down
14 changes: 0 additions & 14 deletions docs/en/development/routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,8 +288,6 @@ will go to the 'update' action. There are HTTP helper methods for:
All of these methods return the route instance allowing you to leverage the
[fluent setters](#route-fluent-methods) to further configure your route.

<a id="route-elements"></a>

### Route Elements

You can specify your own route elements and doing so gives you the
Expand Down Expand Up @@ -679,8 +677,6 @@ Router::url(['_name' => 'contacts:api:ping']);
Routes connected in named scopes will only have names added if the route is also
named. Nameless routes will not have the `_namePrefix` applied to them.

<a id="prefix-routing"></a>

### Prefix Routing

`static` Cake\\Routing\\RouteBuilder::**prefix**($name, $callback)
Expand Down Expand Up @@ -1035,8 +1031,6 @@ $this->Html->link(
);
```

<a id="route-scoped-middleware"></a>

## Route Scoped Middleware

While Middleware can be applied to your entire application, applying middleware
Expand Down Expand Up @@ -1347,8 +1341,6 @@ $routes->scope('/', function (RouteBuilder $routes) {
});
```

<a id="passed-arguments"></a>

## Passed Arguments

Passed arguments are additional arguments or path segments that are
Expand Down Expand Up @@ -1644,8 +1636,6 @@ To generate asset URLs for files in plugins use `plugin syntax`:
$img = Asset::imageUrl('DebugKit.cake.png');
```

<a id="redirect-routing"></a>

## Redirect Routing

Redirect routing allows you to issue HTTP status 30x redirects for
Expand Down Expand Up @@ -1684,8 +1674,6 @@ $routes->scope('/', function (RouteBuilder $routes) {
This would redirect `/articles/*` to `http://google.com` with a
HTTP status of 302.

<a id="entity-routing"></a>

## Entity Routing

Entity routing allows you to use an entity, an array or object implement
Expand Down Expand Up @@ -1759,8 +1747,6 @@ class MyRedirectRoute extends Route
`RedirectTrait` was added.
:::

<a id="custom-route-classes"></a>

## Custom Route Classes

Custom route classes allow you to extend and change how individual routes parse
Expand Down
2 changes: 0 additions & 2 deletions docs/en/development/sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ requests and store persistent data for specific users. Unlike Cookies, session
data is not available on the client side. Usage of `$_SESSION` is generally
avoided in CakePHP, and instead usage of the Session classes is preferred.

<a id="session-configuration"></a>

## Session Configuration

Session configuration is generally defined in **/config/app.php**. The available
Expand Down
4 changes: 0 additions & 4 deletions docs/en/development/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,6 @@ the creation of new bugs.
> multiple tests at once, you will lose your event listeners that were
> registered in config/bootstrap.php as the bootstrap is only executed once.

<a id="running-tests"></a>

## Running Tests

Once you have PHPUnit installed and some test cases written, you'll want to run
Expand Down Expand Up @@ -1911,8 +1909,6 @@ indicating 1 pass and 4 assertions.
When you are testing a Helper which uses other helpers, be sure to mock the
View clases `loadHelpers` method.

<a id="testing-events"></a>

## Testing Events

The [Events System](../core-libraries/events) is a great way to decouple your application
Expand Down
2 changes: 0 additions & 2 deletions docs/en/orm/associations.md
Original file line number Diff line number Diff line change
Expand Up @@ -656,8 +656,6 @@ INNER JOIN articles_tags ON (
);
```

<a id="using-the-through-option"></a>

### Using the 'through' Option

If you plan on adding extra information to the join/pivot table, or if you need
Expand Down
2 changes: 0 additions & 2 deletions docs/en/orm/behaviors/translate.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,8 +481,6 @@ Setting the language directly in the table is useful when you need to both
retrieve and save entities for the same language or when you need to save
multiple entities at once.

<a id="saving-multiple-translations"></a>

## Saving Multiple Translations

It is a common requirement to be able to add or edit multiple translations to
Expand Down
Loading