Merge pull request #20 from valantic/choices-repo

Repository for Choices
valantic · Feb 15, 2024 · d170c96 · d170c96
2 parents 4b87053 + c0ee2e8
commit d170c96
Show file tree

Hide file tree

Showing 11 changed files with 110 additions and 132 deletions.
diff --git a/src/DependencyInjection/ValanticPimcoreFormsExtension.php b/src/DependencyInjection/ValanticPimcoreFormsExtension.php
@@ -11,6 +11,7 @@
 use Valantic\PimcoreFormsBundle\Form\InputHandler\InputHandlerInterface;
 use Valantic\PimcoreFormsBundle\Form\Output\OutputInterface;
 use Valantic\PimcoreFormsBundle\Form\RedirectHandler\RedirectHandlerInterface;
+use Valantic\PimcoreFormsBundle\Form\Type\ChoicesInterface;
 use Valantic\PimcoreFormsBundle\Repository\ConfigurationRepository;
 
 /**
@@ -23,6 +24,7 @@ class ValanticPimcoreFormsExtension extends Extension
     final public const TAG_OUTPUT = 'valantic.pimcore_forms.output';
     final public const TAG_REDIRECT_HANDLER = 'valantic.pimcore_forms.redirect_handler';
     final public const TAG_INPUT_HANDLER = 'valantic.pimcore_forms.input_handler';
+    final public const TAG_CHOICES = 'valantic.pimcore_forms.choices';
 
     /**
      * @param array<mixed> $configs
@@ -38,6 +40,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->registerForAutoconfiguration(OutputInterface::class)->addTag(self::TAG_OUTPUT);
         $container->registerForAutoconfiguration(RedirectHandlerInterface::class)->addTag(self::TAG_REDIRECT_HANDLER);
         $container->registerForAutoconfiguration(InputHandlerInterface::class)->addTag(self::TAG_INPUT_HANDLER);
+        $container->registerForAutoconfiguration(ChoicesInterface::class)->addTag(self::TAG_CHOICES);
 
         $ymlLoader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $ymlLoader->load('services.yml');

diff --git a/src/Exception/Repository/ItemNotFoundInRepositoryException.php b/src/Exception/Repository/ItemNotFoundInRepositoryException.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Valantic\PimcoreFormsBundle\Exception\Repository;
+
+use Valantic\PimcoreFormsBundle\Exception\BaseException;
+
+class ItemNotFoundInRepositoryException extends BaseException
+{
+    public function __construct(string $key)
+    {
+        parent::__construct(sprintf('Item %s not found in repository', $key));
+    }
+}
diff --git a/src/Exception/UnknownInputHandlerException.php b/src/Exception/UnknownInputHandlerException.php
diff --git a/src/Exception/UnknownRedirectHandlerException.php b/src/Exception/UnknownRedirectHandlerException.php
diff --git a/src/Form/Builder.php b/src/Form/Builder.php
@@ -4,7 +4,6 @@
 
 namespace Valantic\PimcoreFormsBundle\Form;
 
-use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 use Symfony\Component\Form\Extension\Core\Type\DateType;
 use Symfony\Component\Form\Extension\Core\Type\FormType;
@@ -15,16 +14,16 @@
 use Symfony\Component\Validator\Constraints\Choice;
 use Symfony\Contracts\Translation\TranslatorInterface;
 use Valantic\PimcoreFormsBundle\DependencyInjection\Configuration;
-use Valantic\PimcoreFormsBundle\Form\Type\ChoicesInterface;
 use Valantic\PimcoreFormsBundle\Form\Type\ConfigAwareInterface;
+use Valantic\PimcoreFormsBundle\Repository\ChoicesRepository;
 
 class Builder
 {
     public function __construct(
-        protected readonly ParameterBagInterface $container,
         protected readonly UrlGeneratorInterface $urlGenerator,
         protected readonly TranslatorInterface $translator,
-        protected readonly FormFactoryInterface $formFactory
+        protected readonly FormFactoryInterface $formFactory,
+        protected readonly ChoicesRepository $choicesRepository,
     ) {
     }
 
@@ -122,8 +121,7 @@ protected function getOptions(string $formName, array $definition, array $formCo
                 }
             }
             if (!empty($definition['provider']) && is_string($definition['provider'])) {
-                /** @var ChoicesInterface $choices */
-                $choices = $this->container->get($definition['provider']);
+                $choices = $this->choicesRepository->get($definition['provider']);
                 if ($choices instanceof ConfigAwareInterface) {
                     $choices->setFormName($formName);
                     $choices->setFieldConfig($formConfig);

diff --git a/src/Repository/AbstractRepository.php b/src/Repository/AbstractRepository.php
@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Valantic\PimcoreFormsBundle\Repository;
+
+use Valantic\PimcoreFormsBundle\Exception\Repository\ItemNotFoundInRepositoryException;
+
+/**
+ * @template TItem
+ *
+ * @internal
+ */
+abstract class AbstractRepository
+{
+    /** @var TItem[] */
+    protected array $items;
+
+    public function __construct(
+        /** @var \Iterator<TItem> */
+        protected iterable $iterables,
+    ) {
+    }
+
+    /** @return TItem */
+    public function get(string $key)
+    {
+        return $this->all()[$key] ?? throw new ItemNotFoundInRepositoryException($key);
+    }
+
+    /** @return TItem[] */
+    protected function all(): array
+    {
+        $this->items ??= $this->initializeItemsFromIterables();
+
+        return $this->items;
+    }
+
+    /**
+     * @return array<class-string<TItem>,TItem>
+     */
+    protected function initializeItemsFromIterables(): array
+    {
+        $arr = [];
+
+        foreach ($this->iterables as $iterable) {
+            $arr[$iterable::class] = $iterable;
+        }
+
+        return $arr;
+    }
+}
diff --git a/src/Repository/ChoicesRepository.php b/src/Repository/ChoicesRepository.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Valantic\PimcoreFormsBundle\Repository;
+
+use Valantic\PimcoreFormsBundle\Form\Type\ChoicesInterface;
+
+/**
+ * @extends AbstractRepository<ChoicesInterface>
+ *
+ * @internal
+ */
+class ChoicesRepository extends AbstractRepository
+{
+}
diff --git a/src/Repository/InputHandlerRepository.php b/src/Repository/InputHandlerRepository.php
@@ -4,55 +4,13 @@
 
 namespace Valantic\PimcoreFormsBundle\Repository;
 
-use Valantic\PimcoreFormsBundle\Exception\UnknownInputHandlerException;
 use Valantic\PimcoreFormsBundle\Form\InputHandler\InputHandlerInterface;
 
-class InputHandlerRepository
+/**
+ * @extends AbstractRepository<InputHandlerInterface>
+ *
+ * @internal
+ */
+class InputHandlerRepository extends AbstractRepository
 {
-    /**
-     * @var array<string,InputHandlerInterface>
-     */
-    protected array $inputHandlers;
-
-    /**
-     * @param iterable<InputHandlerInterface> $inputHandlers
-     */
-    public function __construct(iterable $inputHandlers)
-    {
-        $this->inputHandlers = $this->iterableToArray($inputHandlers);
-    }
-
-    public function get(string $key): InputHandlerInterface
-    {
-        if (str_starts_with($key, '\\')) {
-            $key = substr($key, 1);
-        }
-
-        if (!array_key_exists($key, $this->inputHandlers)) {
-            throw new UnknownInputHandlerException($key);
-        }
-
-        return clone $this->inputHandlers[$key];
-    }
-
-    /**
-     * @param iterable<object> $iterables
-     *
-     * @return array<string,InputHandlerInterface>
-     */
-    public function iterableToArray(iterable $iterables): array
-    {
-        $arr = [];
-
-        foreach ($iterables as $iterable) {
-            if (!($iterable instanceof InputHandlerInterface)) {
-                continue;
-            }
-
-            $name = $iterable::class;
-            $arr[$name] = $iterable;
-        }
-
-        return $arr;
-    }
 }
diff --git a/src/Repository/OutputRepository.php b/src/Repository/OutputRepository.php
@@ -4,6 +4,8 @@
 
 namespace Valantic\PimcoreFormsBundle\Repository;
 
+use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
+use Valantic\PimcoreFormsBundle\DependencyInjection\ValanticPimcoreFormsExtension;
 use Valantic\PimcoreFormsBundle\Exception\DuplicateOutputException;
 use Valantic\PimcoreFormsBundle\Exception\UnknownOutputException;
 use Valantic\PimcoreFormsBundle\Form\Output\OutputInterface;
@@ -18,8 +20,10 @@ class OutputRepository
     /**
      * @param iterable<OutputInterface> $outputs
      */
-    public function __construct(iterable $outputs)
-    {
+    public function __construct(
+        #[TaggedIterator(ValanticPimcoreFormsExtension::TAG_OUTPUT)]
+        iterable $outputs
+    ) {
         $this->outputs = $this->iterableToArray($outputs);
     }
 

diff --git a/src/Repository/RedirectHandlerRepository.php b/src/Repository/RedirectHandlerRepository.php
@@ -4,55 +4,13 @@
 
 namespace Valantic\PimcoreFormsBundle\Repository;
 
-use Valantic\PimcoreFormsBundle\Exception\UnknownRedirectHandlerException;
 use Valantic\PimcoreFormsBundle\Form\RedirectHandler\RedirectHandlerInterface;
 
-class RedirectHandlerRepository
+/**
+ * @extends AbstractRepository<RedirectHandlerInterface>
+ *
+ * @internal
+ */
+class RedirectHandlerRepository extends AbstractRepository
 {
-    /**
-     * @var array<string,RedirectHandlerInterface>
-     */
-    protected array $redirectHandlers;
-
-    /**
-     * @param iterable<RedirectHandlerInterface> $redirectHandlers
-     */
-    public function __construct(iterable $redirectHandlers)
-    {
-        $this->redirectHandlers = $this->iterableToArray($redirectHandlers);
-    }
-
-    public function get(string $key): RedirectHandlerInterface
-    {
-        if (str_starts_with($key, '\\')) {
-            $key = substr($key, 1);
-        }
-
-        if (!array_key_exists($key, $this->redirectHandlers)) {
-            throw new UnknownRedirectHandlerException($key);
-        }
-
-        return clone $this->redirectHandlers[$key];
-    }
-
-    /**
-     * @param iterable<object> $iterables
-     *
-     * @return array<string,RedirectHandlerInterface>
-     */
-    public function iterableToArray(iterable $iterables): array
-    {
-        $arr = [];
-
-        foreach ($iterables as $iterable) {
-            if (!($iterable instanceof RedirectHandlerInterface)) {
-                continue;
-            }
-
-            $name = $iterable::class;
-            $arr[$name] = $iterable;
-        }
-
-        return $arr;
-    }
 }
diff --git a/src/Resources/config/services.yml b/src/Resources/config/services.yml
@@ -21,9 +21,9 @@ services:
   Valantic\PimcoreFormsBundle\Service\:
     resource: '../../Service/*'
 
-  Valantic\PimcoreFormsBundle\Repository\OutputRepository:
+  Valantic\PimcoreFormsBundle\Repository\ChoicesRepository:
     arguments:
-      - !tagged_iterator valantic.pimcore_forms.output
+      - !tagged_iterator valantic.pimcore_forms.choices
 
   Valantic\PimcoreFormsBundle\Repository\InputHandlerRepository:
     arguments: