Merge branch '5.x' into 5.next

Author: ADmad

en/controllers/components/form-protection.rst

@@ -1,5 +1,5 @@
-FormProtection
-##############
+Form Protection Component
+#########################
 
 .. php:class:: FormProtection(ComponentCollection $collection, array $config = [])
 

en/controllers/pagination.rst

@@ -62,6 +62,8 @@ You can also use :ref:`custom-find-methods` in pagination by using the ``finder`
         ];
     }
 
+Note: This only works with Table as string input in ``$this->paginate('MyTable')``. Once you use ``$this->MyTable->find()`` as input for ``paginate()``, you must directly use that Query object instead.
+
 If your finder method requires additional options you can pass those
 as values for the finder::
 

en/controllers/request-response.rst

@@ -273,22 +273,26 @@ types making the parsed data available in ``$request->getData()`` and
 Environment Variables (from $_SERVER and $_ENV)
 -----------------------------------------------
 
-.. php:method:: putenv($key, $value = null)
+.. php:method:: getEnv($key, $default = null)
 
 ``ServerRequest::getEnv()`` is a wrapper for ``getenv()`` global function and acts as
-a getter/setter for environment variables without having to modify globals
-``$_SERVER`` and ``$_ENV``::
+a getter for environment variables without possible undefined keys::
 
-    // Get the host
     $host = $this->request->getEnv('HTTP_HOST');
 
-    // Set a value, generally helpful in testing.
-    $this->request->withEnv('REQUEST_METHOD', 'POST');
-
 To access all the environment variables in a request use ``getServerParams()``::
 
     $env = $this->request->getServerParams();
 
+.. php:method:: withEnv($key, $value)
+
+``ServerRequest::withEnv()`` is a wrapper for ``putenv()`` global function and acts as
+a setter for environment variables without having to modify globals
+``$_SERVER`` and ``$_ENV``::
+
+    // Set a value, generally helpful in testing.
+    $this->request->withEnv('REQUEST_METHOD', 'POST');
+
 XML or JSON Data
 ----------------
 

en/development/dependency-injection.rst

@@ -55,10 +55,13 @@ Command Example
 ::
 
     // In src/Command/CheckUsersCommand.php
+    use Cake\Console\CommandFactoryInterface;
+
     class CheckUsersCommand extends Command
     {
-        public function __construct(public UsersService $users)
+        public function __construct(protected UsersService $users, ?CommandFactoryInterface $factory = null)
         {
+            parent::__construct($factory);
         }
 
         public function execute(Arguments $args, ConsoleIo $io)
@@ -73,7 +76,8 @@ Command Example
     {
         $container
             ->add(CheckUsersCommand::class)
-            ->addArgument(UsersService::class);
+            ->addArgument(UsersService::class)
+            ->addArgument(CommandFactoryInterface::class);
         $container->add(UsersService::class);
     }
 
@@ -89,13 +93,14 @@ Component Example
 ::
 
     // In src/Controller/Component/SearchComponent.php
-    class SearchComponent extends Command
+    class SearchComponent extends Component
     {
         public function __construct(
             ComponentRegistry $registry,
-            private UserService $users
+            private UserService $users,
+            array $config = []
         ) {
-            parent::__construct($registry, []);
+            parent::__construct($registry, $config);
         }
 
         public function something()

en/development/errors.rst

@@ -354,7 +354,7 @@ provide more context around your errors::
 
     use Cake\Core\Exception\CakeException;
 
-    class MissingWidgetException extends Exception
+    class MissingWidgetException extends CakeException
     {
         // Context data is interpolated into this format string.
         protected $_messageTemplate = 'Seems that %s is missing.';

en/development/routing.rst

@@ -295,7 +295,7 @@ will be treated as part of the parameter::
 
 The above example illustrates how to create a quick way to view
 models from any controller by crafting a URL that looks like
-``/controllername/{id}``. The URL provided to ``connect()`` specifies two
+``/controller-name/{id}``. The URL provided to ``connect()`` specifies two
 route elements: ``{controller}`` and ``{id}``. The ``{controller}`` element
 is a CakePHP default route element, so the router knows how to match and
 identify controller names in URLs. The ``{id}`` element is a custom
@@ -712,7 +712,7 @@ When using nesting, you need to chain them together::
         ['prefix' => 'Admin/MyPrefix', 'controller' => 'TodoItems', 'action' => 'create']
     );
 
-This would link to a controller with the namespace ``App\\Controller\\Admin\\MyPrefix`` and the file path
+This would link to a controller with the namespace ``App\Controller\Admin\MyPrefix`` and the file path
 ``src/Controller/Admin/MyPrefix/TodoItemsController.php``.
 
 .. note::
@@ -1579,7 +1579,7 @@ Custom Route Classes
 Custom route classes allow you to extend and change how individual routes parse
 requests and handle reverse routing. Route classes have a few conventions:
 
-* Route classes are expected to be found in the ``Routing\\Route`` namespace of
+* Route classes are expected to be found in the ``Routing\Route`` namespace of
   your application or plugin.
 * Route classes should extend :php:class:`\\Cake\\Routing\\Route\\Route`.
 * Route classes should implement one or both of ``match()`` and/or ``parse()``.

en/orm/database-basics.rst

@@ -476,12 +476,14 @@ Enum Type
 Maps a `BackedEnum <https://www.php.net/manual/en/language.enumerations.backed.php>`_ to a string or integer column.
 To use this type you need to specify which column is associated to which BackedEnum inside the table class::
 
-    use \Cake\Database\Type\EnumType;
-    use \App\Model\Enum\ArticleStatus;
+    use App\Model\Enum\ArticleStatus;
+    use Cake\Database\Type\EnumType;
 
     // in src/Model/Table/ArticlesTable.php
     public function initialize(array $config): void
     {
+        parent::initialize($config);
+
         $this->getSchema()->setColumnType('status', EnumType::from(ArticleStatus::class));
     }
 
@@ -599,14 +601,16 @@ We then have two ways to use our datatype in our models.
 
 Overwriting the reflected schema with our custom type will enable CakePHP's
 database layer to automatically convert JSON data when creating queries. In your
-Table's :ref:`getSchema() method <saving-complex-types>` add the
+Table's :ref:`initialize() method <saving-complex-types>` add the
 following::
 
     class WidgetsTable extends Table
     {
-        public function getSchema(): TableSchemaInterface
+        public function initialize(array $config): void
         {
-            return parent::getSchema()->setColumnType('widget_prefs', 'json');
+            parent::initialize($config);
+
+            $this->getSchema()->setColumnType('widget_prefs', 'json');
         }
     }
 

en/orm/query-builder.rst

@@ -150,12 +150,12 @@ You can also get a key-value list out of a query result::
 For more information on how to customize the fields used for populating the list
 refer to :ref:`table-find-list` section.
 
-Resultset Are Collection Objects
+ResultSet Is A Collection Object
 --------------------------------
 
 Once you get familiar with the Query object methods, it is strongly encouraged
 that you visit the :doc:`Collection </core-libraries/collections>` section to
-improve your skills in efficiently traversing the results. The resultset (returned
+improve your skills in efficiently traversing the results. The ResultSet (returned
 by calling the ``SelectQuery``'s ``all()`` method) implements the collection interface::
 
     // Use the combine() method from the collections library

en/orm/saving-data.rst

@@ -1094,12 +1094,11 @@ column Types::
 
     class UsersTable extends Table
     {
-        public function getSchema(): TableSchemaInterface
+        public function initialize(array $config): void
         {
-            $schema = parent::getSchema();
-            $schema->setColumnType('preferences', 'json');
+            parent::initialize($config);
 
-            return $schema;
+            $this->getSchema()->setColumnType('preferences', 'json');
         }
     }
 

en/quickstart.rst

@@ -6,6 +6,7 @@ To start off we'll build a simple Content Management application.
 
 .. include:: /tutorials-and-examples/cms/installation.rst
 .. include:: /tutorials-and-examples/cms/database.rst
+.. include:: /tutorials-and-examples/cms/articles-model.rst
 .. include:: /tutorials-and-examples/cms/articles-controller.rst
 
 .. meta::