[Task][PD-109] Check usage of private vs protected methods and decide…

… which classes should be final (#7) * check usage of private vs protected methods and decide which classes should be final * Apply php-cs-fixer changes * fix: remove unused injections * fix: qodana --------- Co-authored-by: lukmzig <lukmzig@users.noreply.github.com>
pimcore · Jan 30, 2024 · 82b8793 · 82b8793
1 parent 6673dad
commit 82b8793
Show file tree

Hide file tree

Showing 62 changed files with 380 additions and 188 deletions.
diff --git a/src/Command/Update/IndexUpdateCommand.php b/src/Command/Update/IndexUpdateCommand.php
@@ -26,7 +26,10 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Contracts\Service\Attribute\Required;
 
-class IndexUpdateCommand extends AbstractCommand
+/**
+ * @internal
+ */
+final class IndexUpdateCommand extends AbstractCommand
 {
     use LockableTrait;
 
@@ -36,9 +39,9 @@ class IndexUpdateCommand extends AbstractCommand
 
     private const OPTION_RECREATE_INDEX = 'recreate_index';
 
-    protected IndexUpdateService $indexUpdateService;
+    private IndexUpdateService $indexUpdateService;
 
-    protected EnqueueService $enqueueService;
+    private EnqueueService $enqueueService;
 
     #[Required]
     public function setIndexUpdateService(IndexUpdateService $indexUpdateService): void

diff --git a/src/Controller/DefaultController.php b/src/Controller/DefaultController.php
@@ -15,6 +15,9 @@
 
 use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * @internal
+ */
 final class DefaultController
 {
     public function defaultAction(): Response

diff --git a/src/DependencyInjection/Compiler/SearchIndexFieldDefinitionPass.php b/src/DependencyInjection/Compiler/SearchIndexFieldDefinitionPass.php
@@ -18,7 +18,10 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-class SearchIndexFieldDefinitionPass implements CompilerPassInterface
+/**
+ * @internal
+ */
+final class SearchIndexFieldDefinitionPass implements CompilerPassInterface
 {
     /**
      * @param ContainerBuilder $container

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -24,6 +24,10 @@
  *
  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
  */
+
+/**
+ * @internal
+ */
 class Configuration implements ConfigurationInterface
 {
     /**

diff --git a/src/DependencyInjection/PimcoreGenericDataIndexExtension.php b/src/DependencyInjection/PimcoreGenericDataIndexExtension.php
@@ -29,6 +29,10 @@
  *
  * @link http://symfony.com/doc/current/cookbook/bundles/extension.html
  */
+
+/**
+ * @internal
+ */
 class PimcoreGenericDataIndexExtension extends Extension implements PrependExtensionInterface
 {
     /**
@@ -60,7 +64,7 @@ public function prepend(ContainerBuilder $container): void
         $container->prependExtensionConfig('doctrine', $config['doctrine']);
     }
 
-    protected function registerIndexServiceParams(ContainerBuilder $container, array $indexSettings): static
+    private function registerIndexServiceParams(ContainerBuilder $container, array $indexSettings): void
     {
         $definition = $container->getDefinition(SearchIndexConfigService::class);
         $definition->setArgument('$indexPrefix', $indexSettings['client_params']['index_prefix']);
@@ -73,7 +77,5 @@ protected function registerIndexServiceParams(ContainerBuilder $container, array
         $definition->setArgument('$username', $indexSettings['client_params']['username']);
         $definition->setArgument('$password', $indexSettings['client_params']['password']);
         $definition->setArgument('$sslVerification', $indexSettings['client_params']['ssl_verification']);
-
-        return $this;
     }
 }
diff --git a/src/Entity/IndexQueue.php b/src/Entity/IndexQueue.php
@@ -20,6 +20,9 @@
 #[ORM\Table(name: self::TABLE)]
 #[ORM\Index(columns: ['dispatched'], name: self::TABLE . '_dispatched')]
 
+/**
+ * @internal
+ */
 class IndexQueue
 {
     public const TABLE = 'generic_data_index_queue';

diff --git a/src/Enum/DependencyInjection/CompilerPassTag.php b/src/Enum/DependencyInjection/CompilerPassTag.php
@@ -13,6 +13,9 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Enum\DependencyInjection;
 
+/**
+ * @internal
+ */
 enum CompilerPassTag: string
 {
     case DATA_OBJECT_SEARCH_INDEX_FIELD_DEFINITION =

diff --git a/src/Enum/Messenger/TransportName.php b/src/Enum/Messenger/TransportName.php
@@ -13,6 +13,9 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Enum\Messenger;
 
+/**
+ * @internal
+ */
 enum TransportName: string
 {
     case INDEX_QUEUE = 'pimcore_generic_data_index_queue';

diff --git a/src/Enum/SearchIndex/ElementType.php b/src/Enum/SearchIndex/ElementType.php
@@ -13,6 +13,9 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex;
 
+/**
+ * @internal
+ */
 enum ElementType: string
 {
     case ASSET = 'asset';

diff --git a/src/Enum/SearchIndex/FieldCategory.php b/src/Enum/SearchIndex/FieldCategory.php
@@ -13,6 +13,9 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex;
 
+/**
+ * @internal
+ */
 enum FieldCategory: string
 {
     case SYSTEM_FIELDS = 'system_fields';

diff --git a/src/Enum/SearchIndex/FieldCategory/SystemField.php b/src/Enum/SearchIndex/FieldCategory/SystemField.php
@@ -13,6 +13,9 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\FieldCategory;
 
+/**
+ * @internal
+ */
 enum SystemField: string
 {
     case ID = 'id';

diff --git a/src/Enum/SearchIndex/IndexName.php b/src/Enum/SearchIndex/IndexName.php
@@ -13,6 +13,9 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex;
 
+/**
+ * @internal
+ */
 enum IndexName: string
 {
     case ASSET = 'asset';

diff --git a/src/Enum/SearchIndex/IndexQueueOperation.php b/src/Enum/SearchIndex/IndexQueueOperation.php
@@ -13,6 +13,9 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex;
 
+/**
+ * @internal
+ */
 enum IndexQueueOperation: string
 {
     case UPDATE = 'update';

diff --git a/src/Enum/SearchIndex/OpenSearch/AttributeType.php b/src/Enum/SearchIndex/OpenSearch/AttributeType.php
@@ -13,6 +13,9 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\OpenSearch;
 
+/**
+ * @internal
+ */
 enum AttributeType: string
 {
     case TEXT = 'text';

diff --git a/src/EventSubscriber/IndexUpdateSubscriber.php b/src/EventSubscriber/IndexUpdateSubscriber.php
@@ -18,9 +18,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Installer;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexQueue\EnqueueService;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexQueueService;
-use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexService\IndexHandler\AssetIndexHandler;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexService\IndexHandler\DataObjectIndexHandler;
-use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\OpenSearch\OpenSearchService;
 use Pimcore\Bundle\GenericDataIndexBundle\Traits\LoggerAwareTrait;
 use Pimcore\Event\AssetEvents;
 use Pimcore\Event\DataObjectClassDefinitionEvents;
@@ -35,17 +33,18 @@
 use Pimcore\Model\Element\Service;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
-class IndexUpdateSubscriber implements EventSubscriberInterface
+/**
+ * @internal
+ */
+final class IndexUpdateSubscriber implements EventSubscriberInterface
 {
     use LoggerAwareTrait;
 
     public function __construct(
-        protected readonly IndexQueueService $indexQueueService,
-        protected readonly EnqueueService $enqueueService,
-        protected readonly DataObjectIndexHandler $dataObjectMappingHandler,
-        protected readonly AssetIndexHandler $assetMappingHandler,
-        protected readonly OpenSearchService $openSearchService,
-        protected readonly Installer $installer,
+        private readonly IndexQueueService $indexQueueService,
+        private readonly EnqueueService $enqueueService,
+        private readonly DataObjectIndexHandler $dataObjectMappingHandler,
+        private readonly Installer $installer,
     ) {
     }
 

diff --git a/src/Exception/DataObjectNormalizerException.php b/src/Exception/DataObjectNormalizerException.php
@@ -0,0 +1,23 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under following license:
+ * - Pimcore Commercial License (PCL)
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     PCL
+ */
+
+namespace Pimcore\Bundle\GenericDataIndexBundle\Exception;
+
+use RuntimeException;
+
+/**
+ * @internal
+ */
+final class DataObjectNormalizerException extends RuntimeException implements GenericDataIndexBundleExceptionInterface
+{
+}
diff --git a/src/Installer.php b/src/Installer.php
@@ -15,6 +15,9 @@
 
 use Pimcore;
 
-class Installer extends Pimcore\Extension\Bundle\Installer\SettingsStoreAwareInstaller
+/**
+ * @internal
+ */
+final class Installer extends Pimcore\Extension\Bundle\Installer\SettingsStoreAwareInstaller
 {
 }
diff --git a/src/Message/DispatchQueueMessagesMessage.php b/src/Message/DispatchQueueMessagesMessage.php
@@ -13,6 +13,9 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Message;
 
-class DispatchQueueMessagesMessage
+/**
+ * @internal
+ */
+final class DispatchQueueMessagesMessage
 {
 }
diff --git a/src/Message/IndexUpdateQueueMessage.php b/src/Message/IndexUpdateQueueMessage.php
@@ -13,9 +13,12 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Message;
 
-class IndexUpdateQueueMessage
+/**
+ * @internal
+ */
+final class IndexUpdateQueueMessage
 {
-    public function __construct(protected array $entries)
+    public function __construct(private readonly array $entries)
     {
     }
 

diff --git a/src/MessageHandler/DispatchQueueMessagesHandler.php b/src/MessageHandler/DispatchQueueMessagesHandler.php
@@ -20,13 +20,16 @@
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 use Symfony\Component\Messenger\MessageBusInterface;
 
+/**
+ * @internal
+ */
 #[AsMessageHandler]
-class DispatchQueueMessagesHandler
+final class DispatchQueueMessagesHandler
 {
     public function __construct(
-        protected readonly IndexQueueRepository $indexQueueRepository,
-        protected readonly QueueMessagesDispatcher $queueMessagesDispatcher,
-        protected readonly MessageBusInterface $messageBus
+        private readonly IndexQueueRepository $indexQueueRepository,
+        private readonly QueueMessagesDispatcher $queueMessagesDispatcher,
+        private readonly MessageBusInterface $messageBus
     ) {
     }
 

diff --git a/src/MessageHandler/IndexUpdateQueueHandler.php b/src/MessageHandler/IndexUpdateQueueHandler.php
@@ -19,12 +19,15 @@
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 use Symfony\Component\Serializer\Exception\ExceptionInterface;
 
+/**
+ * @internal
+ */
 #[AsMessageHandler]
-class IndexUpdateQueueHandler
+final class IndexUpdateQueueHandler
 {
     public function __construct(
-        protected readonly IndexQueueService $indexQueueService,
-        protected readonly IndexQueueRepository $indexQueueRepository,
+        private readonly IndexQueueService $indexQueueService,
+        private readonly IndexQueueRepository $indexQueueRepository,
     ) {
     }
 

diff --git a/src/Repository/IndexQueueRepository.php b/src/Repository/IndexQueueRepository.php
@@ -24,7 +24,7 @@
 use Symfony\Component\Serializer\Exception\ExceptionInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 
-class IndexQueueRepository extends ServiceEntityRepository
+final class IndexQueueRepository extends ServiceEntityRepository
 {
     use LoggerAwareTrait;
 

diff --git a/src/Scheduler/GenericDataIndexScheduleProvider.php b/src/Scheduler/GenericDataIndexScheduleProvider.php
@@ -22,8 +22,11 @@
 use Symfony\Component\Scheduler\Schedule;
 use Symfony\Component\Scheduler\ScheduleProviderInterface;
 
+/**
+ * @internal
+ */
 #[AsSchedule('generic_data_index')]
-class GenericDataIndexScheduleProvider implements ScheduleProviderInterface
+final class GenericDataIndexScheduleProvider implements ScheduleProviderInterface
 {
     public function __construct(
         private readonly QueueMessagesDispatcher $queueMessagesDispatcher,

diff --git a/src/Service/Normalizer/AssetNormalizer.php b/src/Service/Normalizer/AssetNormalizer.php
@@ -16,12 +16,19 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\FieldCategory;
 use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\FieldCategory\SystemField;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\Workflow\WorkflowService;
+use Pimcore\Bundle\GenericDataIndexBundle\Traits\ElementNormalizerTrait;
 use Pimcore\Model\Asset;
 use Pimcore\Model\Element\ElementInterface;
 use Pimcore\Model\Element\Service;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
-class AssetNormalizer extends AbstractElementNormalizer
+/**
+ * @internal
+ */
+final class AssetNormalizer implements NormalizerInterface
 {
+    use ElementNormalizerTrait;
+
     public const NOT_LOCALIZED_KEY = 'default';
 
     public function __construct(private readonly WorkflowService $workflowService)
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,6 +24,10 @@ @@
      *
      * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
      */
+    /**
+     * @internal
+     */
     class Configuration implements ConfigurationInterface
     {
         /**
@@ Expand Down @@