Merge pull request #13 from KrzysztofMoskalik/embed-forms

Embed forms

Author: malarzm

Annotations/Embed.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Codete\FormGeneratorBundle\Annotations;
+
+/**
+ * @Annotation
+ */
+class Embed extends Display
+{
+    public $view = 'default';
+
+    public $type = 'embed';
+}

FieldTypeMapper.php

@@ -9,6 +9,7 @@ class FieldTypeMapper
     private static $typeNS = [
         'Symfony\\Component\\Form\\Extension\\Core\\Type',
         'Symfony\\Bridge\\Doctrine\\Form\\Type',
+        'Codete\\FormGeneratorBundle\\Form\\Type',
     ];
 
     /**

Form/Type/EmbedType.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Codete\FormGeneratorBundle\Form\Type;
+
+use Codete\FormGeneratorBundle\FormGenerator;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+
+class EmbedType extends AbstractType
+{
+    const TYPE = 'embed';
+
+    /**
+     * @var FormGenerator $formGenerator
+     */
+    private $formGenerator;
+
+    /**
+     * @param FormGenerator $formGenerator
+     */
+    public function __construct(FormGenerator $formGenerator)
+    {
+        $this->formGenerator = $formGenerator;
+    }
+
+    /**
+     * @param FormBuilderInterface $builder
+     * @param array $options
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $this->formGenerator->populateFormBuilder($builder, $options['model'], $options['view'], isset($options['context']) ? $options['context'] : []);
+    }
+
+    /**
+     * @param OptionsResolver $resolver
+     */
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'view' => 'default',
+            'class' => '',
+            'context' => [],
+            'model' => null
+        ]);
+    }
+
+    /**
+     * @return string
+     */
+    public function getBlockPrefix()
+    {
+        return self::TYPE;
+    }
+
+    /**
+     * This should stay until we drop Symfony 2.7 support
+     *
+     * @return string
+     */
+    public function getName()
+    {
+        return self::TYPE;
+    }
+}

FormConfigurationFactory.php

@@ -4,8 +4,10 @@
 
 use Codete\FormGeneratorBundle\Annotations\Display;
 use Codete\FormGeneratorBundle\Annotations\Form;
+use Codete\FormGeneratorBundle\Form\Type\EmbedType;
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\Reader;
+use Doctrine\Instantiator\Instantiator;
 
 /**
  * FormConfigurationFactory creates initial form configuration that is adjusted later.
@@ -24,13 +26,19 @@ class FormConfigurationFactory
      */
     private $annotationReader;
 
+    /**
+     * @var Instantiator
+     */
+    private $instantiator;
+
     /**
      * @param AdjusterRegistry $adjusterRegistry
      */
     public function __construct(AdjusterRegistry $adjusterRegistry)
     {
         $this->adjusterRegistry = $adjusterRegistry;
         $this->annotationReader = new AnnotationReader();
+        $this->instantiator = new Instantiator();
     }
 
     /**
@@ -88,6 +96,13 @@ private function getFieldsConfiguration($model, $fields = [])
             if (isset($fields[$property->getName()])) {
                 $configuration[$property->getName()] = array_replace_recursive($configuration[$property->getName()], $fields[$property->getName()]);
             }
+            if ($configuration[$property->getName()]['type'] === EmbedType::TYPE) {
+                if (($value = $property->getValue($model)) === null) {
+                    $value = $this->instantiator->instantiate($configuration[$property->getName()]['class']);
+                }
+                $configuration[$property->getName()]['data_class'] = $configuration[$property->getName()]['class'];
+                $configuration[$property->getName()]['model'] = $value;
+            }
             // this variable comes from Doctrine\Common\Annotations\Annotation
             unset($configuration[$property->getName()]['value']);
         }

README.md

@@ -105,6 +105,33 @@ you to pass any additional informations you want in optional
 which defines order of execution (default is `0`, if two or more
 services have same priority then first added is executed first).
 
+Embed Forms
+-----------
+
+FormGenerator will build also forms for nested models:
+
+ ``` php
+/*
+* @Form\Embed(
+*   class = "Codete\FormGeneratorBundle\Tests\Model\Person",
+* )
+*/
+public $person;
+```
+
+This will build form from all nested model properties,
+but we can specify which view we want to use:
+
+ ``` php
+/*
+* @Form\Embed(
+*   class = "Codete\FormGeneratorBundle\Tests\Model\Person",
+*   view = "work"
+* )
+*/
+public $employee;
+```
+
 FormViewProvider
 ----------------
 

Resources/config/form_generator.xml

@@ -8,6 +8,11 @@
         <service id="form_generator" class="Codete\FormGeneratorBundle\FormGenerator">
             <argument type="service" id="form.factory"/>
         </service>
+
+        <service id="form_generator.type.embed" class="Codete\FormGeneratorBundle\Form\Type\EmbedType">
+            <tag name="form.type" alias="embed" />
+            <argument type="service" id="form_generator" />
+        </service>
 
     </services>
 

Tests/BaseTest.php

@@ -4,19 +4,28 @@
 
 use Doctrine\Common\Annotations\AnnotationRegistry;
 use Codete\FormGeneratorBundle\FormGenerator;
+use Symfony\Component\Form\FormFactoryBuilderInterface;
 use Symfony\Component\Form\Forms;
 
 abstract class BaseTest extends \PHPUnit_Framework_TestCase
 {
     /** @var \Codete\FormGeneratorBundle\FormGenerator */
     protected $formGenerator;
-    
+
+    /**
+     * @var FormFactoryBuilderInterface
+     */
+    protected $formFactoryBuilder;
+
     public function setUp()
     {
         $loader = require __DIR__.'/../vendor/autoload.php';
         AnnotationRegistry::registerLoader([$loader, 'loadClass']);
+
+        $this->formFactoryBuilder = Forms::createFormFactoryBuilder();
+
         $this->formGenerator = new FormGenerator(
-            Forms::createFormFactoryBuilder()->getFormFactory()
+            $this->formFactoryBuilder->getFormFactory()
         );
     }
 }

Tests/FieldTypeMapperTest.php

@@ -24,6 +24,7 @@ public function dataProvider()
                 ['dateTime', 'dateTime'],
                 [null, null],
                 ['unknown', 'unknown'],
+                ['embed', 'embed']
             ];
         } else {
             return [
@@ -32,6 +33,7 @@ public function dataProvider()
                 ['dateTime', 'Symfony\\Component\\Form\\Extension\\Core\\Type\\DateTimeType'],
                 [null, null],
                 ['unknown', 'unknown'],
+                ['embed', 'Codete\\FormGeneratorBundle\\Form\\Type\\EmbedType']
             ];
         }
     }

Tests/FormConfigurationModifier/NoPhotoPersonModifier.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Codete\FormGeneratorBundle\Tests\FormConfigurationModifier;
+
+use Codete\FormGeneratorBundle\FormConfigurationModifierInterface;
+use Codete\FormGeneratorBundle\Tests\Model\Person;
+
+class NoPhotoPersonModifier implements FormConfigurationModifierInterface
+{
+    public function modify($model, $configuration, $context) 
+    {
+        unset($configuration['photo']);
+        return $configuration;
+    }
+
+    public function supports($model, $configuration, $context) 
+    {
+        return $model instanceof Person && isset($context['no_photo']) && $context['no_photo'] === true;
+    }
+}

Tests/FormGeneratorTest.php

@@ -2,8 +2,32 @@
 
 namespace Codete\FormGeneratorBundle\Tests;
 
+use Codete\FormGeneratorBundle\FieldTypeMapper;
+use Codete\FormGeneratorBundle\Form\Type\EmbedType;
+use Codete\FormGeneratorBundle\Tests\FormConfigurationModifier\InactivePersonModifier;
+use Codete\FormGeneratorBundle\Tests\FormConfigurationModifier\NoPhotoPersonModifier;
+use Codete\FormGeneratorBundle\Tests\Model\Person;
+use Codete\FormGeneratorBundle\Tests\Model\SimpleParent;
+use Symfony\Component\Form\PreloadedExtension;
+
 class FormGeneratorTest extends BaseTest
 {
+    /**
+     * @var PreloadedExtension
+     */
+    protected $embedTypeExtension;
+
+    public function setUp()
+    {
+        parent::setUp();
+
+        $embedType = new EmbedType($this->formGenerator);
+
+        $this->embedTypeExtension = new PreloadedExtension([
+            $embedType->getBlockPrefix() => $embedType,
+        ], []);
+    }
+
     /**
      * @dataProvider provideDefaultForm
      */
@@ -172,4 +196,38 @@ protected function checkForm($model, $expectedFields, callable $additionalCheck
             $additionalCheck($this, $form);
         }
     }
+
+    public function testEmbedForms()
+    {
+        $sp = new SimpleParent();
+
+        $sp->employee = new Person();
+        $sp->named = new Person();
+
+        $sp->employee->salary = 1390.86;
+        $sp->named->active = false;
+
+        $sp->person = new Person('Bar', 'Baz');
+
+        $fb = $this->formFactoryBuilder
+            ->addExtension($this->embedTypeExtension)
+            ->getFormFactory()
+            ->createBuilder(FieldTypeMapper::map('form'), $sp);
+
+        $this->formGenerator->addFormConfigurationModifier(new NoPhotoPersonModifier());
+        $this->formGenerator->addFormConfigurationModifier(new InactivePersonModifier());
+
+        $this->formGenerator->populateFormBuilder($fb, $sp);
+        $form = $fb->getForm();
+        $this->assertEquals(count(['person', 'noName', 'anonymous', 'employee']), count($form));
+        $this->assertEquals(count(['title', 'name', 'surname', 'photo', 'active', 'salary']), $form->get('person')->count());
+        $this->assertEquals(count(['title', 'name', 'surname', 'photo', 'active']), $form->get('named')->count());
+        $this->assertEquals(count(['title', 'name', 'surname', 'active', 'salary']), $form->get('anonymous')->count());
+        $this->assertEquals(count(['salary']), $form->get('employee')->count());
+        $this->assertEquals(1390.86, $form->get('employee')->get('salary')->getData());
+        $this->assertNull($form->get('anonymous')->get('name')->getData());
+        $this->assertEquals('Foo', $form->get('named')->get('name')->getData());
+        $this->assertEquals('Bar', $form->get('person')->get('name')->getData());
+        $this->assertEquals('Baz', $form->get('person')->get('surname')->getData());
+    }
 }