Merge pull request #13 from oliverde8/feature-#12/entity-config

Feature #12 - Added new config type for selecting Entities

Author: oliverde8

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.1.0
+
+- :star2: Added new Entity config type.
+
 # 1.0.0 
 
 - :confetti_ball: :tada: First stable release :tada: :confetti_ball:

Model/EntityConfig.php

@@ -0,0 +1,86 @@
+<?php
+
+
+namespace oliverde8\ComfyBundle\Model;
+
+
+use Doctrine\ORM\EntityManagerInterface;
+use oliverde8\ComfyBundle\Manager\ConfigManagerInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+
+class EntityConfig extends TextConfig
+{
+    private EntityManagerInterface $entityManager;
+
+    protected string $entity;
+
+    protected string $choiceLabel;
+
+    public function __construct(
+        ConfigManagerInterface $configManager,
+        ValidatorInterface $validator,
+        EntityManagerInterface $entityManager,
+        string $path,
+        string $name,
+        string $description = "",
+        int $scope = PHP_INT_MAX,
+        ?string $defaultValue = null,
+        bool $isHidden = false,
+        string $entity = "",
+        string $choiceLabel = "id"
+    ) {
+        parent::__construct($configManager, $validator, $path, $name, $description, $scope, $defaultValue, $isHidden);
+
+        $this->entityManager = $entityManager;
+        $this->entity = $entity;
+        $this->choiceLabel = $choiceLabel;
+    }
+
+    /**
+     * Serialize value to save it in Database.
+     *
+     * @param $value
+     *
+     * @return string|null
+     */
+    protected function serialize($value): ?string
+    {
+        if (is_object($value)) {
+            return $value->getId();
+        } else {
+            return $value;
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getEntity(): string
+    {
+        return $this->entity;
+    }
+
+    /**
+     * @return string
+     */
+    public function getChoiceLabel(): string
+    {
+        return $this->choiceLabel;
+    }
+
+    /**
+     * Deserialize value read from database.
+     *
+     * @param string|null $value
+     *
+     * @return mixed|null
+     */
+    protected function deserialize(?string $value)
+    {
+        if ($value) {
+            return $this->entityManager->getRepository($this->entity)->find($value);
+        } else {
+            return null;
+        }
+    }
+}

Resolver/Form/EntityFormProvider.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace oliverde8\ComfyBundle\Resolver\Form;
+
+use oliverde8\ComfyBundle\Exception\InvalidConfigTypeForFormProvider;
+use oliverde8\ComfyBundle\Model\ConfigInterface;
+use oliverde8\ComfyBundle\Model\EntityConfig;
+use oliverde8\ComfyBundle\Model\SelectConfig;
+use Symfony\Bridge\Doctrine\Form\Type\EntityType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormInterface;
+
+class EntityFormProvider extends SimpleFormProvider
+{
+    /**
+     * @inheritdoc
+     */
+    public function addTypeToForm(string $name, ConfigInterface $config, FormBuilderInterface $formBuilder, string $scope)
+    {
+        if (!($config instanceof EntityConfig)) {
+            throw new InvalidConfigTypeForFormProvider(
+                sprintf("Config is expected to be of type %s but is of type %s", SelectConfig::class, get_class($config))
+            );
+        }
+
+        $formBuilder->add(
+            $name,
+            $this->formType,
+            [
+                'label' => $config->getName(),
+                'help' => $this->getHelpHtml($config, $scope),
+                'data' => $config->get($scope),
+                'class'  => $config->getEntity(),
+                'choice_label' => $config->getChoiceLabel(),
+            ],
+        );
+    }
+}

Resources/config/form-type-provider.yml

@@ -28,6 +28,13 @@ services:
       $formType: 'Symfony\Component\Form\Extension\Core\Type\TextareaType'
     tags:
       - "comfy.form_provider"
+  oliverde8.comfy_bundle.form_type_provider.entity:
+    class: oliverde8\ComfyBundle\Resolver\Form\EntityFormProvider
+    arguments:
+      $configType: 'oliverde8\ComfyBundle\Model\EntityConfig'
+      $formType: 'Symfony\Bridge\Doctrine\Form\Type\EntityType'
+    tags:
+      - "comfy.form_provider"
 
   oliverde8.comfy_bundle.form_type_provider.default:
     class: oliverde8\ComfyBundle\Resolver\Form\SimpleFormProvider

docs/getting-started.md

@@ -157,3 +157,19 @@ $this->myConfig->set($newValue, "default/en_GB");
     tags:
       - "comfy.config"
 ```
+
+#### Entity
+
+```yaml
+  myvendor.mybundle.comfy.generic.entity:
+    class: oliverde8\ComfyBundle\Model\JsonConfig
+    arguments:
+      $path: "dummy/generic/entity"
+      $name: "My Entity"
+      $description: "The selected entity object"
+      $defaultValue: '12' # can be null
+      $entity: 'App/Entity/MyEntity'
+      $choiceLabel: 'label' # Name of the label field.
+    tags:
+      - "comfy.config"
+```