DevKit updates for 3.x branch (#1544)

* DevKit updates * Fix cs Co-authored-by: Vincent Langlet <vincentlanglet@hotmail.fr>
sonata-project · Aug 11, 2022 · dff04de · dff04de
1 parent 25cde10
commit dff04de
Show file tree

Hide file tree

Showing 28 changed files with 153 additions and 168 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -27,38 +27,26 @@
 HEADER;
 
 $rules = [
-    '@PHP70Migration' => true,
-    '@PHP70Migration:risky' => true,
-    '@PHP71Migration' => true,
-    '@PHP71Migration:risky' => true,
-    '@PHPUnit57Migration:risky' => true,
-    '@PHPUnit60Migration:risky' => true,
+    '@PHP74Migration' => true,
+    '@PHP74Migration:risky' => true,
+    '@PSR12' => true,
+    '@PSR12:risky' => true,
     '@Symfony' => true,
     '@Symfony:risky' => true,
-    'array_syntax' => ['syntax' => 'short'],
     'combine_consecutive_issets' => true,
     'combine_consecutive_unsets' => true,
-    'compact_nullable_typehint' => true,
     'global_namespace_import' => ['import_classes' => false, 'import_constants' => false, 'import_functions' => false],
     'header_comment' => ['header' => $header],
     'list_syntax' => ['syntax' => 'short'],
-    'logical_operators' => true,
     'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
     'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'],
-    'no_extra_blank_lines' => true,
-    'no_php4_constructor' => true,
-    'no_superfluous_phpdoc_tags' => ['allow_mixed' => true],
     'no_useless_else' => true,
     'no_useless_return' => true,
     'nullable_type_declaration_for_default_null_value' => ['use_nullable_type_declaration' => true],
     'ordered_class_elements' => true,
     'ordered_imports' => ['sort_algorithm' => 'alpha', 'imports_order' => ['class', 'function', 'const']],
-    'php_unit_method_casing' => false,
-    'php_unit_set_up_tear_down_visibility' => true,
     'php_unit_strict' => true,
-    'php_unit_test_annotation' => false,
     'php_unit_test_case_static_method_calls' => true,
-    'phpdoc_order' => true,
     'phpdoc_to_comment' => ['ignored_tags' => ['psalm-suppress']],
     'single_line_throw' => false,
     'static_lambda' => true,

diff --git a/src/Admin/Extension/CreateSnapshotAdminExtension.php b/src/Admin/Extension/CreateSnapshotAdminExtension.php
@@ -34,7 +34,7 @@ class CreateSnapshotAdminExtension extends AbstractAdminExtension
      */
     protected $backend;
 
-    //NEXT_MAJOR: restrict type to CreateSnapshotByPageInterface
+    // NEXT_MAJOR: restrict type to CreateSnapshotByPageInterface
     public function __construct($backend)
     {
         $this->backend = $backend;
@@ -65,15 +65,15 @@ protected function sendMessage($object)
     {
         if ($object instanceof BlockInterface && method_exists($object, 'getPage')) {
             $page = $object->getPage();
-            $pageId = $page->getId(); //NEXT_MAJOR: Remove this line.
+            $pageId = $page->getId(); // NEXT_MAJOR: Remove this line.
         } elseif ($object instanceof PageInterface) {
             $page = $object;
-            $pageId = $page->getId(); //NEXT_MAJOR: Remove this line.
+            $pageId = $page->getId(); // NEXT_MAJOR: Remove this line.
         } else {
             return;
         }
 
-        //NEXT_MAJOR: Remove the if code and all code related with BackendInterface
+        // NEXT_MAJOR: Remove the if code and all code related with BackendInterface
         if ($this->backend instanceof BackendInterface) {
             @trigger_error(
                 sprintf(

diff --git a/src/Block/BreadcrumbBlockService.php b/src/Block/BreadcrumbBlockService.php
@@ -55,7 +55,7 @@ public function getName()
 
     public function getBlockMetadata($code = null)
     {
-        return new Metadata($this->getName(), ($code ?? $this->getName()), false, 'SonataPageBundle', [
+        return new Metadata($this->getName(), $code ?? $this->getName(), false, 'SonataPageBundle', [
             'class' => 'fa fa-bars',
         ]);
     }

diff --git a/src/Block/ContainerBlockService.php b/src/Block/ContainerBlockService.php
@@ -43,7 +43,7 @@ public function configureSettings(OptionsResolver $resolver)
 
     public function getBlockMetadata($code = null)
     {
-        return new Metadata($this->getName(), ($code ?? $this->getName()), false, 'SonataPageBundle', [
+        return new Metadata($this->getName(), $code ?? $this->getName(), false, 'SonataPageBundle', [
             'class' => 'fa fa-square-o',
         ]);
     }

diff --git a/src/Block/PageListBlockService.php b/src/Block/PageListBlockService.php
@@ -113,7 +113,7 @@ public function configureSettings(OptionsResolver $resolver)
 
     public function getBlockMetadata($code = null)
     {
-        return new Metadata($this->getName(), ($code ?? $this->getName()), false, 'SonataPageBundle', [
+        return new Metadata($this->getName(), $code ?? $this->getName(), false, 'SonataPageBundle', [
             'class' => 'fa fa-home',
         ]);
     }

diff --git a/src/CmsManager/DecoratorStrategy.php b/src/CmsManager/DecoratorStrategy.php
@@ -55,7 +55,7 @@ public function isDecorable(Request $request, $requestType, Response $response)
             return false;
         }
 
-        if ('text/html' !== (substr($response->headers->get('Content-Type') ?: 'text/html', 0, 9))) {
+        if ('text/html' !== substr($response->headers->get('Content-Type') ?: 'text/html', 0, 9)) {
             return false;
         }
 

diff --git a/src/Command/CleanupSnapshotsCommand.php b/src/Command/CleanupSnapshotsCommand.php
@@ -32,24 +32,24 @@ public function configure()
         $this->setDescription('Cleanups the deprecated snapshots by a given site');
 
         $this->addOption('site', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Site id');
-        //NEXT_MAJOR: Remove the "base-console" option.
+        // NEXT_MAJOR: Remove the "base-console" option.
         $this->addOption('base-console', null, InputOption::VALUE_OPTIONAL, 'Base Symfony console command', 'app/console');
-        //NEXT_MAJOR: Remove the "mode" option.
+        // NEXT_MAJOR: Remove the "mode" option.
         $this->addOption('mode', null, InputOption::VALUE_OPTIONAL, 'Run the command asynchronously', 'sync');
         $this->addOption('keep-snapshots', null, InputOption::VALUE_OPTIONAL, 'Keep a given count of snapshots per page', 5);
     }
 
     protected function initialize(InputInterface $input, OutputInterface $output)
     {
-        //NEXT_MAJOR: Remove this condition.
+        // NEXT_MAJOR: Remove this condition.
         if ('app/console' !== $input->getOption('base-console')) {
             @trigger_error(
                 'The "base-console" is deprecated since sonata-project/page-bundle 3.27.0 and will be removed in 4.0',
                 \E_USER_DEPRECATED
             );
         }
 
-        //NEXT_MAJOR: Remove this condition.
+        // NEXT_MAJOR: Remove this condition.
         if (!\in_array($input->getOption('mode'), ['async', 'sync'], true)) {
             throw new \InvalidArgumentException('Option "mode" is not valid (async|sync).');
         }
@@ -66,14 +66,14 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $siteOption = $input->getOption('site');
         $keepSnapshots = $input->getOption('keep-snapshots');
 
-        //NEXT_MAJOR: Remove this condition, because site will be optional.
+        // NEXT_MAJOR: Remove this condition, because site will be optional.
         if ([] === $siteOption) {
             $output->writeln('Please provide an <info>--site=SITE_ID</info> option or the <info>--site=all</info> directive');
 
             return 1;
         }
 
-        //NEXT_MAJOR: Remove this block condition.
+        // NEXT_MAJOR: Remove this block condition.
         if (['all'] === $siteOption) {
             @trigger_error(
                 sprintf(
@@ -88,7 +88,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         foreach ($this->getSites($siteOption) as $site) {
-            //NEXT_MAJOR: Remove this "async" block condition.
+            // NEXT_MAJOR: Remove this "async" block condition.
             if ('async' === $input->getOption('mode')) {
                 @trigger_error(
                     'The async mode is deprecated since sonata-project/page-bundle 3.27.0 and will be removed in 4.0',
@@ -108,7 +108,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
             $output->write(sprintf('<info>%s</info> - Cleaning up snapshots ...', $site->getName()));
 
-            //NEXT_MAJOR: inject this class in the constructor CleanupSnapshotBySiteInterface $cleanupSnapshot
+            // NEXT_MAJOR: inject this class in the constructor CleanupSnapshotBySiteInterface $cleanupSnapshot
             $cleanupSnapshot = $this->getContainer()->get('sonata.page.service.cleanup_snapshot');
             $cleanupSnapshot->cleanupBySite($site, $keepSnapshots);
 
@@ -129,7 +129,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
      */
     protected function getSites($ids): array
     {
-        //NEXT_MAJOR: Inject this on the __construct.
+        // NEXT_MAJOR: Inject this on the __construct.
         $siteManager = $this->getContainer()->get('sonata.page.manager.site');
 
         if ([] === $ids) {

diff --git a/src/Command/CloneSiteCommand.php b/src/Command/CloneSiteCommand.php
@@ -136,7 +136,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 }
             }
 
-            //NEXT_MAJOR: Remove this target condition block.
+            // NEXT_MAJOR: Remove this target condition block.
             if ($page->getTarget()) {
                 @trigger_error(
                     'target page is deprecate since sonata-project/page-bundle 3.27.0'.

diff --git a/src/Command/CreateSiteCommand.php b/src/Command/CreateSiteCommand.php
@@ -49,9 +49,9 @@ public function configure()
 
         $this->setHelp(
             <<<'EOT'
-The <info>sonata:page:create-site</info> command create a new site entity.
+                The <info>sonata:page:create-site</info> command create a new site entity.
 
-EOT
+                EOT
         );
     }
 
@@ -100,12 +100,12 @@ public function execute(InputInterface $input, OutputInterface $output)
         $output->writeln(
             <<<INFO
 
-Creating website with the following information :
-  <info>name</info> : {$site->getName()}
-  <info>site</info> : http(s)://{$site->getHost()}{$site->getRelativePath()}
-  <info>enabled</info> :  <info>from</info> {$info_enabledFrom} => <info>to</info> {$info_enabledTo}
+                Creating website with the following information :
+                  <info>name</info> : {$site->getName()}
+                  <info>site</info> : http(s)://{$site->getHost()}{$site->getRelativePath()}
+                  <info>enabled</info> :  <info>from</info> {$info_enabledFrom} => <info>to</info> {$info_enabledTo}
 
-INFO
+                INFO
         );
 
         $confirmation = true;

diff --git a/src/Command/CreateSnapshotsCommand.php b/src/Command/CreateSnapshotsCommand.php
@@ -42,7 +42,7 @@ class CreateSnapshotsCommand extends BaseCommand
      */
     public function __construct($createSnapshot = null)
     {
-        //NEXT_MAJOR: Remove the "if" condition and let only the "else" code.
+        // NEXT_MAJOR: Remove the "if" condition and let only the "else" code.
         if (\is_string($createSnapshot) || null === $createSnapshot) {
             @trigger_error(sprintf(
                 'The %s class is final since sonata-project/page-bundle 3.27.0 and and it will be removed in 4.0'
@@ -60,32 +60,32 @@ public function configure()
     {
         $this->setDescription('Create a snapshots of all pages available');
         $this->addOption('site', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Site id');
-        //NEXT_MAJOR: Remove the "base-console" option.
+        // NEXT_MAJOR: Remove the "base-console" option.
         $this->addOption('base-console', null, InputOption::VALUE_OPTIONAL, 'Base symfony console command', 'php app/console');
-        //NEXT_MAJOR: Remove the "mode" option.
+        // NEXT_MAJOR: Remove the "mode" option.
         $this->addOption('mode', null, InputOption::VALUE_OPTIONAL, 'Run the command asynchronously', 'sync');
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
     {
         $siteOption = $input->getOption('site');
 
-        //NEXT_MAJOR: Remove this condition.
+        // NEXT_MAJOR: Remove this condition.
         if ('php app/console' !== $input->getOption('base-console')) {
             @trigger_error(
                 'The "base-console" is deprecated since sonata-project/page-bundle 3.27.0 and will be removed in 4.0',
                 \E_USER_DEPRECATED
             );
         }
 
-        //NEXT_MAJOR: Remove this condition, because site will be optional
+        // NEXT_MAJOR: Remove this condition, because site will be optional
         if ([] === $siteOption) {
             $output->writeln('Please provide an <info>--site=SITE_ID</info> option or the <info>--site=all</info> directive');
 
             return 1;
         }
 
-        //NEXT_MAJOR: Remove this block condition.
+        // NEXT_MAJOR: Remove this block condition.
         if (['all'] === $siteOption) {
             @trigger_error(
                 sprintf(
@@ -138,7 +138,7 @@ public function execute(InputInterface $input, OutputInterface $output)
      */
     protected function getSites($ids): array
     {
-        //NEXT_MAJOR: Inject this on the __construct.
+        // NEXT_MAJOR: Inject this on the __construct.
         $siteManager = $this->getContainer()->get('sonata.page.manager.site');
 
         if ([] === $ids) {

diff --git a/src/Command/DumpPageCommand.php b/src/Command/DumpPageCommand.php
@@ -37,14 +37,14 @@ public function configure()
         $this->setDescription('Dump page information');
         $this->setHelp(
             <<<HELP
-Dump page information
+                Dump page information
 
-Available managers:
- - sonata.page.cms.snapshot
- - sonata.page.cms.page
+                Available managers:
+                 - sonata.page.cms.snapshot
+                 - sonata.page.cms.page
 
-You can use the --extended option to dump block configuration
-HELP
+                You can use the --extended option to dump block configuration
+                HELP
         );
 
         $this->addArgument('manager', InputArgument::REQUIRED, 'The manager service id');

diff --git a/src/Command/RenderBlockCommand.php b/src/Command/RenderBlockCommand.php
@@ -36,12 +36,12 @@ public function configure()
         $this->setDescription('Dump page information');
         $this->setHelp(
             <<<HELP
-Dump page information
+                Dump page information
 
-Available manager:
- - sonata.page.cms.snapshot
- - sonata.page.cms.page
-HELP
+                Available manager:
+                 - sonata.page.cms.snapshot
+                 - sonata.page.cms.page
+                HELP
         );
 
         $this->addArgument('manager', InputArgument::REQUIRED, 'The manager service id');

diff --git a/src/Command/UpdateCoreRoutesCommand.php b/src/Command/UpdateCoreRoutesCommand.php
@@ -51,14 +51,14 @@ public function execute(InputInterface $input, OutputInterface $output)
 
         $siteOption = $input->getOption('site');
 
-        //NEXT_MAJOR: Remove this condition, because site will be optional
+        // NEXT_MAJOR: Remove this condition, because site will be optional
         if ([] === $siteOption) {
             $output->writeln('Please provide an <info>--site=SITE_ID</info> option or the <info>--site=all</info> directive');
 
             return 1;
         }
 
-        //NEXT_MAJOR: Remove this block condition.
+        // NEXT_MAJOR: Remove this block condition.
         if (['all'] === $siteOption) {
             @trigger_error(
                 sprintf(
@@ -108,7 +108,7 @@ public function execute(InputInterface $input, OutputInterface $output)
      */
     protected function getSites($ids): array
     {
-        //NEXT_MAJOR: Inject this on the __construct.
+        // NEXT_MAJOR: Inject this on the __construct.
         $siteManager = $this->getContainer()->get('sonata.page.manager.site');
 
         if ([] === $ids) {

diff --git a/src/Controller/PageAdminController.php b/src/Controller/PageAdminController.php
@@ -46,12 +46,12 @@ public function batchActionSnapshot($query)
         }
 
         foreach ($query->execute() as $page) {
-            //NEXT_MAJOR: Remove the $notificationBackend variable
+            // NEXT_MAJOR: Remove the $notificationBackend variable
             $notificationBackend = $this->get('sonata.notification.backend');
 
-            //NEXT_MAJOR: Remove the "if" condition and use only "createByPage"
+            // NEXT_MAJOR: Remove the "if" condition and use only "createByPage"
             if ($notificationBackend instanceof RuntimeBackend) {
-                //NEXT_MAJOR: Inject CreateSnapshotByPageInterface type and remove this "get" call.
+                // NEXT_MAJOR: Inject CreateSnapshotByPageInterface type and remove this "get" call.
                 $this->get('sonata.page.service.create_snapshot')->createByPage($page);
             } else {
                 @trigger_error(

diff --git a/src/Controller/SiteAdminController.php b/src/Controller/SiteAdminController.php
@@ -53,12 +53,11 @@ public function snapshotsAction()
         $this->admin->setSubject($object);
 
         if ('POST' === $request->getMethod()) {
-
-            //NEXT_MAJOR: remove notificationBackend and else block.
+            // NEXT_MAJOR: remove notificationBackend and else block.
             $notificationBacked = $this->get('sonata.notification.backend');
 
             if ($notificationBacked instanceof RuntimeBackend) {
-                //NEXT_MAJOR: inject CreateSnapshotBySiteInterface and remove this get.
+                // NEXT_MAJOR: inject CreateSnapshotBySiteInterface and remove this get.
                 $createSnapshot = $this->get('sonata.page.service.create_snapshot');
                 $createSnapshot->createBySite($object);
             } else {

diff --git a/src/Controller/SnapshotAdminController.php b/src/Controller/SnapshotAdminController.php
@@ -54,7 +54,7 @@ public function createAction(?Request $request = null)
             $form->submit($request->request->get($form->getName()));
 
             if ($form->isValid()) {
-                //@NEXT_MAJOR: when you're going to inject this service use CreateSnapshotByPageInterface
+                // @NEXT_MAJOR: when you're going to inject this service use CreateSnapshotByPageInterface
                 $createSnapshot = $this->get('sonata.page.service.create_snapshot');
                 $snapshot = $createSnapshot->createByPage($page);