Feat: introduce ibexa 4 compatibility

.gitignore

@@ -8,7 +8,7 @@ composer.phar
 composer.lock
 coverage.xml
 phpunit.phar
-.php_cs.cache
+.php-cs-fixer.cache
 grunt.lock
 package-lock.json
 .phpunit.result.cache

.php_cs → .php-cs-fixer.php

@@ -1,6 +1,6 @@
 <?php
 
-return PhpCsFixer\Config::create()
+return (new PhpCsFixer\Config())
     ->setRiskyAllowed(true)
     ->setRules([
         '@PhpCsFixer' => true,
@@ -10,7 +10,9 @@
         'concat_space' => ['spacing' => 'one'],
         'method_chaining_indentation' => false,
         'multiline_whitespace_before_semicolons' => false,
-        'native_function_invocation' => false,
+        'native_function_invocation' => ['include' => ['@all']],
+        'no_superfluous_phpdoc_tags' => false,
+        'ordered_imports' => ['imports_order' => ['class', 'function', 'const']],
         'php_unit_internal_class' => false,
         'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
         'php_unit_test_class_requires_covers' => false,
@@ -23,8 +25,15 @@
         // Additional rules
         'date_time_immutable' => true,
         'declare_strict_types' => true,
+        'global_namespace_import' => [
+            'import_classes' => null,
+            'import_constants' => true,
+            'import_functions' => true,
+        ],
         'list_syntax' => ['syntax' => 'short'],
         'mb_str_functions' => true,
+        'native_constant_invocation' => true,
+        'nullable_type_declaration_for_default_null_value' => true,
         'static_lambda' => true,
         'ternary_to_null_coalescing' => true,
     ])

README.md

@@ -21,9 +21,9 @@ It is typically useful when it comes to the creation of feedback forms, polls, e
 An object can collect information if at least one of the class attributes is marked as an information collector.
 When the object is viewed, each collector attribute will be displayed using the chosen datatype's data collector template. 
 Instead of just outputting the attributes' contents, the collector templates provide interfaces for data input. 
-The generated input interface depends on the datatype that represents the attribute. ( From eZ [documentation](https://doc.ez.no/eZ-Publish/Technical-manual/3.9/Concepts-and-basics/Content-management/Information-collection)).
+The generated input interface depends on the datatype that represents the attribute. ( From eZ legacy [documentation](https://doc.ez.no/eZ-Publish/Technical-manual/3.9/Concepts-and-basics/Content-management/Information-collection)).
 
-This bundle reimplements information collection feature in eZ Platform/Ibexa stack.
+This bundle reimplements information collection feature in Ibexa Platform stack.
 
 License, docs and installation instructions
 -------------------------------------------

bundle/Command/DataAnonymizerCommand.php

@@ -10,6 +10,7 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\ConfirmationQuestion;
+use DateTimeInterface;
 use DateInterval;
 use DateTime;
 use Exception;
@@ -18,15 +19,9 @@ class DataAnonymizerCommand extends Command
 {
     protected static $defaultName = 'nginfocollector:anonymize';
 
-    /**
-     * @var \Netgen\InformationCollection\Core\Persistence\Anonymizer\AnonymizerServiceFacade
-     */
-    protected $anonymizer;
+    protected AnonymizerServiceFacade $anonymizer;
 
-    /**
-     * @var \DateInterval
-     */
-    protected $period;
+    protected DateInterval $period;
 
     public function __construct(AnonymizerServiceFacade $anonymizerServiceFacade)
     {
@@ -36,7 +31,7 @@ public function __construct(AnonymizerServiceFacade $anonymizerServiceFacade)
         parent::__construct();
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName("nginfocollector:anonymize");
         $this->setDescription("Anonymizes collected data in collected info tables.");
@@ -58,22 +53,26 @@ protected function configure()
         $this->addUsage("--info-collection-id=456 --field-identifiers=title,name,last_name");
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         if (is_null($input->getOption('content-id'))) {
             $output->writeln("<error>                                       </error>");
             $output->writeln("<error>     Missing content-id parameter.     </error>");
             $output->writeln("<error>                                       </error>");
 
-            return $this->displayHelp($input, $output);
+            $this->displayHelp($input, $output);
+
+            return 1;
         }
 
         if (is_null($input->getOption('field-identifiers')) && !$input->getOption('all')) {
             $output->writeln("<error>                                              </error>");
             $output->writeln("<error>     Missing field-identifiers parameter.     </error>");
             $output->writeln("<error>                                              </error>");
 
-            return $this->displayHelp($input, $output);
+            $this->displayHelp($input, $output);
+
+            return 1;
         }
 
         $contentId = intval($input->getOption('content-id'));
@@ -87,13 +86,16 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $count = $this->anonymizer->anonymize($contentId, $fields, $this->getDateFromPeriod());
             $output->writeln("<info>Done.</info>");
             $output->writeln("<info>Anonymized #{$count} collections.</info>");
+
             return 0;
         }
 
         $output->writeln("<info>Canceled.</info>");
+
+        return 0;
     }
 
-    protected function initialize(InputInterface $input, OutputInterface $output)
+    protected function initialize(InputInterface $input, OutputInterface $output): void
     {
         if (!empty($input->getOption('period'))) {
 
@@ -109,15 +111,15 @@ protected function initialize(InputInterface $input, OutputInterface $output)
         }
     }
 
-    protected function displayHelp(InputInterface $input, OutputInterface $output)
+    protected function displayHelp(InputInterface $input, OutputInterface $output): void
     {
         $help = new HelpCommand();
         $help->setCommand($this);
 
-        return $help->run($input, $output);
+        $help->run($input, $output);
     }
 
-    protected function getFields(InputInterface $input)
+    protected function getFields(InputInterface $input): array
     {
         if (!empty($input->getOption('all'))) {
             return [];
@@ -142,7 +144,7 @@ protected function getFields(InputInterface $input)
         return [];
     }
 
-    protected function proceedWithAction(InputInterface $input, OutputInterface $output)
+    protected function proceedWithAction(InputInterface $input, OutputInterface $output): bool
     {
         if ($input->getOption('neglect')) {
             return true;
@@ -157,7 +159,7 @@ protected function proceedWithAction(InputInterface $input, OutputInterface $out
         return false;
     }
 
-    protected function getDateFromPeriod()
+    protected function getDateFromPeriod(): DateTimeInterface
     {
         $dt = new DateTime();
         $dt->sub($this->period);

bundle/Controller/Admin/AdminController.php

@@ -2,11 +2,11 @@
 
 namespace Netgen\Bundle\InformationCollectionBundle\Controller\Admin;
 
-use eZ\Publish\API\Repository\Values\Content\Content;
-use eZ\Publish\Core\MVC\Symfony\Security\Authorization\Attribute;
-use eZ\Bundle\EzPublishCoreBundle\Controller;
-use eZ\Publish\API\Repository\ContentService;
-use eZ\Publish\Core\MVC\ConfigResolverInterface;
+use Ibexa\Contracts\Core\Repository\Values\Content\Content;
+use Ibexa\Core\MVC\Symfony\Security\Authorization\Attribute;
+use Ibexa\Bundle\Core\Controller;
+use Ibexa\Contracts\Core\Repository\ContentService;
+use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
 use Netgen\InformationCollection\API\Persistence\Anonymizer\Anonymizer;
 use Netgen\InformationCollection\API\Service\InformationCollection;
 use Netgen\InformationCollection\API\Value\Collection;
@@ -21,45 +21,23 @@
 use Netgen\InformationCollection\Core\Pagination\InformationCollectionContentsAdapter;
 use Pagerfanta\Adapter\AdapterInterface;
 use Pagerfanta\Pagerfanta;
+use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Contracts\Translation\TranslatorInterface;
 
 class AdminController extends Controller
 {
-    /**
-     * @var \Netgen\InformationCollection\API\Service\InformationCollection
-     */
-    protected $service;
+    protected InformationCollection $service;
 
-    /**
-     * @var \eZ\Publish\API\Repository\ContentService
-     */
-    protected $contentService;
+    protected ContentService $contentService;
 
-    /**
-     * @var \eZ\Publish\Core\MVC\ConfigResolverInterface
-     */
-    protected $configResolver;
+    protected ConfigResolverInterface $configResolver;
 
-    /**
-     * @var \Netgen\InformationCollection\API\Persistence\Anonymizer\Anonymizer
-     */
-    protected $anonymizer;
+    protected Anonymizer $anonymizer;
 
-    /**
-     * @var \Symfony\Contracts\Translation\TranslatorInterface
-     */
-    private $translator;
+    private TranslatorInterface $translator;
 
-    /**
-     * AdminController constructor.
-     *
-     * @param \Netgen\InformationCollection\API\Service\InformationCollection $service
-     * @param \Netgen\InformationCollection\API\Persistence\Anonymizer\Anonymizer $anonymizer
-     * @param \eZ\Publish\API\Repository\ContentService $contentService
-     * @param \eZ\Publish\Core\MVC\ConfigResolverInterface $configResolver
-     * @param \Symfony\Contracts\Translation\TranslatorInterface $translator
-     */
     public function __construct(
         InformationCollection $service,
         Anonymizer $anonymizer,
@@ -77,12 +55,8 @@ public function __construct(
 
     /**
      * Displays overview page
-     *
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     *
-     * @return \Symfony\Component\HttpFoundation\Response
      */
-    public function overviewAction(Request $request)
+    public function overviewAction(Request $request): Response
     {
         $this->checkReadPermissions();
 
@@ -94,13 +68,8 @@ public function overviewAction(Request $request)
 
     /**
      * Displays list of collection for selected Content
-     *
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     * @param \eZ\Publish\API\Repository\Values\Content\Content $content
-     *
-     * @return \Symfony\Component\HttpFoundation\Response
      */
-    public function collectionListAction(Request $request, Content $content)
+    public function collectionListAction(Request $request, Content $content): Response
     {
         $this->checkReadPermissions();
 
@@ -115,13 +84,8 @@ public function collectionListAction(Request $request, Content $content)
 
     /**
      * Handles collection search
-     *
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     * @param \eZ\Publish\API\Repository\Values\Content\Content $content
-     *
-     * @return \Symfony\Component\HttpFoundation\Response
      */
-    public function searchAction(Request $request, Content $content)
+    public function searchAction(Request $request, Content $content): Response
     {
         $this->checkReadPermissions();
 
@@ -140,12 +104,8 @@ public function searchAction(Request $request, Content $content)
 
     /**
      * Displays individual collection details
-     *
-     * @param \Netgen\InformationCollection\API\Value\Collection $collection
-     *
-     * @return \Symfony\Component\HttpFoundation\Response
      */
-    public function viewAction(Collection $collection)
+    public function viewAction(Collection $collection): Response
     {
         $this->checkReadPermissions();
 
@@ -157,12 +117,8 @@ public function viewAction(Collection $collection)
 
     /**
      * Handles actions performed on overview page
-     *
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     *
-     * @return \Symfony\Component\HttpFoundation\RedirectResponse
      */
-    public function handleContentsAction(Request $request)
+    public function handleContentsAction(Request $request): RedirectResponse
     {
         $this->checkReadPermissions();
 
@@ -195,12 +151,8 @@ public function handleContentsAction(Request $request)
 
     /**
      * Handles actions performed on collection list page
-     *
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     *
-     * @return \Symfony\Component\HttpFoundation\RedirectResponse
      */
-    public function handleCollectionListAction(Request $request)
+    public function handleCollectionListAction(Request $request): RedirectResponse
     {
         $this->checkReadPermissions();
 
@@ -247,12 +199,8 @@ public function handleCollectionListAction(Request $request)
 
     /**
      * Handles action on collection details page
-     *
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     *
-     * @return \Symfony\Component\HttpFoundation\RedirectResponse
      */
-    public function handleCollectionAction(Request $request)
+    public function handleCollectionAction(Request $request): RedirectResponse
     {
         $this->checkReadPermissions();
 
@@ -325,13 +273,8 @@ public function handleCollectionAction(Request $request)
 
     /**
      * Adds a flash message with specified parameters.
-     *
-     * @param string $messageType
-     * @param string $message
-     * @param int $count
-     * @param array $parameters
      */
-    protected function addFlashMessage(string $messageType, string $message, int $count = 1, array $parameters = array())
+    protected function addFlashMessage(string $messageType, string $message, int $count = 1, array $parameters = array()): void
     {
         $parameters = array_merge($parameters, ['count' => $count]);
 
@@ -347,15 +290,9 @@ protected function addFlashMessage(string $messageType, string $message, int $co
 
     /**
      * Returns configured instance of Pagerfanta
-     *
-     * @param \Pagerfanta\Adapter\AdapterInterface $adapter
-     * @param int $currentPage
-     *
-     * @return \Pagerfanta\Pagerfanta
      */
     protected function getPager(AdapterInterface $adapter, int $currentPage): Pagerfanta
     {
-        $currentPage = (int) $currentPage;
         $pager = new Pagerfanta($adapter);
         $pager->setNormalizeOutOfRangePages(true);
         $pager->setMaxPerPage(