Fix nullable properties for config source components

thomas-kl1 · thomas-kl1 · commit 41784af1e723 · 2024-06-27T23:03:44.000+02:00
diff --git a/Cron/EraseEntity.php b/Cron/EraseEntity.php
@@ -25,40 +25,15 @@
  */
 class EraseEntity
 {
-    private LoggerInterface $logger;
-
-    private Config $config;
-
-    private Registry $registry;
-
-    private EraseEntityManagementInterface $eraseManagement;
-
-    private EraseEntityRepositoryInterface $eraseRepository;
-
-    private SearchCriteriaBuilder $criteriaBuilder;
-
-    /**
-     * @var DateTime
-     */
-    private DateTime $dateTime;
-
     public function __construct(
-        LoggerInterface $logger,
-        Config $config,
-        Registry $registry,
-        EraseEntityManagementInterface $eraseManagement,
-        EraseEntityRepositoryInterface $eraseRepository,
-        SearchCriteriaBuilder $criteriaBuilder,
-        DateTime $dateTime
-    ) {
-        $this->logger = $logger;
-        $this->config = $config;
-        $this->registry = $registry;
-        $this->eraseManagement = $eraseManagement;
-        $this->eraseRepository = $eraseRepository;
-        $this->criteriaBuilder = $criteriaBuilder;
-        $this->dateTime = $dateTime;
-    }
+        private LoggerInterface $logger,
+        private Config $config,
+        private Registry $registry,
+        private EraseEntityManagementInterface $eraseManagement,
+        private EraseEntityRepositoryInterface $eraseRepository,
+        private SearchCriteriaBuilder $criteriaBuilder,
+        private DateTime $dateTime
+    ) {}
 
     public function execute(): void
     {
@@ -101,7 +76,7 @@ private function retrieveEraseEntityList(): SearchResultsInterface
 
         try {
             $eraseCustomerList = $this->eraseRepository->getList($this->criteriaBuilder->create());
-        } catch (LocalizedException $e) {
+        } catch (LocalizedException) {
             $eraseCustomerList = [];
         }
 
diff --git a/Cron/EraseEntityScheduler.php b/Cron/EraseEntityScheduler.php
@@ -26,35 +26,14 @@ class EraseEntityScheduler
 {
     private const CONFIG_PATH_ERASURE_MAX_AGE = 'gdpr/erasure/entity_max_age';
 
-    private LoggerInterface $logger;
-
-    private ScopeConfigInterface $scopeConfig;
-
-    private Config $config;
-
-    /**
-     * @var EraseEntitySchedulerService
-     */
-    private EraseEntitySchedulerService $eraseEntityScheduler;
-
-    private FilterBuilder $filterBuilder;
-
-    private EntityTypeList $entityTypeList;
-
     public function __construct(
-        LoggerInterface $logger,
-        ScopeConfigInterface $scopeConfig,
-        Config $config,
-        EraseEntitySchedulerService $eraseEntityScheduler,
-        FilterBuilder $filterBuilder,
-        EntityTypeList $entityTypeList
+        private LoggerInterface $logger,
+        private ScopeConfigInterface $scopeConfig,
+        private Config $config,
+        private EraseEntitySchedulerService $eraseEntityScheduler,
+        private FilterBuilder $filterBuilder,
+        private EntityTypeList $entityTypeList
     ) {
-        $this->logger = $logger;
-        $this->scopeConfig = $scopeConfig;
-        $this->config = $config;
-        $this->eraseEntityScheduler = $eraseEntityScheduler;
-        $this->filterBuilder = $filterBuilder;
-        $this->entityTypeList = $entityTypeList;
     }
 
     public function execute(): void
diff --git a/Cron/ExportEntity.php b/Cron/ExportEntity.php
@@ -21,29 +21,13 @@
  */
 class ExportEntity
 {
-    private LoggerInterface $logger;
-
-    private Config $config;
-
-    private ExportEntityRepositoryInterface $exportRepository;
-
-    private ExportEntityManagementInterface $exportManagement;
-
-    private SearchCriteriaBuilder $criteriaBuilder;
-
     public function __construct(
-        LoggerInterface $logger,
-        Config $config,
-        ExportEntityRepositoryInterface $exportRepository,
-        ExportEntityManagementInterface $exportManagement,
-        SearchCriteriaBuilder $criteriaBuilder
-    ) {
-        $this->logger = $logger;
-        $this->config = $config;
-        $this->exportRepository = $exportRepository;
-        $this->exportManagement = $exportManagement;
-        $this->criteriaBuilder = $criteriaBuilder;
-    }
+        private LoggerInterface $logger,
+        private Config $config,
+        private ExportEntityRepositoryInterface $exportRepository,
+        private ExportEntityManagementInterface $exportManagement,
+        private SearchCriteriaBuilder $criteriaBuilder
+    ) {}
 
     public function execute(): void
     {
diff --git a/Cron/ExportEntityExpired.php b/Cron/ExportEntityExpired.php
@@ -20,25 +20,12 @@
  */
 class ExportEntityExpired
 {
-    private LoggerInterface $logger;
-
-    private Config $config;
-
-    private ExportEntityRepositoryInterface $exportRepository;
-
-    private SearchCriteriaBuilder $criteriaBuilder;
-
     public function __construct(
-        LoggerInterface $logger,
-        Config $config,
-        ExportEntityRepositoryInterface $exportRepository,
-        SearchCriteriaBuilder $criteriaBuilder
-    ) {
-        $this->logger = $logger;
-        $this->config = $config;
-        $this->exportRepository = $exportRepository;
-        $this->criteriaBuilder = $criteriaBuilder;
-    }
+        private LoggerInterface $logger,
+        private Config $config,
+        private ExportEntityRepositoryInterface $exportRepository,
+        private SearchCriteriaBuilder $criteriaBuilder
+    ) {}
 
     public function execute(): void
     {
diff --git a/Model/Config/Source/EraseComponents.php b/Model/Config/Source/EraseComponents.php
@@ -12,71 +12,46 @@
 use Magento\Framework\Phrase;
 
 use function array_keys;
+use function array_map;
 use function array_merge;
 
 class EraseComponents implements OptionSourceInterface
 {
-    /**
-     * @var ConfigInterface
-     */
-    private ConfigInterface $objectManagerConfig;
-
-    /**
-     * Class must be an instance of `\Opengento\Gdpr\Service\Erase\ProcessorResolverFactory`
-     *
-     * @var string
-     */
-    private string $factoryClassName;
-
-    /**
-     * @var string[][]
-     */
-    private array $options = [];
+    private ?array $options = null;
 
     public function __construct(
-        ConfigInterface $objectManagerConfig,
-        string $factoryClassName
-    ) {
-        $this->objectManagerConfig = $objectManagerConfig;
-        $this->factoryClassName = $factoryClassName;
-    }
+        private ConfigInterface $objectManagerConfig,
+        private string $factoryClassName
+    ) {}
 
     public function toOptionArray(): array
     {
-        if (!$this->options) {
-            foreach ($this->retrieveDelegateProcessors() as $delegateProcessor) {
-                $this->options[] = ['value' => $delegateProcessor, 'label' => new Phrase($delegateProcessor)];
-            }
-        }
-
-        return $this->options;
+        return $this->options ??= array_map(
+            static fn (string $delegateProcessor): array => [
+                'value' => $delegateProcessor,
+                'label' => new Phrase($delegateProcessor)
+            ],
+            $this->retrieveDelegateProcessors()
+        );
     }
 
     /**
      * @return string[]
      */
     private function retrieveDelegateProcessors(): array
     {
-        $delegateProcessors = [];
-        /** @var string[] $resolvers */
-        $resolvers = $this->retrieveArgument($this->factoryClassName, 'processorResolvers', []);
-
-        foreach ($resolvers as $resolver) {
-            $delegateProcessors[] = $this->retrieveArgument($resolver, 'processors');
-        }
-
-        return array_keys(array_merge([], ...$delegateProcessors));
+        return array_keys(
+            array_merge(
+                [],
+                ...array_map(
+                    fn (string $resolver): mixed => $this->retrieveArgument($resolver, 'processors'),
+                    $this->retrieveArgument($this->factoryClassName, 'processorResolvers', [])
+                )
+            )
+        );
     }
 
-    /**
-     * Retrieve a construct argument value of a class
-     *
-     * @param string $className
-     * @param string $argumentName
-     * @param mixed $defaultValue
-     * @return mixed
-     */
-    private function retrieveArgument(string $className, string $argumentName, $defaultValue = null)
+    private function retrieveArgument(string $className, string $argumentName, mixed $defaultValue = null): mixed
     {
         $arguments = $this->objectManagerConfig->getArguments(
             $this->objectManagerConfig->getPreference($className)
diff --git a/Model/Config/Source/OrderPendingStates.php b/Model/Config/Source/OrderPendingStates.php
@@ -12,18 +12,9 @@
 
 class OrderPendingStates implements OptionSourceInterface
 {
-    private CollectionFactory $collectionFactory;
+    private ?array $options = null;
 
-    /**
-     * @var string[][]
-     */
-    private array $options;
-
-    public function __construct(
-        CollectionFactory $collectionFactory
-    ) {
-        $this->collectionFactory = $collectionFactory;
-    }
+    public function __construct(private CollectionFactory $collectionFactory) {}
 
     public function toOptionArray(): array
     {
diff --git a/Model/Config/Source/VirtualArrayArgumentList.php b/Model/Config/Source/VirtualArrayArgumentList.php
@@ -12,39 +12,24 @@
 use Magento\Framework\Phrase;
 
 use function array_keys;
+use function array_map;
 
 class VirtualArrayArgumentList implements OptionSourceInterface
 {
-    /**
-     * @var ConfigInterface
-     */
-    private ConfigInterface $objectManagerConfig;
-
-    private string $className;
-
-    private string $argumentName;
-
-    private array $options = [];
+    private ?array $options = null;
 
     public function __construct(
-        ConfigInterface $objectManagerConfig,
-        string $className,
-        string $argumentName
-    ) {
-        $this->objectManagerConfig = $objectManagerConfig;
-        $this->className = $className;
-        $this->argumentName = $argumentName;
-    }
+        private ConfigInterface $objectManagerConfig,
+        private string $className,
+        private string $argumentName
+    ) {}
 
     public function toOptionArray(): array
     {
-        if (!$this->options) {
-            foreach (array_keys($this->retrieveItems()) as $item) {
-                $this->options[] = ['value' => $item, 'label' => new Phrase($item)];
-            }
-        }
-
-        return $this->options;
+        return $this->options ??= array_map(
+            static fn (string $item): array => ['value' => $item, 'label' => new Phrase($item)],
+            array_keys($this->retrieveItems())
+        );
     }
 
     /**
diff --git a/Model/Config/Source/VirtualCustomerAttributes.php b/Model/Config/Source/VirtualCustomerAttributes.php
@@ -7,40 +7,36 @@
 
 namespace Opengento\Gdpr\Model\Config\Source;
 
+use Magento\Customer\Api\Data\AttributeMetadataInterface;
 use Magento\Customer\Api\MetadataInterface;
 use Magento\Framework\Data\OptionSourceInterface;
 use Magento\Framework\Exception\LocalizedException;
 
+use function array_map;
+
 class VirtualCustomerAttributes implements OptionSourceInterface
 {
-    private MetadataInterface $metadata;
-
-    private array $options;
+    private ?array $options = null;
 
-    public function __construct(
-        MetadataInterface $metadata
-    ) {
-        $this->metadata = $metadata;
-        $this->options = [];
-    }
+    public function __construct(private MetadataInterface $metadata) {}
 
     public function toOptionArray(): array
     {
-        if (!$this->options) {
-            try {
-                $attributes = $this->metadata->getAllAttributesMetadata();
-            } catch (LocalizedException $e) {
-                $attributes = [];
-            }
+        return $this->options ??= array_map(
+            static fn (AttributeMetadataInterface $attributeMetadata): array => [
+                'value' => $attributeMetadata->getAttributeCode(),
+                'label' => $attributeMetadata->getFrontendLabel(),
+            ],
+            $this->resolveAttributeMetadataList()
+        );
+    }
 
-            foreach ($attributes as $attribute) {
-                $this->options[] = [
-                    'value' => $attribute->getAttributeCode(),
-                    'label' => $attribute->getFrontendLabel(),
-                ];
-            }
+    private function resolveAttributeMetadataList(): array
+    {
+        try {
+            return $this->metadata->getAllAttributesMetadata();
+        } catch (LocalizedException) {
+            return [];
         }
-
-        return $this->options;
     }
 }
diff --git a/Model/Config/Source/VirtualEntityAttributes.php b/Model/Config/Source/VirtualEntityAttributes.php
diff --git a/Model/Erase/SecureEraseEntityManagement.php b/Model/Erase/SecureEraseEntityManagement.php
