Add CounterCacheCommand.

src/Command/CounterCacheCommand.php

@@ -0,0 +1,110 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         5.2.0
+ * @license       https://opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Cake\Command;
+
+use Cake\Console\Arguments;
+use Cake\Console\ConsoleIo;
+use Cake\Console\ConsoleOptionParser;
+
+/**
+ * Command for updating counter cache.
+ */
+class CounterCacheCommand extends Command
+{
+    /**
+     * @inheritDoc
+     */
+    public static function defaultName(): string
+    {
+        return 'counter_cache';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function getDescription(): string
+    {
+        return 'Update counter cache for a model.';
+    }
+
+    /**
+     * Execute the command.
+     *
+     * Updates the counter cache for the specified model and association based
+     * on the model's counter cache behavior's configuration.
+     *
+     * @param \Cake\Console\Arguments $args The command arguments.
+     * @param \Cake\Console\ConsoleIo $io The console io
+     * @return int The exit code or null for success
+     */
+    public function execute(Arguments $args, ConsoleIo $io): int
+    {
+        $table = $this->fetchTable($args->getArgument('model'));
+
+        if (!$table->hasBehavior('CounterCache')) {
+            $io->error('The specified model does not have the CounterCache behavior attached.');
+
+            return static::CODE_ERROR;
+        }
+
+        $methodArgs = [];
+        if ($args->hasOption('assoc')) {
+            $methodArgs['assocName'] = $args->getOption('assoc');
+        }
+        if ($args->hasOption('limit')) {
+            $methodArgs['limit'] = (int)$args->getOption('limit');
+        }
+        if ($args->hasOption('page')) {
+            $methodArgs['page'] = (int)$args->getOption('page');
+        }
+
+        /** @phpstan-ignore-next-line */
+        $table->updateCounterCache(...$methodArgs);
+
+        $io->success('Counter cache updated successfully.');
+
+        return static::CODE_SUCCESS;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
+    {
+        $parser->setDescription(static::getDescription())
+            ->addArgument('model', [
+                'help' => 'The model to update the counter cache for.',
+                'required' => true,
+            ])->addOption('assoc', [
+                'help' => 'The association to update the counter cache for. By default all associations are updated.',
+                'short' => 'a',
+                'default' => null,
+            ])
+            ->addOption('limit', [
+                'help' => 'The number of records to update per page/iteration',
+                'short' => 'l',
+                'default' => null,
+            ])
+            ->addOption('page', [
+                'help' => 'The page/iteration number. By default all records will be updated one page at a time.',
+                'short' => 'p',
+                'default' => null,
+            ]);
+
+        return $parser;
+    }
+}

tests/TestCase/Command/CounterCacheCommandTest.php

@@ -0,0 +1,84 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP :  Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP Project
+ * @since         5.2.0
+ * @license       https://opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Cake\Test\TestCase\Command;
+
+use Cake\Console\TestSuite\ConsoleIntegrationTestTrait;
+use Cake\Datasource\ConnectionManager;
+use Cake\ORM\Table;
+use Cake\TestSuite\TestCase;
+
+/**
+ * CounterCacheCommandTest class
+ */
+class CounterCacheCommandTest extends TestCase
+{
+    use ConsoleIntegrationTestTrait;
+
+    protected array $fixtures = [
+        'core.CounterCacheComments',
+        'core.CounterCacheUsers',
+    ];
+
+    protected Table $Comments;
+    protected Table $Users;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->setAppNamespace();
+        $connection = ConnectionManager::get('test');
+
+        $this->getTableLocator()->get('Users', [
+            'table' => 'counter_cache_users',
+            'connection' => $connection,
+        ]);
+
+        $comments = $this->getTableLocator()->get('Comments', [
+            'table' => 'counter_cache_comments',
+            'connection' => $connection,
+        ]);
+
+        $comments->belongsTo('Users', [
+            'foreignKey' => 'user_id',
+        ]);
+
+        $comments->addBehavior('CounterCache', [
+            'Users' => ['comment_count'],
+        ]);
+    }
+
+    public function testExecute(): void
+    {
+        $this->exec('counter_cache Comments');
+        $this->assertExitSuccess();
+        $this->assertOutputContains('Counter cache updated successfully.');
+    }
+
+    public function testExecuteWithOptions(): void
+    {
+        $this->exec('counter_cache Comments --assoc Users --limit 1 --page 1');
+        $this->assertExitSuccess();
+    }
+
+    public function testExecuteFailure(): void
+    {
+        $this->exec('counter_cache Users');
+        $this->assertExitError();
+        $this->assertErrorContains('The specified model does not have the CounterCache behavior attached.');
+    }
+}