Fix PHP code style in documentation snippets (#8191)

* Fix PHP coding standards in documentation code snippets

- Add missing trailing commas in multi-line arrays (399 fixes)
- Fix 2-space and 3-space indentation to 4-space in PHP code blocks
- Manual fixes for edge cases (string keys containing '#', odd indent)

Blocks inside /* */ comments showing print_r output and non-PHP content
are intentionally left untouched.

* Fix http to https by default.

* Fix trailing whitespace in PHP code blocks

Author: dereuromark

docs/en/appendices/glossary.md

@@ -37,7 +37,7 @@ Would point to the following value:
 [
     'Cache' => [
         'default' => [
-            'engine' => 'File'
+            'engine' => 'File',
         ]
     ]
 ]

docs/en/appendices/phpunit-upgrade.md

@@ -58,7 +58,7 @@ should be converted to:
 
 ``` php
 ->with(
-    ...self::withConsecutive(['firstCallArg'], ['secondCallArg'])
+    ...self::withConsecutive(['firstCallArg'], ['secondCallArg']),
 )
 ```
 

docs/en/console-commands/commands.md

@@ -173,7 +173,7 @@ class UserCommand extends Command
     {
         $parser
             ->addArgument('name', [
-                'help' => 'What is your name'
+                'help' => 'What is your name',
             ]);
 
         return $parser;
@@ -392,7 +392,7 @@ class UpdateTableCommand extends Command
             ->setDescription('My cool console app')
             ->addArgument('table', [
                 'help' => 'Table to update',
-                'required' => true
+                'required' => true,
             ]);
 
         return $parser;
@@ -403,7 +403,7 @@ class UpdateTableCommand extends Command
         $table = $args->getArgument('table');
         $this->fetchTable($table)->updateQuery()
             ->set([
-                'modified' => new DateTime()
+                'modified' => new DateTime(),
             ])
             ->execute();
 
@@ -492,7 +492,7 @@ class UpdateTableCommand extends Command
             ->setDescription('My cool console app')
             ->addArgument('table', [
                 'help' => 'Table to update',
-                'required' => true
+                'required' => true,
             ]);
 
         return $parser;
@@ -507,7 +507,7 @@ class UpdateTableCommand extends Command
         }
         $this->fetchTable($table)->updateQuery()
             ->set([
-                'modified' => new DateTime()
+                'modified' => new DateTime(),
             ])
             ->execute();
 

docs/en/console-commands/option-parsers.md

@@ -202,7 +202,7 @@ are set to `true`, when they are absent they are set to `false`:
 ``` php
 $parser->addOption('verbose', [
     'help' => 'Enable verbose output.',
-    'boolean' => true
+    'boolean' => true,
 ]);
 ```
 
@@ -228,7 +228,7 @@ public function getOptionParser()
         'description' => [
             __("Use this command to grant ACL permissions. Once executed, the "),
             __("ARO specified (and its children, if any) will have ALLOW access "),
-            __("to the specified ACO action (and the ACO's children, if any).")
+            __("to the specified ACO action (and the ACO's children, if any)."),
         ],
         'arguments' => [
             'aro' => ['help' => __('ARO to check.'), 'required' => true],

docs/en/contributing/cakephp-coding-conventions.md

@@ -75,7 +75,7 @@ Use this instead:
 $matches = array_intersect_key(
     $this->_listeners,
     array_flip(
-        preg_grep($matchPattern, array_keys($this->_listeners), 0)
+        preg_grep($matchPattern, array_keys($this->_listeners), 0),
     )
 );
 ```

docs/en/controllers.md

@@ -427,9 +427,9 @@ return $this->redirect([
     $order->id,
     '?' => [
         'product' => 'pizza',
-        'quantity' => 5
+        'quantity' => 5,
     ],
-    '#' => 'top'
+    '#' => 'top',
 ]);
 ```
 
@@ -438,7 +438,7 @@ Or using a relative or absolute URL:
 ``` php
 return $this->redirect('/orders/confirm');
 
-return $this->redirect('http://www.example.com');
+return $this->redirect('https://www.example.com');
 ```
 
 Or to the referer page:
@@ -471,7 +471,7 @@ the controller's default one:
 // In a controller method.
 $recentArticles = $this->fetchTable('Articles')->find('all',
         limit: 5,
-        order: 'Articles.created DESC'
+        order: 'Articles.created DESC',
     )
     ->all();
 ```

docs/en/controllers/components.md

@@ -198,7 +198,7 @@ class SsoComponent extends Component
     public function __construct(
         ComponentRegistry $registry,
         array $config = [],
-        UserService $users
+        UserService $users,
     ) {
         parent::__construct($registry, $config);
         $this->users = $users;

docs/en/controllers/middleware.md

@@ -118,15 +118,15 @@ $middlewareQueue->insertAt(2, $layer);
 // an exception will be raised.
 $middlewareQueue->insertBefore(
     'Cake\Error\Middleware\ErrorHandlerMiddleware',
-    $layer
+    $layer,
 );
 
 // Insert after another middleware.
 // If the named class cannot be found, the
 // middleware will added to the end.
 $middlewareQueue->insertAfter(
     'Cake\Error\Middleware\ErrorHandlerMiddleware',
-    $layer
+    $layer,
 );
 ```
 
@@ -189,7 +189,7 @@ class TrackingCookieMiddleware implements MiddlewareInterface
 {
     public function process(
         ServerRequestInterface $request,
-        RequestHandlerInterface $handler
+        RequestHandlerInterface $handler,
     ): ResponseInterface
     {
         // Calling $handler->handle() delegates control to the *next* middleware
@@ -201,7 +201,7 @@ class TrackingCookieMiddleware implements MiddlewareInterface
             $response = $response->withCookie(new Cookie(
                 'landing_page',
                 $request->getRequestTarget(),
-                $expiry
+                $expiry,
             ));
         }
 
@@ -265,7 +265,7 @@ use Cake\Http\Middleware\EncryptedCookieMiddleware;
 $cookies = new EncryptedCookieMiddleware(
     // Names of cookies to protect
     ['secrets', 'protected'],
-    Configure::read('Security.cookieKey')
+    Configure::read('Security.cookieKey'),
 );
 
 $middlewareQueue->add($cookies);

docs/en/controllers/pages-controller.md

@@ -5,7 +5,7 @@ This is a simple and optional controller for serving up static content. The home
 you see after installation is generated using this controller and the view
 file **templates/Pages/home.php**. If you make the view file
 **templates/Pages/about_us.php** you can access it using the URL
-**http://example.com/pages/about_us**. You are free to modify the Pages
+**https://example.com/pages/about_us**. You are free to modify the Pages
 Controller to meet your needs.
 
 When you "bake" an app using Composer the Pages Controller is created in your

docs/en/controllers/pagination.md

@@ -79,7 +79,7 @@ class ArticlesController extends AppController
         $tags = $this->request->getParam('pass');
 
         $customFinderOptions = [
-            'tags' => $tags
+            'tags' => $tags,
         ];
         // We're using the $settings argument to paginate() here.
         // But the same structure could be used in $this->paginate
@@ -90,7 +90,7 @@ class ArticlesController extends AppController
         // public function findTagged(Query $query, array $tagged = [])
         $settings = [
             'finder' => [
-                'tagged' => $customFinderOptions
+                'tagged' => $customFinderOptions,
             ]
         ];
         $articles = $this->paginate($this->Articles, $settings);
@@ -153,7 +153,7 @@ call to the `paginate()` method:
 // Paginate property
 protected array $paginate = [
     'Articles' => ['scope' => 'article'],
-    'Tags' => ['scope' => 'tag']
+    'Tags' => ['scope' => 'tag'],
 ];
 
 // In a controller action
@@ -197,7 +197,7 @@ $this->paginate = [
 
 $publishedArticles = $this->paginate(
     $this->Articles->find('all', scope: 'published_articles')
-        ->where(['published' => true])
+        ->where(['published' => true]),
 );
 
 // Load an additional table object to allow differentiating in the paginator
@@ -209,7 +209,7 @@ $unpublishedArticlesTable = $this->fetchTable('UnpublishedArticles', [
 
 $unpublishedArticles = $this->paginate(
     $unpublishedArticlesTable->find('all', scope: 'unpublished_articles')
-        ->where(['published' => false])
+        ->where(['published' => false]),
 );
 ```
 
@@ -355,7 +355,7 @@ example reducing it to `10`:
 ``` php
 protected array $paginate = [
     // Other keys here.
-    'maxLimit' => 10
+    'maxLimit' => 10,
 ];
 ```