diff --git a/docs/en/console-commands/completion.md b/docs/en/console-commands/completion.md index d0f3bc462c..466d3c12f7 100644 --- a/docs/en/console-commands/completion.md +++ b/docs/en/console-commands/completion.md @@ -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/**. - - ### Bash Completion file content This is the code you need to put inside the **cake** file in the correct location diff --git a/docs/en/console-commands/input-output.md b/docs/en/console-commands/input-output.md index 582b23a0e6..869039f9ca 100644 --- a/docs/en/console-commands/input-output.md +++ b/docs/en/console-commands/input-output.md @@ -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. - - ## Command Helpers Formatting console output can be tedious and lead to maintenance issues. To diff --git a/docs/en/contributing/backwards-compatibility.md b/docs/en/contributing/backwards-compatibility.md index 55a5c9ebd5..85615ef2f2 100644 --- a/docs/en/contributing/backwards-compatibility.md +++ b/docs/en/contributing/backwards-compatibility.md @@ -283,8 +283,6 @@ value: Will disable runtime deprecation warnings. - - ## Experimental Features Experimental features are **not included** in the above backwards compatibility diff --git a/docs/en/controllers/components.md b/docs/en/controllers/components.md index 0340ec3c33..2aa2b96af4 100644 --- a/docs/en/controllers/components.md +++ b/docs/en/controllers/components.md @@ -15,8 +15,6 @@ chapter for each component: - [Form Protection Component](../controllers/components/form-protection) - [Checking HTTP Cache](../controllers/components/check-http-cache) - - ## Configuring Components Many of the core components require configuration. One example would be @@ -152,8 +150,6 @@ class PostsController extends AppController Components are able to use [Dependency Injection](../development/dependency-injection) to receive services. ::: - - ## Creating a Component Suppose our application needs to perform a complex mathematical operation in diff --git a/docs/en/controllers/middleware.md b/docs/en/controllers/middleware.md index 88fb960b6b..7b463619fd 100644 --- a/docs/en/controllers/middleware.md +++ b/docs/en/controllers/middleware.md @@ -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. - - ## Using Middleware Middleware can be applied to your application globally, to individual @@ -234,8 +232,6 @@ class Application } ``` - - ## Routing Middleware Routing middleware is responsible for applying your application's routes and @@ -250,8 +246,6 @@ public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue } ``` - - ## Encrypted Cookie Middleware If your application has cookies that contain data you want to obfuscate and @@ -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. - - ## Body Parser Middleware If your application accepts JSON, XML or other encoded request bodies, the diff --git a/docs/en/controllers/pagination.md b/docs/en/controllers/pagination.md index a8f4b93dfe..c1ab4b2938 100644 --- a/docs/en/controllers/pagination.md +++ b/docs/en/controllers/pagination.md @@ -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. - - ## Paginating Multiple Queries You can paginate multiple models in a single controller action, using the @@ -213,8 +211,6 @@ $unpublishedArticles = $this->paginate( ); ``` - - ## Control which Fields Used for Ordering By default, sorting can be done on any non-virtual column a table has. This is diff --git a/docs/en/controllers/request-response.md b/docs/en/controllers/request-response.md index e3c5c0c68b..62793fbba4 100644 --- a/docs/en/controllers/request-response.md +++ b/docs/en/controllers/request-response.md @@ -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. - - ### Request Parameters The request exposes routing parameters through the `getParam()` method: @@ -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. - - ### Creating Cookies `class` Cake\\Http\\Cookie\\**Cookie** diff --git a/docs/en/core-libraries/caching.md b/docs/en/core-libraries/caching.md index 9609927e70..ac7fd0ca32 100644 --- a/docs/en/core-libraries/caching.md +++ b/docs/en/core-libraries/caching.md @@ -686,8 +686,6 @@ The required API for a CacheEngine is `method` Cake\\Cache\\CacheEngine::**increment**($key, $offset = 1): int|false - - ## Cache Events ::: info Added in version 5.3.0 diff --git a/docs/en/core-libraries/events.md b/docs/en/core-libraries/events.md index d8f6ce23f6..9c7747d36b 100644 --- a/docs/en/core-libraries/events.md +++ b/docs/en/core-libraries/events.md @@ -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. - - ### Tracking Events To keep a list of events that are fired on a particular `EventManager`, you @@ -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. - - ### Stopping Events Much like DOM events, you may want to stop an event to prevent additional diff --git a/docs/en/core-libraries/hash.md b/docs/en/core-libraries/hash.md index ddaace7cbe..dfe12ad8e3 100644 --- a/docs/en/core-libraries/hash.md +++ b/docs/en/core-libraries/hash.md @@ -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()`. - - ## Hash Path Syntax The path syntax described below is used by all the methods in `Hash`. Not all diff --git a/docs/en/core-libraries/inflector.md b/docs/en/core-libraries/inflector.md index 5f5cedfbaf..b96e1ec305 100644 --- a/docs/en/core-libraries/inflector.md +++ b/docs/en/core-libraries/inflector.md @@ -224,8 +224,6 @@ generating code or doing work based on conventions: Inflector::variable('apple_pie'); ``` - - ## Inflection Configuration CakePHP's naming conventions can be really nice - you can name your database diff --git a/docs/en/core-libraries/internationalization-and-localization.md b/docs/en/core-libraries/internationalization-and-localization.md index 3ceb8a99e3..6d2d135bba 100644 --- a/docs/en/core-libraries/internationalization-and-localization.md +++ b/docs/en/core-libraries/internationalization-and-localization.md @@ -516,8 +516,6 @@ I18n::setTranslator( ); ``` - - ### Creating Generic Translators Configuring translators by calling `I18n::setTranslator()` for each domain and diff --git a/docs/en/core-libraries/logging.md b/docs/en/core-libraries/logging.md index 14b609afea..ff692ce53e 100644 --- a/docs/en/core-libraries/logging.md +++ b/docs/en/core-libraries/logging.md @@ -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. - - ## Writing to Logs Writing to the log files can be done in two different ways. The first @@ -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. - - ### Logging Scopes Often times you'll want to configure different logging behavior for different @@ -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. - - ## Logging Formatters Logging formatters allow you to control how log messages are formatted diff --git a/docs/en/core-libraries/validation.md b/docs/en/core-libraries/validation.md index 686ba4985c..7c8b84151e 100644 --- a/docs/en/core-libraries/validation.md +++ b/docs/en/core-libraries/validation.md @@ -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). - - ## Creating Validators `class` Cake\\Validation\\**Validator** @@ -244,8 +242,6 @@ $validator->add('length', 'custom', [ ]); ``` - - ### Conditional Validation When defining validation rules, you can use the `on` key to define when @@ -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. - - ### Adding Validation Providers The `Validator`, `ValidationSet` and `ValidationRule` classes do not diff --git a/docs/en/development/configuration.md b/docs/en/development/configuration.md index 866b93cac7..c5fbcf1f3c 100644 --- a/docs/en/development/configuration.md +++ b/docs/en/development/configuration.md @@ -38,8 +38,6 @@ Configure::load('app', 'default', false); Configure::load('other_config', 'default'); ``` - - ## Environment Variables Many modern cloud providers, like Heroku, let you define environment @@ -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. - - ### General Configuration Below is a description of the variables and how they affect your CakePHP @@ -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. - - ## Additional Class Paths Additional class paths are setup through the autoloaders your application uses. @@ -465,8 +459,6 @@ files with that engine would fail: Configure::drop('default'); ``` - - ### Loading Configuration Files `static` Cake\\Core\\Configure::**load**(string $key, string $config = 'default', bool $merge = true): bool diff --git a/docs/en/development/dependency-injection.md b/docs/en/development/dependency-injection.md index f3bea6f193..8d9114e864 100644 --- a/docs/en/development/dependency-injection.md +++ b/docs/en/development/dependency-injection.md @@ -725,8 +725,6 @@ class BillingServiceProvider extends ServiceProvider } ``` - - ## Mocking Services in Tests In tests that use `ConsoleIntegrationTestTrait` or `IntegrationTestTrait` diff --git a/docs/en/development/errors.md b/docs/en/development/errors.md index 2880459ec5..29232d273d 100644 --- a/docs/en/development/errors.md +++ b/docs/en/development/errors.md @@ -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. - - ## Deprecation Warnings CakePHP uses deprecation warnings to indicate when features have been @@ -236,8 +234,6 @@ class ErrorController extends AppController Exception specific controller methods and templates were added. ::: - - ## Custom ExceptionRenderer If you want to control the entire exception rendering and logging process you diff --git a/docs/en/development/routing.md b/docs/en/development/routing.md index d111780986..6bc97a2ca0 100644 --- a/docs/en/development/routing.md +++ b/docs/en/development/routing.md @@ -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. - - ### Route Elements You can specify your own route elements and doing so gives you the @@ -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. - - ### Prefix Routing `static` Cake\\Routing\\RouteBuilder::**prefix**($name, $callback) @@ -1035,8 +1031,6 @@ $this->Html->link( ); ``` - - ## Route Scoped Middleware While Middleware can be applied to your entire application, applying middleware @@ -1347,8 +1341,6 @@ $routes->scope('/', function (RouteBuilder $routes) { }); ``` - - ## Passed Arguments Passed arguments are additional arguments or path segments that are @@ -1644,8 +1636,6 @@ To generate asset URLs for files in plugins use `plugin syntax`: $img = Asset::imageUrl('DebugKit.cake.png'); ``` - - ## Redirect Routing Redirect routing allows you to issue HTTP status 30x redirects for @@ -1684,8 +1674,6 @@ $routes->scope('/', function (RouteBuilder $routes) { This would redirect `/articles/*` to `http://google.com` with a HTTP status of 302. - - ## Entity Routing Entity routing allows you to use an entity, an array or object implement @@ -1759,8 +1747,6 @@ class MyRedirectRoute extends Route `RedirectTrait` was added. ::: - - ## Custom Route Classes Custom route classes allow you to extend and change how individual routes parse diff --git a/docs/en/development/sessions.md b/docs/en/development/sessions.md index 67d76ec4e4..ce2795ade7 100644 --- a/docs/en/development/sessions.md +++ b/docs/en/development/sessions.md @@ -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. - - ## Session Configuration Session configuration is generally defined in **/config/app.php**. The available diff --git a/docs/en/development/testing.md b/docs/en/development/testing.md index 14f738d616..9c891892a8 100644 --- a/docs/en/development/testing.md +++ b/docs/en/development/testing.md @@ -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. - - ## Running Tests Once you have PHPUnit installed and some test cases written, you'll want to run @@ -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. - - ## Testing Events The [Events System](../core-libraries/events) is a great way to decouple your application diff --git a/docs/en/orm/associations.md b/docs/en/orm/associations.md index aa7870e7dc..aba61d9cf5 100644 --- a/docs/en/orm/associations.md +++ b/docs/en/orm/associations.md @@ -656,8 +656,6 @@ INNER JOIN articles_tags ON ( ); ``` - - ### Using the 'through' Option If you plan on adding extra information to the join/pivot table, or if you need diff --git a/docs/en/orm/behaviors/translate.md b/docs/en/orm/behaviors/translate.md index 7250de6d8c..0eccd613e3 100644 --- a/docs/en/orm/behaviors/translate.md +++ b/docs/en/orm/behaviors/translate.md @@ -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. - - ## Saving Multiple Translations It is a common requirement to be able to add or edit multiple translations to diff --git a/docs/en/orm/database-basics.md b/docs/en/orm/database-basics.md index 428997dc45..e22a36b5f2 100644 --- a/docs/en/orm/database-basics.md +++ b/docs/en/orm/database-basics.md @@ -30,8 +30,6 @@ $connection = ConnectionManager::get('default'); > [!NOTE] > For supported databases, see [installation notes](../installation). - - ### Running Select Statements Running raw SQL queries is a breeze: @@ -306,8 +304,6 @@ pastry_stores, and savory_cakes. > 'flags' => [\PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8'] > ``` - - ## Read and Write Connections Connections can have separate read and write roles. Read @@ -518,8 +514,6 @@ The `nativeuuid` type was added. The `inet`, `cidr`, `macaddr`, and `year` types were added. ::: - - ### DateTime Type `class` Cake\\Database\\**DateTimeType** @@ -563,8 +557,6 @@ use Cake\Database\Type\DateTimeTimezoneType; TypeFactory::map('datetime', DateTimeTimezoneType::class); ``` - - ### Enum Type `class` Cake\\Database\\**EnumType** @@ -848,8 +840,6 @@ no value for the current database driver: - `precision` The precision of the column if available. - `scale` Can be included for SQLServer connections. - - ### Mapping Custom Datatypes to SQL Expressions The previous example maps a custom datatype for a 'point_mutation' column type @@ -1190,8 +1180,6 @@ Log::setConfig('queries', [ > never leave query logging on in production as it will negatively impact the > performance of your application. - - ## Identifier Quoting By default, CakePHP does **not** quote identifiers in generated SQL queries. The diff --git a/docs/en/orm/entities.md b/docs/en/orm/entities.md index 469a92fdb5..0d6c8a4e69 100644 --- a/docs/en/orm/entities.md +++ b/docs/en/orm/entities.md @@ -509,13 +509,13 @@ your associations, there may be times when you need to lazily load associated data. Before we get into how to lazy load associations, we should discuss the differences between eager loading and lazy loading associations: -Eager loading +Eager loading Eager loading uses joins (where possible) to fetch data from the database in as *few* queries as possible. When a separate query is required, like in the case of a HasMany association, a single query is emitted to fetch *all* the associated data for the current set of objects. -Lazy loading +Lazy loading Lazy loading defers loading association data until it is absolutely required. While this can save CPU time because possibly unused data is not hydrated into objects, it can result in many more queries being emitted to @@ -599,8 +599,6 @@ applied. Entities are recursively converted to JSON as well. This means that if eager loaded entities and their associations CakePHP will correctly handle converting the associated data into the correct format. - - ### Exposing Virtual Fields By default, virtual fields are not exported when converting entities to diff --git a/docs/en/orm/query-builder.md b/docs/en/orm/query-builder.md index ee7c5a86d6..529e938925 100644 --- a/docs/en/orm/query-builder.md +++ b/docs/en/orm/query-builder.md @@ -312,8 +312,6 @@ $query->selectAllExcept($articlesTable, ['published']); You can also pass an `Association` object when working with contained associations. - - ### Using SQL Functions CakePHP's ORM offers abstraction for some commonly used SQL functions. Using the @@ -1798,8 +1796,6 @@ to fetch associated data from other tables is called **eager loading**. - - ### Adding Joins In addition to loading related data with `contain()`, you can also add diff --git a/docs/en/orm/retrieving-data-and-resultsets.md b/docs/en/orm/retrieving-data-and-resultsets.md index de262af5d2..ef13a4bc90 100644 --- a/docs/en/orm/retrieving-data-and-resultsets.md +++ b/docs/en/orm/retrieving-data-and-resultsets.md @@ -336,8 +336,6 @@ $this->setDisplayField('label'); // Will utilize Author::_getLabel() $query = $authors->find('list'); // Will utilize AuthorsTable::getDisplayField() ``` - - ## Finding Threaded Data The `find('threaded')` finder returns nested entities that are threaded @@ -413,8 +411,6 @@ If you need to modify the results after they have been fetched you should use a [Map Reduce](#map-reduce) function to modify the results. The map reduce features replace the 'afterFind' callback found in previous versions of CakePHP. - - ## Dynamic Finders CakePHP's ORM provides dynamically constructed finder methods which allow you to @@ -552,7 +548,7 @@ You can select fields from all associations with multiple `contain()` statements: ``` php -$query = $this->find()->select([ +$query = $products->find()->select([ 'Realestates.id', 'Realestates.title', 'Realestates.description', @@ -1116,8 +1112,6 @@ $results = $query->all(); $results->isEmpty(); ``` - - ### Loading Additional Associations Once you've created a result set, you may need to load diff --git a/docs/en/orm/saving-data.md b/docs/en/orm/saving-data.md index df88edc7bc..c4fd48eb5b 100644 --- a/docs/en/orm/saving-data.md +++ b/docs/en/orm/saving-data.md @@ -390,8 +390,6 @@ $articles->saveMany($entities); $articles->saveManyOrFail($entities); ``` - - ### Changing Accessible Fields It's also possible to allow `newEntity()` to write into non accessible fields. @@ -791,8 +789,6 @@ $this->save($entity); The `strictFields` option was added in 5.3.0. ::: - - ## Saving Entities `method` Cake\\ORM\\Table::**save**(EntityInterface $entity, array $options = []): EntityInterface|false @@ -1198,8 +1194,6 @@ manipulate entities, marshall request data, and create form fields. Custom junction property names were added. ::: - - ### Saving Complex Types Tables are capable of storing data represented in basic types, like strings, diff --git a/docs/en/orm/validation.md b/docs/en/orm/validation.md index 6a7922fb60..867598e05c 100644 --- a/docs/en/orm/validation.md +++ b/docs/en/orm/validation.md @@ -295,8 +295,6 @@ before entities are persisted. Some example application rules are: Application rules are checked when calling the Table `save()` and `delete()` methods. - - ### Creating a Rules Checker Rules checker classes are generally defined by the `buildRules()` method in your @@ -630,8 +628,6 @@ public function buildRules(RulesChecker $rules): RulesChecker See the core rules for examples on how to create such rules. - - ### Creating Custom Rule Objects If your application has rules that are commonly reused, it is helpful to package diff --git a/docs/en/plugins.md b/docs/en/plugins.md index 9ec1d61679..f474b8aa82 100644 --- a/docs/en/plugins.md +++ b/docs/en/plugins.md @@ -73,8 +73,6 @@ before running the above composer command: } ``` - - ## Loading a Plugin If you want to use a plugin's routes, console commands, middlewares, event @@ -369,8 +367,6 @@ class ContactManagerPlugin extends BasePlugin } ``` - - ## Plugin Routes Plugins can provide routes files containing their routes. Each plugin can @@ -481,8 +477,6 @@ also connect routes that use the following pattern: See the section on [Plugin Configuration](#plugin-configuration) for information on how to load plugin specific route files. - - ## Plugin Models Models for the plugin are stored in **plugins/ContactManager/src/Model**. @@ -650,8 +644,6 @@ plugin implemented an 'Admin' prefix the overriding path would be: templates/plugin/ContactManager/Admin/ContactManager/index.php - - ## Plugin Assets A plugin's web assets (but not PHP files) can be served through the plugin's diff --git a/docs/en/security/https-enforcer.md b/docs/en/security/https-enforcer.md index ef9f0f64ff..7f5efe51ad 100644 --- a/docs/en/security/https-enforcer.md +++ b/docs/en/security/https-enforcer.md @@ -1,5 +1,3 @@ - - # HTTPS Enforcer Middleware If you want your application to only be available via HTTPS connections you can diff --git a/docs/en/security/security-headers.md b/docs/en/security/security-headers.md index c09ece3d07..e427e40c65 100644 --- a/docs/en/security/security-headers.md +++ b/docs/en/security/security-headers.md @@ -1,5 +1,3 @@ - - # Security Header Middleware The `SecurityHeaderMiddleware` layer allows you to apply security related diff --git a/docs/en/views.md b/docs/en/views.md index f5a6b81009..a538ada4fa 100644 --- a/docs/en/views.md +++ b/docs/en/views.md @@ -54,8 +54,6 @@ class AppView extends View } ``` - - ## View Templates The view layer of CakePHP is how you speak to your users. Most of the time your @@ -172,8 +170,6 @@ $this->set('activeMenuButton', 'posts'); Then, in your layout, the `$activeMenuButton` variable will be available and contain the value 'posts'. - - ### Extending Views View extending allows you to wrap one view in another. Combining this with @@ -716,8 +712,6 @@ echo $this->cache(function () use ($user, $article) { By default, cached view content will go into the `View::$elementCache` cache config, but you can use the `config` option to change this. - - ## View Events Like Controller, view trigger several events/callbacks that you can use to diff --git a/docs/en/views/helpers.md b/docs/en/views/helpers.md index 41e9ec98f0..97b5a62f4d 100644 --- a/docs/en/views/helpers.md +++ b/docs/en/views/helpers.md @@ -21,8 +21,6 @@ helpers included in CakePHP, check out the chapter for each helper: - [Time](../views/helpers/time) - [Url](../views/helpers/url) - - ## Configuring Helpers You configure helpers in CakePHP by declaring them in a view class. An `AppView` @@ -164,8 +162,6 @@ class PostsController extends AppController } ``` - - ### Aliasing Helpers One common setting to use is the `className` option, which allows you to