IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists (#385)

For more details see https://issues.ibexa.co/browse/IBX-8138 and #385 Key changes: * [Rector] Applied Symfony 5.1 CommandConstantReturnCodeRector * [Rector] Applied Symfony 5.2 RenameMethodRector * [Rector] Applied Symfony 5.3 Rector sets * [Rector] Applied Symfony code quality Rector sets Applied rules: * LiteralGetToRequestClassConstantRector * ResponseStatusCodeRector * MakeCommandLazyRector * [Rector] Applied Return type rectors Applied rules: * ReturnTypeFromStrictNativeCallRector * ReturnTypeFromStrictScalarReturnExprRector * [Rector] Applied Symfony 6.0 AddReturnTypeDeclarationRector * [Rector] Added Symfony Bundle::getContainerExtension return type * Added strict types for InstallPlatformCommand consts * Made XML serialization exception more verbose in Author and DateTime converters * Implemented `\Ibexa\Core\MVC\Symfony\Security\User::getUserIdentifier` --------- Co-Authored-By: Paweł Niedzielski <[email protected]> Co-Authored-By: Konrad Oboza <[email protected]>
ibexa · Aug 28, 2024 · 7e4312d · 7e4312d
1 parent 7c398f2
commit 7e4312d
Show file tree

Hide file tree

Showing 458 changed files with 1,047 additions and 1,301 deletions.
diff --git a/composer.json b/composer.json
@@ -16,6 +16,7 @@
         "ext-fileinfo": "*",
         "ext-intl": "*",
         "ext-json": "*",
+        "ext-libxml": "*",
         "ext-mbstring": "*",
         "ext-xsl": "*",
         "composer/package-versions-deprecated": "^1.11",

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
diff --git a/src/bundle/Core/Cache/Warmer/ProxyCacheWarmer.php b/src/bundle/Core/Cache/Warmer/ProxyCacheWarmer.php
@@ -47,8 +47,10 @@ public function isOptional(): bool
         return false;
     }
 
-    public function warmUp($cacheDir): void
+    public function warmUp($cacheDir): array
     {
         $this->proxyGenerator->warmUp(self::PROXY_CLASSES);
+
+        return [];
     }
 }
diff --git a/src/bundle/Core/Command/CheckURLsCommand.php b/src/bundle/Core/Command/CheckURLsCommand.php
@@ -106,7 +106,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
         $progress->finish();
 
-        return 0;
+        return self::SUCCESS;
     }
 
     private function getTotalCount(): int

diff --git a/src/bundle/Core/Command/CleanupVersionsCommand.php b/src/bundle/Core/Command/CleanupVersionsCommand.php
@@ -31,15 +31,21 @@ class CleanupVersionsCommand extends Command
 - Run this command in production environment using <info>--env=prod</info>
 EOT;
     public const VERSION_DRAFT = 'draft';
+
     public const VERSION_ARCHIVED = 'archived';
     public const VERSION_PUBLISHED = 'published';
     public const VERSION_ALL = 'all';
+
     public const VERSION_STATUS = [
         self::VERSION_DRAFT => VersionInfo::STATUS_DRAFT,
         self::VERSION_ARCHIVED => VersionInfo::STATUS_ARCHIVED,
         self::VERSION_PUBLISHED => VersionInfo::STATUS_PUBLISHED,
     ];
 
+    protected static $defaultName = 'ibexa:content:cleanup-versions';
+
+    protected static $defaultDescription = 'Removes unwanted content versions. Keeps the published version untouched. By default, also keeps the last archived/draft version.';
+
     private readonly Repository $repository;
 
     private readonly RepositoryConfigurationProviderInterface $repositoryConfigurationProvider;
@@ -62,8 +68,6 @@ protected function configure()
     {
         $beforeRunningHints = self::BEFORE_RUNNING_HINTS;
         $this
-            ->setName('ibexa:content:cleanup-versions')
-            ->setDescription('Removes unwanted content versions. Keeps the published version untouched. By default, also keeps the last archived/draft version.')
             ->addOption(
                 'status',
                 't',
@@ -144,7 +148,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         if ($contentIdsCount === 0) {
             $output->writeln('<info>There is no content matching the given Criteria.</info>');
 
-            return 0;
+            return self::SUCCESS;
         }
 
         $output->writeln(sprintf(
@@ -182,7 +186,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 ), OutputInterface::VERBOSITY_VERBOSE);
 
                 if ($removeAll) {
-                    $versions = array_filter($versions, static function (VersionInfo $version) {
+                    $versions = array_filter($versions, static function (VersionInfo $version): bool {
                         return $version->status !== VersionInfo::STATUS_PUBLISHED;
                     });
                 }
@@ -225,7 +229,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $contentIdsCount
         ));
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**

diff --git a/src/bundle/Core/Command/CopySubtreeCommand.php b/src/bundle/Core/Command/CopySubtreeCommand.php
@@ -28,6 +28,10 @@
  */
 class CopySubtreeCommand extends Command
 {
+    protected static $defaultName = 'ibexa:copy-subtree';
+
+    protected static $defaultDescription = 'Copies a subtree from one Location to another';
+
     /** @var \Ibexa\Contracts\Core\Repository\LocationService */
     private $locationService;
 
@@ -68,7 +72,6 @@ public function __construct(
     protected function configure()
     {
         $this
-            ->setName('ibexa:copy-subtree')
             ->addArgument(
                 'source-location-id',
                 InputArgument::REQUIRED,
@@ -85,8 +88,7 @@ protected function configure()
                 InputOption::VALUE_OPTIONAL,
                 'Ibexa username (with Role containing at least content policies: create, read)',
                 'admin'
-            )
-            ->setDescription('Copies a subtree from one Location to another');
+            );
     }
 
     /**
@@ -150,7 +152,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         );
 
         if (!$input->getOption('no-interaction') && !$questionHelper->ask($input, $output, $question)) {
-            return 0;
+            return self::SUCCESS;
         }
 
         $this->locationService->copySubtree(
@@ -162,7 +164,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             '<info>Finished</info>'
         );
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**

diff --git a/src/bundle/Core/Command/DebugConfigResolverCommand.php b/src/bundle/Core/Command/DebugConfigResolverCommand.php
@@ -19,6 +19,8 @@
 
 class DebugConfigResolverCommand extends Command
 {
+    protected static $defaultName = 'ibexa:debug:config-resolver';
+
     /** @var \Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface */
     private $configResolver;
 
@@ -40,7 +42,6 @@ public function __construct(
      */
     public function configure()
     {
-        $this->setName('ibexa:debug:config-resolver');
         $this->setAliases(['ibexa:debug:config']);
         $this->setDescription('Debugs / Retrieves a parameter from the Config Resolver');
         $this->addArgument(
@@ -96,7 +97,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         if ($input->getOption('json')) {
             $output->write(json_encode($parameterData));
 
-            return 0;
+            return self::SUCCESS;
         }
 
         $output->writeln('<comment>SiteAccess name:</comment> ' . $this->siteAccess->name);
@@ -111,6 +112,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             )
         );
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/src/bundle/Core/Command/DeleteContentTranslationCommand.php b/src/bundle/Core/Command/DeleteContentTranslationCommand.php
@@ -24,6 +24,10 @@
  */
 class DeleteContentTranslationCommand extends Command
 {
+    protected static $defaultName = 'ibexa:delete-content-translation';
+
+    protected static $defaultDescription = 'Deletes a translation from all versions of a Content item';
+
     /** @var \Ibexa\Contracts\Core\Repository\Repository */
     private $repository;
 
@@ -51,7 +55,6 @@ public function __construct(Repository $repository)
     protected function configure()
     {
         $this
-            ->setName('ibexa:delete-content-translation')
             ->addArgument('content-id', InputArgument::REQUIRED, 'Content Object Id')
             ->addArgument(
                 'language-code',
@@ -64,8 +67,7 @@ protected function configure()
                 InputOption::VALUE_OPTIONAL,
                 'Ibexa username (with Role containing at least content Policies: read, versionread, edit, remove, versionremove)',
                 'admin'
-            )
-            ->setDescription('Deletes a translation from all versions of a Content item');
+            );
     }
 
     protected function initialize(InputInterface $input, OutputInterface $output)
@@ -125,7 +127,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $this->repository->rollback();
                 $this->output->writeln('Reverting and aborting.');
 
-                return 0;
+                return self::SUCCESS;
             }
 
             // Delete Translation
@@ -142,7 +144,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             throw $e;
         }
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**
@@ -167,7 +169,7 @@ private function promptUserForMainLanguageChange(
         // get main Translation candidates w/o Translation being removed
         $mainTranslationCandidates = array_filter(
             $lastVersionLanguageCodes,
-            static function ($versionLanguageCode) use ($languageCode) {
+            static function ($versionLanguageCode) use ($languageCode): bool {
                 return $versionLanguageCode !== $languageCode;
             }
         );

diff --git a/src/bundle/Core/Command/ExpireUserPasswordsCommand.php b/src/bundle/Core/Command/ExpireUserPasswordsCommand.php
@@ -29,6 +29,8 @@ final class ExpireUserPasswordsCommand extends Command
 {
     protected static $defaultName = 'ibexa:user:expire-password';
 
+    protected static $defaultDescription = 'Expire passwords for selected users.';
+
     public const REQUIRE_NEW_PASSWORD_VALUE = true;
 
     public const DEFAULT_BATCH_SIZE = 50;
@@ -71,7 +73,6 @@ protected function configure(): void
     {
         $beforeRunningHints = self::BEFORE_RUNNING_HINTS;
         $this
-            ->setDescription('Expire passwords for selected users.')
             ->addOption(
                 'user-id',
                 'u',
@@ -147,7 +148,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         if ($totalCount === 0) {
             $output->writeln('<info>There are no users matching given criteria</info>');
 
-            return Command::SUCCESS;
+            return self::SUCCESS;
         }
 
         $output->writeln(sprintf(
@@ -212,7 +213,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             );
         }
 
-        return Command::SUCCESS;
+        return self::SUCCESS;
     }
 
     /**

diff --git a/src/bundle/Core/Command/NormalizeImagesPathsCommand.php b/src/bundle/Core/Command/NormalizeImagesPathsCommand.php
@@ -39,6 +39,8 @@ final class NormalizeImagesPathsCommand extends Command
 
     protected static $defaultName = 'ibexa:images:normalize-paths';
 
+    protected static $defaultDescription = 'Normalizes stored paths for images.';
+
     /** @var \Ibexa\Core\FieldType\Image\ImageStorage\Gateway */
     private $imageGateway;
 
@@ -73,7 +75,6 @@ protected function configure()
         $beforeRunningHints = self::BEFORE_RUNNING_HINTS;
 
         $this
-            ->setDescription('Normalizes stored paths for images.')
             ->addOption(
                 self::SKIP_HASHING_COMMAND_PARAMETER,
                 null,
@@ -112,11 +113,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         if ($imagePathsToNormalizeCount === 0) {
             $io->success('No paths to normalize.');
 
-            return 0;
+            return self::SUCCESS;
         }
 
         if (!$io->confirm('Do you want to continue?')) {
-            return 0;
+            return self::SUCCESS;
         }
 
         $io->writeln('Normalizing image paths. Please wait...');
@@ -135,7 +136,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $io->progressFinish();
         $io->success('Done!');
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**
@@ -232,7 +233,7 @@ private function getFinalNormalizedPath(
         $processedPaths = array_values(
             array_filter(
                 $imagePathsToNormalize,
-                static function (array $data) use ($filePath) {
+                static function (array $data) use ($filePath): bool {
                     return $data['oldPath'] === $filePath;
                 }
             )

diff --git a/src/bundle/Core/Command/RegenerateUrlAliasesCommand.php b/src/bundle/Core/Command/RegenerateUrlAliasesCommand.php
@@ -21,7 +21,7 @@
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 
 /**
- * The ezplatform:urls:regenerate-aliases Symfony command implementation.
+ * The ibexa:urls:regenerate-aliases Symfony command implementation.
  * Recreates system URL aliases for all existing Locations and cleanups corrupted URL alias nodes.
  */
 class RegenerateUrlAliasesCommand extends Command
@@ -36,6 +36,8 @@ class RegenerateUrlAliasesCommand extends Command
 - Manually clear HTTP cache after running this command.
 EOT;
 
+    protected static $defaultName = 'ibexa:urls:regenerate-aliases';
+
     /** @var \Ibexa\Contracts\Core\Repository\Repository */
     private $repository;
 
@@ -61,7 +63,6 @@ protected function configure()
     {
         $beforeRunningHints = self::BEFORE_RUNNING_HINTS;
         $this
-            ->setName('ibexa:urls:regenerate-aliases')
             ->setDescription(
                 'Regenerates Location URL aliases (autogenerated) and cleans up custom Location ' .
                 'and global URL aliases stored in the Legacy Storage Engine'
@@ -116,7 +117,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $locationsCount = count($locationIds);
         } else {
             $locationsCount = $this->repository->sudo(
-                static function (Repository $repository) {
+                static function (Repository $repository): int {
                     return $repository->getLocationService()->getAllLocationsCount();
                 }
             );
@@ -125,7 +126,7 @@ static function (Repository $repository) {
         if ($locationsCount === 0) {
             $output->writeln('<info>No location was found. Exiting.</info>');
 
-            return 0;
+            return self::SUCCESS;
         }
 
         if (!$input->getOption('no-interaction')) {
@@ -139,24 +140,24 @@ static function (Repository $repository) {
                 false
             );
             if (!$helper->ask($input, $output, $question)) {
-                return 0;
+                return self::SUCCESS;
             }
         } elseif (!$input->getOption('force')) {
-            return 1;
+            return self::FAILURE;
         }
 
         $this->regenerateSystemUrlAliases($output, $locationsCount, $locationIds, $iterationCount);
 
         $output->writeln('<info>Cleaning up corrupted URL aliases...</info>');
         $corruptedAliasesCount = $this->repository->sudo(
-            static function (Repository $repository) {
+            static function (Repository $repository): int {
                 return $repository->getURLAliasService()->deleteCorruptedUrlAliases();
             }
         );
         $output->writeln("<info>Done. Deleted {$corruptedAliasesCount} entries.</info>");
         $output->writeln('<comment>Make sure to clear HTTP cache.</comment>');
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**