Merge pull request #4 from sherlockode/feature/field_types

Handle field types with strategy
sherlockode · Nov 8, 2018 · a9481e7 · a9481e7
2 parents 2868439 + 5d73db6
commit a9481e7
Show file tree

Hide file tree

Showing 9 changed files with 145 additions and 14 deletions.
diff --git a/DependencyInjection/Compiler/FieldTypePass.php b/DependencyInjection/Compiler/FieldTypePass.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace  Sherlockode\ConfigurationBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+class FieldTypePass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        $definition = $container->findDefinition('sherlockode_configuration.field_manager');
+        $taggedServices = $container->findTaggedServiceIds('sherlockode_configuration.field');
+
+        foreach ($taggedServices as $id => $tags) {
+            $definition->addMethodCall('addFieldType', [new Reference($id)]);
+        }
+    }
+}
diff --git a/DependencyInjection/SherlockodeConfigurationExtension.php b/DependencyInjection/SherlockodeConfigurationExtension.php
@@ -22,5 +22,6 @@ public function load(array $configs, ContainerBuilder $container)
         $fileLocator = new FileLocator(__DIR__ . '/../Resources/config');
         $loader = new YamlFileLoader($container, $fileLocator);
         $loader->load('services.yml');
+        $loader->load('field_types.yml');
     }
 }
diff --git a/FieldType/FieldTypeInterface.php b/FieldType/FieldTypeInterface.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Sherlockode\ConfigurationBundle\FieldType;
+
+interface FieldTypeInterface
+{
+    /**
+     * @return string
+     */
+    public function getFormType();
+
+    /**
+     * @return array
+     */
+    public function getFormOptions();
+
+    /**
+     * @return string
+     */
+    public function getName();
+}
diff --git a/FieldType/TextField.php b/FieldType/TextField.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Sherlockode\ConfigurationBundle\FieldType;
+
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+
+class TextField implements FieldTypeInterface
+{
+    /**
+     * @return string
+     */
+    public function getFormType()
+    {
+        return TextType::class;
+    }
+
+    public function getFormOptions()
+    {
+        return [];
+    }
+
+    public function getName()
+    {
+        return 'text';
+    }
+}
diff --git a/Form/Type/ParameterType.php b/Form/Type/ParameterType.php
@@ -2,9 +2,10 @@
 
 namespace Sherlockode\ConfigurationBundle\Form\Type;
 
+use Sherlockode\ConfigurationBundle\Manager\FieldTypeManager;
+use Sherlockode\ConfigurationBundle\Model\ParameterInterface;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\CallbackTransformer;
-use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -19,11 +20,18 @@ class ParameterType extends AbstractType
     private $class;
 
     /**
-     * @param string $class
+     * @var FieldTypeManager
      */
-    public function __construct($class)
+    private $fieldTypeManager;
+
+    /**
+     * @param string           $class
+     * @param FieldTypeManager $fieldTypeManager
+     */
+    public function __construct($class, FieldTypeManager $fieldTypeManager)
     {
         $this->class = $class;
+        $this->fieldTypeManager = $fieldTypeManager;
     }
 
     public function buildForm(FormBuilderInterface $builder, array $options)
@@ -39,6 +47,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
         $builder->addViewTransformer(new CallbackTransformer(function ($data) {
             return $data;
         }, function ($data) use ($builder) {
+            /** @var ParameterInterface $data */
             $data->setPath($builder->getName());
 
             return $data;
@@ -54,19 +63,14 @@ public function configureOptions(OptionsResolver $resolver)
     /**
      * @param string $type
      *
-     * @return string
-     * @throws \Exception
+     * @return array
      */
     private function getFormConfiguration($type)
     {
-        $availableTypes = [
-            'text' => ['type' => TextType::class, 'options' => []],
+        $field = $this->fieldTypeManager->getField($type);
+        return [
+            'type' => $field->getFormType(),
+            'options' => $field->getFormOptions(),
         ];
-
-        if (!isset($availableTypes[$type])) {
-            throw new \Exception(sprintf('Unknown parameter type "%s"', $type));
-        }
-
-        return $availableTypes[$type];
     }
 }
diff --git a/Manager/FieldTypeManager.php b/Manager/FieldTypeManager.php
@@ -0,0 +1,45 @@
+<?php
+
+namespace Sherlockode\ConfigurationBundle\Manager;
+
+use Sherlockode\ConfigurationBundle\FieldType\FieldTypeInterface;
+
+class FieldTypeManager
+{
+    /**
+     * @var FieldTypeInterface[]
+     */
+    private $fieldTypes;
+
+    public function __construct()
+    {
+        $this->fieldTypes = [];
+    }
+
+    /**
+     * @param FieldTypeInterface $fieldType
+     *
+     * @return $this
+     */
+    public function addFieldType(FieldTypeInterface $fieldType)
+    {
+        $this->fieldTypes[$fieldType->getName()] = $fieldType;
+
+        return $this;
+    }
+
+    /**
+     * @param string $type
+     *
+     * @return FieldTypeInterface
+     * @throws \Exception
+     */
+    public function getField($type)
+    {
+        if (!isset($this->fieldTypes[$type])) {
+            throw new \Exception(sprintf('Unknown parameter type "%s"', $type));
+        }
+
+        return $this->fieldTypes[$type];
+    }
+}
diff --git a/Resources/config/field_types.yml b/Resources/config/field_types.yml
@@ -0,0 +1,5 @@
+services:
+    sherlockode_configuration.field.text:
+        class: Sherlockode\ConfigurationBundle\FieldType\TextField
+        tags:
+            - {name: sherlockode_configuration.field }
diff --git a/Resources/config/services.yml b/Resources/config/services.yml
@@ -11,6 +11,8 @@ services:
             - '@doctrine.orm.entity_manager'
             - '%sherlockode_configuration.parameter_class%'
             - '%sherlockode_configuration.parameters%'
+    sherlockode_configuration.field_manager:
+        class: Sherlockode\ConfigurationBundle\Manager\FieldTypeManager
     sherlockode_configuration.form.parameters:
         class: Sherlockode\ConfigurationBundle\Form\Type\ParametersType
         arguments:
@@ -21,7 +23,9 @@ services:
         class: Sherlockode\ConfigurationBundle\Form\Type\ParameterType
         arguments:
             - '%sherlockode_configuration.parameter_class%'
+            - '@sherlockode_configuration.field_manager'
         tags:
             - {name: form.type }
 
     Sherlockode\ConfigurationBundle\Manager\ParameterManager: '@sherlockode_configuration.parameter_manager'
+    Sherlockode\ConfigurationBundle\Manager\FieldTypeManager: '@sherlockode_configuration.field_manager'
diff --git a/SherlockodeConfigurationBundle.php b/SherlockodeConfigurationBundle.php
@@ -2,9 +2,14 @@
 
 namespace Sherlockode\ConfigurationBundle;
 
+use Sherlockode\ConfigurationBundle\DependencyInjection\Compiler\FieldTypePass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 class SherlockodeConfigurationBundle extends Bundle
 {
-
+    public function build(ContainerBuilder $container)
+    {
+        $container->addCompilerPass(new FieldTypePass());
+    }
 }