Merge branch '4.x' into 4.next

Author: othercorey

en/contents.rst

@@ -87,7 +87,7 @@ Contents
     Bake <https://book.cakephp.org/bake/2/>
     Debug Kit <https://book.cakephp.org/debugkit/4/>
     Migrations <https://book.cakephp.org/migrations/3/>
-    Elasticsearch <https://book.cakephp.org/elasticsearch/2/en/>
+    Elasticsearch <https://book.cakephp.org/elasticsearch/3/en/>
 
 .. toctree::
     :maxdepth: 3

en/controllers/middleware.rst

@@ -75,11 +75,11 @@ called at the beginning of the request process, you can use the
 
     class Application extends BaseApplication
     {
-        public function middleware(MiddlewareQueue $middlwareQueue): MiddlewareQueue
+        public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
         {
             // Bind the error handler into the middleware queue.
-            $middlwareQueue->add(new ErrorHandlerMiddleware());
-            return $middlwareQueue;
+            $middlewareQueue->add(new ErrorHandlerMiddleware());
+            return $middlewareQueue;
         }
     }
 
@@ -89,27 +89,27 @@ a variety of operations::
         $layer = new \App\Middleware\CustomMiddleware;
 
         // Added middleware will be last in line.
-        $middlwareQueue->add($layer);
+        $middlewareQueue->add($layer);
 
         // Prepended middleware will be first in line.
-        $middlwareQueue->prepend($layer);
+        $middlewareQueue->prepend($layer);
 
         // Insert in a specific slot. If the slot is out of
         // bounds, it will be added to the end.
-        $middlwareQueue->insertAt(2, $layer);
+        $middlewareQueue->insertAt(2, $layer);
 
         // Insert before another middleware.
         // If the named class cannot be found,
         // an exception will be raised.
-        $middlwareQueue->insertBefore(
+        $middlewareQueue->insertBefore(
             'Cake\Error\Middleware\ErrorHandlerMiddleware',
             $layer
         );
 
         // Insert after another middleware.
         // If the named class cannot be found, the
         // middleware will added to the end.
-        $middlwareQueue->insertAfter(
+        $middlewareQueue->insertAfter(
             'Cake\Error\Middleware\ErrorHandlerMiddleware',
             $layer
         );
@@ -133,11 +133,11 @@ have to the application's middleware queue::
 
     class Plugin extends BasePlugin
     {
-        public function middleware(MiddlewareQueue $middlwareQueue): MiddlewareQueue
+        public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
         {
-            $middlwareQueue->add(new ContactManagerContextMiddleware());
+            $middlewareQueue->add(new ContactManagerContextMiddleware());
 
-            return $middlwareQueue;
+            return $middlewareQueue;
         }
     }
 
@@ -203,14 +203,14 @@ application::
 
     class Application
     {
-        public function middleware(MiddlewareQueue $middlwareQueue): MiddlewareQueue
+        public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
         {
             // Add your simple middleware onto the queue
-            $middlwareQueue->add(new TrackingCookieMiddleware());
+            $middlewareQueue->add(new TrackingCookieMiddleware());
 
             // Add some more middleware onto the queue
 
-            return $middlwareQueue;
+            return $middlewareQueue;
         }
     }
 
@@ -227,10 +227,10 @@ enable cached routes, provide the desired :ref:`cache configuration
 <cache-configuration>` as a parameter::
 
     // In Application.php
-    public function middleware(MiddlewareQueue $middlwareQueue): MiddlewareQueue
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
     {
         // ...
-        $middlwareQueue->add(new RoutingMiddleware($this, 'routing'));
+        $middlewareQueue->add(new RoutingMiddleware($this, 'routing'));
     }
 
 The above would use the ``routing`` cache engine to store the generated route
@@ -313,7 +313,7 @@ Cookie data is encrypted with via OpenSSL using AES::
         Configure::read('Security.cookieKey')
     );
 
-    $middlwareQueue->add($cookies);
+    $middlewareQueue->add($cookies);
 
 .. note::
     It is recommended that the encryption key you use for cookie data, is used
@@ -341,14 +341,15 @@ stack you protect all the actions in application::
     // in src/Application.php
     use Cake\Http\Middleware\CsrfProtectionMiddleware;
 
-    public function middleware($middlwareQueue) {
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
+    {
         $options = [
             // ...
         ];
         $csrf = new CsrfProtectionMiddleware($options);
 
-        $middlwareQueue->add($csrf);
-        return $middlwareQueue;
+        $middlewareQueue->add($csrf);
+        return $middlewareQueue;
     }
 
 By applying the ``CsrfProtectionMiddleware`` to routing scopes, you can include
@@ -357,7 +358,8 @@ or exclude specific route groups::
     // in src/Application.php
     use Cake\Http\Middleware\CsrfProtectionMiddleware;
 
-    public function routes($routes) {
+    public function routes(RouteBuilder $routes) : void
+    {
         $options = [
             // ...
         ];
@@ -393,7 +395,8 @@ URLs for which CSRF token check should be done::
     // in src/Application.php
     use Cake\Http\Middleware\CsrfProtectionMiddleware;
 
-    public function middleware($middlewareQueue) {
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
+    {
         $csrf = new CsrfProtectionMiddleware();
 
         // Token check will be skipped when callback returns `true`.
@@ -517,7 +520,7 @@ use the ``HttpsEnforcerMiddleware``::
 
     // Send additional headers in the redirect response.
     $https = new HttpsEnforcerMiddleware([
-        'headers' => ['X-Https-Upgrade', => true],
+        'headers' => ['X-Https-Upgrade' => true],
     ]);
 
     // Disable HTTPs enforcement when ``debug`` is on.

en/controllers/request-response.rst

@@ -115,6 +115,11 @@ For non-existent names the ``$default`` value will be returned::
 You can also use :ref:`body-parser-middleware` to parse request body of different
 content types into an array, so that it's accessible through ``ServerRequest::getData()``.
 
+If you want to access all the data parameters you can use
+``getParsedBody()``::
+
+    $data = $this->request->getParsedBody();
+    
 .. _request-file-uploads:
 
 File Uploads
@@ -126,11 +131,6 @@ be accessed like this::
 
     $attachment = $this->request->getData('attachment');
 
-By default file uploads are represented in the request data as objects that implement
-`\\Psr\\Http\\Message\\UploadedFileInterface <https://www.php-fig.org/psr/psr-7/#16-uploaded-files>`__.
-In the above example, ``$attachment`` would hold an object, in the current implementation it would by default be an
-instance of ``\Zend\Diactoros\UploadedFile``.
-
 By default file uploads are represented in the request data as objects that implement
 `\\Psr\\Http\\Message\\UploadedFileInterface <https://www.php-fig.org/psr/psr-7/#16-uploaded-files>`__. In the current
 implementation, the ``$attachment`` variable in the above example would by default hold an instance of
@@ -205,7 +205,7 @@ Returns all uploaded files in a normalized array structure. For the above exampl
 ``attachment``, the structure would look like::
 
     [
-          'attachment' => object(Zend\Diactoros\UploadedFile) {
+          'attachment' => object(Laminas\Diactoros\UploadedFile) {
               // ...
           }
     ]
@@ -791,17 +791,17 @@ To set a string as the response body, do the following::
 .. php:method:: withBody($body)
 
 To set the response body, use the ``withBody()`` method, which is provided by the
-:php:class:`Zend\\Diactoros\\MessageTrait`::
+:php:class:`Laminas\\Diactoros\\MessageTrait`::
 
     $response = $response->withBody($stream);
 
 Be sure that ``$stream`` is a :php:class:`Psr\\Http\\Message\\StreamInterface` object.
 See below on how to create a new stream.
 
-You can also stream responses from files using :php:class:`Zend\\Diactoros\\Stream` streams::
+You can also stream responses from files using :php:class:`Laminas\\Diactoros\\Stream` streams::
 
     // To stream from a file
-    use Zend\Diactoros\Stream;
+    use Laminas\Diactoros\Stream;
 
     $stream = new Stream('/path/to/file', 'rb');
     $response = $response->withBody($stream);

en/core-libraries/email.rst

@@ -101,7 +101,7 @@ following configuration keys are used:
 - ``'bcc'``: Mailer or array of blind carbon copy. See ``Mailer::setBcc()``.
 - ``'replyTo'``: Mailer or array to reply the e-mail. See ``Mailer::setReplyTo()``.
 - ``'readReceipt'``: Mailer address or an array of addresses to receive the
-  receipt of read. See ``Mailer::readReceipt()``.
+  receipt of read. See ``Mailer::setReadReceipt()``.
 - ``'returnPath'``: Mailer address or an array of addresses to return if have
   some error. See ``Mailer::setReturnPath()``.
 - ``'messageId'``: Message ID of e-mail. See ``Mailer::setMessageId()``.
@@ -187,7 +187,7 @@ This would use the following template files:
 When sending templated emails you have the option of sending either
 ``text``, ``html`` or ``both``.
 
-You can set all view related config using the view bulder instance got by
+You can set all view related config using the view builder instance got by
 ``Mailer::viewBuilder()`` similar to how you do the same in controller.
 
 You can set view variables with ``Mailer::setViewVars()``::

en/development/configuration.rst

@@ -62,9 +62,13 @@ configurations allowing you to easily vary these libraries in each environment.
 
 For local development, CakePHP leverages `dotenv
 <https://github.com/josegonzalez/php-dotenv>`_ to allow easy local development using
-environment variables. You will see a ``config/.env.example`` in your
+environment variables. Use composer to require this library and then 
+there is a block of code in ``bootstrap.php`` that needs to be uncommented to harness it.
+
+You will see a ``config/.env.example`` in your
 application. By copying this file into ``config/.env`` and customizing the
 values you can configure your application.
+    
 
 You should avoid committing the ``config/.env`` file to your repository and
 instead use the ``config/.env.example`` as a template with placeholder values so

en/elasticsearch.rst

@@ -1,4 +1,4 @@
 ElasticSearch
 #############
 
-This page has `moved <https://book.cakephp.org/elasticsearch/2.x/en/>`__.
+This page has `moved <https://book.cakephp.org/elasticsearch/3/en/>`__.