Address PHPMD and PHPStan errors

sivaram7 · sivaram7 · commit 79d94a87879b · 2025-01-28T15:31:29.000-06:00
diff --git a/src/App/Container.php b/src/App/Container.php
@@ -21,7 +21,7 @@
 /**
  * @inheritdoc
  * @codeCoverageIgnore
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class Container implements ContainerInterface
 {
diff --git a/src/App/GenericException.php b/src/App/GenericException.php
@@ -12,7 +12,7 @@
 /**
  * Base exception for general purposes.
  *
- * @SuppressWarnings(PHPMD.NumberOfChildren)
+ * @SuppressWarnings("PHPMD.NumberOfChildren")
  */
 class GenericException extends \Exception
 {
diff --git a/src/App/Logger/Formatter/JsonErrorFormatter.php b/src/App/Logger/Formatter/JsonErrorFormatter.php
@@ -53,6 +53,7 @@ public function __construct(
     public function format(\Monolog\LogRecord|array $record): string
     {
         // Monolog version 3 or higher.
+        /** @phpstan-ignore-next-line */
         if (\Monolog\Logger::API == 3) {
             try {
                 /** @phpstan-ignore-next-line */
diff --git a/src/App/Logger/HandlerFactory.php b/src/App/Logger/HandlerFactory.php
@@ -23,7 +23,7 @@
 /**
  * The handler factory.
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class HandlerFactory
 {
@@ -73,7 +73,7 @@ public function __construct(
      * @return AbstractProcessingHandler
      * @throws LoggerException
      *
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
      */
     public function create(string $handler): AbstractProcessingHandler
     {
@@ -172,6 +172,7 @@ private function normalizeLevel(string $level): int
         /** @phpstan-ignore-next-line */
         $normalizedLevel = Logger::toMonologLevel($level);
 
+        /** @phpstan-ignore-next-line */
         if (\Monolog\Logger::API == 3) {
             /** @phpstan-ignore-next-line */
             $normalizedLevel =  $normalizedLevel->value;
diff --git a/src/App/Logger/Processor/SanitizeProcessor.php b/src/App/Logger/Processor/SanitizeProcessor.php
@@ -33,7 +33,7 @@ public function __construct(Sanitizer $sanitizer)
     public function __invoke(\Monolog\LogRecord|array $record)
     {
         // Monolog version 3 or higher.
-        if (\Monolog\Logger::API == 3) {
+        if (\Monolog\Logger::API == 3) { // @phpstan-ignore-line
             $message = $this->sanitizer->sanitize($record->message); // @phpstan-ignore-line
             // Create new LogRecord from existing and update the message,
             // since message is read only
diff --git a/src/Application.php b/src/Application.php
@@ -15,7 +15,7 @@
 /**
  * @inheritdoc
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class Application extends \Symfony\Component\Console\Application
 {
diff --git a/src/Command/ConfigShow/Renderer.php b/src/Command/ConfigShow/Renderer.php
@@ -114,7 +114,7 @@ protected function renderTable(OutputInterface $output, string $title, array $he
         $table = new Table($output);
         $table->setHeaders($header)
             ->setRows($rows);
-        if (method_exists($table, 'setColumnWidth')) {
+        if (method_exists($table, 'setColumnWidth')) { // @phpstan-ignore-line
             $table->setColumnWidth(0, 40);
             $table->setColumnWidth(1, 60);
         }
diff --git a/src/Command/ConfigValidate.php b/src/Command/ConfigValidate.php
@@ -53,7 +53,7 @@ protected function configure(): void
      * @param OutputInterface $output
      * @return int
      *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function execute(InputInterface $input, OutputInterface $output)
     {
diff --git a/src/Command/Dev/GenerateSchemaError.php b/src/Command/Dev/GenerateSchemaError.php
@@ -17,7 +17,7 @@
 
 /**
  * @codeCoverageIgnore
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class GenerateSchemaError extends Command
 {
@@ -60,7 +60,7 @@ protected function configure(): void
     /**
      * @inheritdoc
      *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
diff --git a/src/Command/Dev/UpdateComposer.php b/src/Command/Dev/UpdateComposer.php
@@ -102,7 +102,7 @@ protected function configure(): void
      * @throws ConfigException
      * @throws FileSystemException
      *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
diff --git a/src/Config/Factory/Cache.php b/src/Config/Factory/Cache.php
@@ -218,7 +218,7 @@ private function isCacheConfigurationValid(array $cacheConfiguration): bool
      * @param array $redisConfig
      * @return bool
      * @throws ConfigException
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
      */
     private function isConfigurationCompatibleWithSlaveConnection(
         array $envCacheConfig,
diff --git a/src/Config/Validator/Build/BalerSupport.php b/src/Config/Validator/Build/BalerSupport.php
@@ -47,7 +47,7 @@ public function __construct(
 
     /**
      * {@inheritdoc}
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
      */
     public function validate(): Validator\ResultInterface
     {
diff --git a/src/Config/Validator/Deploy/AppropriateVersion.php b/src/Config/Validator/Deploy/AppropriateVersion.php
@@ -51,7 +51,7 @@ public function __construct(
     /**
      * @return Validator\ResultInterface
      *
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
      */
     public function validate(): Validator\ResultInterface
     {
diff --git a/src/Config/Validator/Deploy/DeprecatedVariables.php b/src/Config/Validator/Deploy/DeprecatedVariables.php
@@ -48,8 +48,8 @@ public function __construct(
      *
      * {@inheritdoc}
      * Despite PHPMD warnings, this method is ultimately very linear: 1) Check condition; 2) Append error; etc.
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
-     * @SuppressWarnings(PHPMD.NPathComplexity)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
+     * @SuppressWarnings("PHPMD.NPathComplexity")
      */
     public function validate(): Validator\ResultInterface
     {
diff --git a/src/Config/Validator/Deploy/ElasticSearchVersion.php b/src/Config/Validator/Deploy/ElasticSearchVersion.php
@@ -24,7 +24,7 @@
 /**
  * Validates compatibility of elasticsearch and magento versions.
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class ElasticSearchVersion implements ValidatorInterface
 {
diff --git a/src/Service/OpenSearch.php b/src/Service/OpenSearch.php
@@ -47,7 +47,7 @@ public function __construct(
      * Return full engine name.
      *
      * @return string
-     * @throws ServiceException
+     * @throws ServiceException // @phpstan-ignore-line
      */
     public function getFullEngineName(): string
     {
diff --git a/src/StaticContent/CommandFactory.php b/src/StaticContent/CommandFactory.php
@@ -128,8 +128,8 @@ public function matrix(OptionInterface $option, array $matrix): array
     /**
      * @param OptionInterface $option
      * @return string
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
-     * @SuppressWarnings(PHPMD.NPathComplexity)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
+     * @SuppressWarnings("PHPMD.NPathComplexity")
      */
     private function build(OptionInterface $option): string
     {
diff --git a/src/Step/Deploy/InstallUpdate/ConfigUpdate/DbConnection.php b/src/Step/Deploy/InstallUpdate/ConfigUpdate/DbConnection.php
@@ -27,7 +27,7 @@
 /**
  * Updates DB connection configuration.
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class DbConnection implements StepInterface
 {
diff --git a/src/Step/Deploy/InstallUpdate/Install/Setup/InstallCommandFactory.php b/src/Step/Deploy/InstallUpdate/Install/Setup/InstallCommandFactory.php
@@ -28,8 +28,8 @@
 /**
  * Generates command for magento installation
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
- * @SuppressWarnings(PHPMD.NPathComplexity)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
+ * @SuppressWarnings("PHPMD.NPathComplexity")
  */
 class InstallCommandFactory
 {
@@ -111,7 +111,7 @@ class InstallCommandFactory
      * @param RemoteStorage $remoteStorage
      * @param AmqpConfig $amqpConfig
      *
-     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
+     * @SuppressWarnings("PHPMD.ExcessiveParameterList")
      */
     public function __construct(
         UrlManager $urlManager,
@@ -244,7 +244,7 @@ private function getAdminOptions(): array
      * @throws UndefinedPackageException
      * @throws ConfigException
      * @throws ServiceException
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
      */
     private function getEsOptions(): array
     {
diff --git a/src/Step/Deploy/PreDeploy/CleanRedisCache.php b/src/Step/Deploy/PreDeploy/CleanRedisCache.php
@@ -18,8 +18,8 @@
 /**
  * Cleans Redis cache.
  *
- * @SuppressWarnings(PHPMD.CyclomaticComplexity)
- * @SuppressWarnings(PHPMD.NPathComplexity)
+ * @SuppressWarnings("PHPMD.CyclomaticComplexity")
+ * @SuppressWarnings("PHPMD.NPathComplexity")
  */
 class CleanRedisCache implements StepInterface
 {
diff --git a/src/Step/Deploy/PreDeploy/ConfigUpdate/Cache.php b/src/Step/Deploy/PreDeploy/ConfigUpdate/Cache.php
@@ -21,7 +21,7 @@
 /**
  * Processes cache configuration.
  *
- * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+ * @SuppressWarnings("PHPMD.CyclomaticComplexity")
  */
 class Cache implements StepInterface
 {
diff --git a/src/Step/Deploy/RemoteStorage.php b/src/Step/Deploy/RemoteStorage.php
@@ -64,8 +64,8 @@ public function __construct(
      * Enables or disables remote storage.
      *
      * @throws StepException
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
-     * @SuppressWarnings(PHPMD.NPathComplexity)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
+     * @SuppressWarnings("PHPMD.NPathComplexity")
      */
     public function execute(): void
     {
diff --git a/src/Step/Deploy/SplitDbConnection.php b/src/Step/Deploy/SplitDbConnection.php
@@ -27,7 +27,7 @@
  *
  * {@inheritDoc}
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  * @deprecated started from Magento 2.4.2 and will be removed in 2.5.0
  */
 class SplitDbConnection implements StepInterface
diff --git a/src/Step/PostDeploy/WarmUp.php b/src/Step/PostDeploy/WarmUp.php
@@ -62,7 +62,7 @@ public function __construct(
 
     /**
      * {@inheritdoc}
-     * @SuppressWarnings(PHPMD.UnusedLocalVariable)
+     * @SuppressWarnings("PHPMD.UnusedLocalVariable")
      */
     public function execute()
     {
diff --git a/src/Test/Unit/Command/ConfigShow/RendererTest.php b/src/Test/Unit/Command/ConfigShow/RendererTest.php
@@ -61,6 +61,9 @@ protected function setUp(): void
         $this->renderer = new Renderer($this->loggerMock, $this->environmentMock);
     }
 
+    /**
+     * @SuppressWarnings("PHPMD.NPathComplexity")
+     */
     public function testPrintRelationships()
     {
         $this->environmentMock->expects($this->once())
@@ -115,6 +118,9 @@ public function testPrintRelationships()
         $this->renderer->printRelationships($this->outputMock);
     }
 
+    /**
+     * @SuppressWarnings("PHPMD.NPathComplexity")
+     */
     public function testPrintRoutes()
     {
         $this->environmentMock->expects($this->once())
@@ -168,6 +174,10 @@ public function testPrintRoutes()
         $this->renderer->printRoutes($this->outputMock);
     }
 
+    /**
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
+     * @SuppressWarnings("PHPMD.NPathComplexity")
+     */
     public function testPrintVariables()
     {
         $this->environmentMock->expects($this->once())
diff --git a/src/Test/Unit/Config/Validator/Deploy/ServiceVersionTest.php b/src/Test/Unit/Config/Validator/Deploy/ServiceVersionTest.php
@@ -147,6 +147,9 @@ public function testValidate(): void
         $this->validator->validate();
     }
 
+    /**
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
+     */
     public function testValidateWithErrors(): void
     {
         $this->databaseTypeMock->expects($this->once())
diff --git a/src/Test/Unit/Step/ValidateConfigurationTest.php b/src/Test/Unit/Step/ValidateConfigurationTest.php
@@ -164,6 +164,7 @@ public function testExecuteWithWarningMessage(): void
 
     /**
      * @throws StepException
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
      */
     public function testExecuteWithWarningAndCriticalMessage(): void
     {
@@ -224,6 +225,7 @@ public function testExecuteWithWarningAndCriticalMessage(): void
 
     /**
      * @throws StepException
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
      */
     public function testExecuteTypeStringLevel(): void
     {

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`/**`
`22`	`22`	`* @inheritdoc`
`23`	`23`	`* @codeCoverageIgnore`
`24`		`- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`24`	`+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")`
`25`	`25`	`*/`
`26`	`26`	`class Container implements ContainerInterface`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`/**`
`13`	`13`	`* Base exception for general purposes.`
`14`	`14`	`*`
`15`		`- * @SuppressWarnings(PHPMD.NumberOfChildren)`
	`15`	`+ * @SuppressWarnings("PHPMD.NumberOfChildren")`
`16`	`16`	`*/`
`17`	`17`	`class GenericException extends \Exception`
`18`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ public function __construct(`
`53`	`53`	`public function format(\Monolog\LogRecord\|array $record): string`
`54`	`54`	`{`
`55`	`55`	`// Monolog version 3 or higher.`
	`56`	`+ /** @phpstan-ignore-next-line */`
`56`	`57`	`if (\Monolog\Logger::API == 3) {`
`57`	`58`	`try {`
`58`	`59`	`/** @phpstan-ignore-next-line */`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`/**`
`24`	`24`	`* The handler factory.`
`25`	`25`	`*`
`26`		`- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`26`	`+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")`
`27`	`27`	`*/`
`28`	`28`	`class HandlerFactory`
`29`	`29`	`{`
`@@ -73,7 +73,7 @@ public function __construct(`
`73`	`73`	`* @return AbstractProcessingHandler`
`74`	`74`	`* @throws LoggerException`
`75`	`75`	`*`
`76`		`- * @SuppressWarnings(PHPMD.CyclomaticComplexity)`
	`76`	`+ * @SuppressWarnings("PHPMD.CyclomaticComplexity")`
`77`	`77`	`*/`
`78`	`78`	`public function create(string $handler): AbstractProcessingHandler`
`79`	`79`	`{`
`@@ -172,6 +172,7 @@ private function normalizeLevel(string $level): int`
`172`	`172`	`/** @phpstan-ignore-next-line */`
`173`	`173`	`$normalizedLevel = Logger::toMonologLevel($level);`
`174`	`174`
	`175`	`+ /** @phpstan-ignore-next-line */`
`175`	`176`	`if (\Monolog\Logger::API == 3) {`
`176`	`177`	`/** @phpstan-ignore-next-line */`
`177`	`178`	`$normalizedLevel = $normalizedLevel->value;`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function __construct(Sanitizer $sanitizer)`
`33`	`33`	`public function __invoke(\Monolog\LogRecord\|array $record)`
`34`	`34`	`{`
`35`	`35`	`// Monolog version 3 or higher.`
`36`		`- if (\Monolog\Logger::API == 3) {`
	`36`	`+ if (\Monolog\Logger::API == 3) { // @phpstan-ignore-line`
`37`	`37`	`$message = $this->sanitizer->sanitize($record->message); // @phpstan-ignore-line`
`38`	`38`	`// Create new LogRecord from existing and update the message,`
`39`	`39`	`// since message is read only`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`/**`
`16`	`16`	`* @inheritdoc`
`17`	`17`	`*`
`18`		`- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`18`	`+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")`
`19`	`19`	`*/`
`20`	`20`	`class Application extends \Symfony\Component\Console\Application`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ protected function renderTable(OutputInterface $output, string $title, array $he`
`114`	`114`	`$table = new Table($output);`
`115`	`115`	`$table->setHeaders($header)`
`116`	`116`	`->setRows($rows);`
`117`		`- if (method_exists($table, 'setColumnWidth')) {`
	`117`	`+ if (method_exists($table, 'setColumnWidth')) { // @phpstan-ignore-line`
`118`	`118`	`$table->setColumnWidth(0, 40);`
`119`	`119`	`$table->setColumnWidth(1, 60);`
`120`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ protected function configure(): void`
`53`	`53`	`* @param OutputInterface $output`
`54`	`54`	`* @return int`
`55`	`55`	`*`
`56`		`- * @SuppressWarnings(PHPMD.UnusedFormalParameter)`
	`56`	`+ * @SuppressWarnings("PHPMD.UnusedFormalParameter")`
`57`	`57`	`*/`
`58`	`58`	`public function execute(InputInterface $input, OutputInterface $output)`
`59`	`59`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* @codeCoverageIgnore`
`20`		`- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`20`	`+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")`
`21`	`21`	`*/`
`22`	`22`	`class GenerateSchemaError extends Command`
`23`	`23`	`{`
`@@ -60,7 +60,7 @@ protected function configure(): void`
`60`	`60`	`/**`
`61`	`61`	`* @inheritdoc`
`62`	`62`	`*`
`63`		`- * @SuppressWarnings(PHPMD.UnusedFormalParameter)`
	`63`	`+ * @SuppressWarnings("PHPMD.UnusedFormalParameter")`
`64`	`64`	`*/`
`65`	`65`	`protected function execute(InputInterface $input, OutputInterface $output): int`
`66`	`66`	`{`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ protected function configure(): void`
`102`	`102`	`* @throws ConfigException`
`103`	`103`	`* @throws FileSystemException`
`104`	`104`	`*`
`105`		`- * @SuppressWarnings(PHPMD.UnusedFormalParameter)`
	`105`	`+ * @SuppressWarnings("PHPMD.UnusedFormalParameter")`
`106`	`106`	`*/`
`107`	`107`	`protected function execute(InputInterface $input, OutputInterface $output): int`
`108`	`108`	`{`