Add support for HTML5 color input type (#427)

Form/Type/ColorSelectorType.php

@@ -16,6 +16,17 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\OptionsResolver\OptionsResolverInterface;
 
+@trigger_error(
+    'The '.__NAMESPACE__.'\ColorSelectorType class is deprecated since version 3.4 and will be removed in 4.0.'
+    .' Use '.__NAMESPACE__.'\ColorType instead.',
+    E_USER_DEPRECATED
+);
+
+/**
+ * NEXT_MAJOR: remove this class.
+ *
+ * @deprecated since version 3.4, to be removed in 4.0. Use ColorType instead
+ */
 class ColorSelectorType extends AbstractType
 {
     /**

Form/Type/ColorType.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\CoreBundle\Form\Type;
+
+use Symfony\Component\Form\AbstractType;
+
+final class ColorType extends AbstractType
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getParent()
+    {
+        return method_exists('Symfony\Component\Form\AbstractType', 'getBlockPrefix') ?
+            'Symfony\Component\Form\Extension\Core\Type\TextType' :
+            'text' // SF <2.8 BC
+            ;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
+    {
+        return 'sonata_type_color';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+}

Resources/config/form_types.xml

@@ -47,5 +47,8 @@
         <service id="sonata.core.form.type.color_selector" class="Sonata\CoreBundle\Form\Type\ColorSelectorType">
             <tag name="form.type" alias="sonata_type_color_selector"/>
         </service>
+        <service id="sonata.core.form.type.color" class="Sonata\CoreBundle\Form\Type\ColorType">
+            <tag name="form.type" alias="sonata_type_color"/>
+        </service>
     </services>
 </container>

Resources/doc/reference/form_types.rst

@@ -487,12 +487,12 @@ Example with ``doctrine_orm_date_range`` filter:
         // ...
     }
 
-sonata_type_color_picker
+sonata_type_color
 ------------------------
 
-This type a simple color picker from AdminLTE colors. Its available as service, and inherit from ``choice`` default form types.
+This is HTML5 input type color.
 
-.. image:: ../images/colorpicker.png
+.. image:: ../images/color.png
 
 In order to use it, you'll need to perform a bit of setup:
 
@@ -503,7 +503,7 @@ In order to use it, you'll need to perform a bit of setup:
         # app/config/config.yml
         twig:
             form_themes:
-                - 'SonataCoreBundle:Form:colorpicker.html.twig'
+                - 'SonataCoreBundle:Form:color.html.twig'
 
 Finally, in your form, you may use the form type as follows:
 
@@ -517,7 +517,7 @@ Finally, in your form, you may use the form type as follows:
         protected function configureFormFields(FormMapper $formMapper)
         {
             $formMapper
-                ->add('color', 'sonata_type_color_selector')
+                ->add('color', 'sonata_type_color')
                 // ...
             ;
         }

Resources/views/Form/color.html.twig

@@ -0,0 +1,15 @@
+{#
+
+This file is part of the Sonata package.
+
+(c) Thomas Rabaix <[email protected]>
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+
+#}
+{% block sonata_type_color_widget %}
+    {% spaceless %}
+        <input type="color" {{ block('widget_attributes') }} {% if value is not empty %}value="{{ value }}" {% endif %}/>
+    {% endspaceless %}
+{% endblock sonata_type_color_widget %}

Tests/Form/Type/ColorTypeTest.php

@@ -0,0 +1,92 @@
+<?php
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\CoreBundle\Tests\Form\Type;
+
+use Sonata\CoreBundle\Form\Type\ColorType;
+
+class ColorTypeTest extends TypeTestCase
+{
+    public function testBuildForm()
+    {
+        // NEXT_MAJOR: Hack for php 5.3 only, remove it when requirement of PHP is >= 5.4
+        $that = $this;
+
+        $formBuilder = $this->getMockBuilder('Symfony\Component\Form\FormBuilder')->disableOriginalConstructor()->getMock();
+        $formBuilder
+            ->expects($this->any())
+            ->method('add')
+            ->will($this->returnCallback(function ($name, $type = null) use ($that) {
+                // NEXT_MAJOR: Remove this "if" (when requirement of Symfony is >= 2.8)
+                if (method_exists('Symfony\Component\Form\AbstractType', 'getBlockPrefix')) {
+                    if (null !== $type) {
+                        $isFQCN = class_exists($type);
+                        if (!$isFQCN && method_exists('Symfony\Component\Form\AbstractType', 'getName')) {
+                            // 2.8
+                            @trigger_error(
+                                sprintf(
+                                    'Accessing type "%s" by its string name is deprecated since version 2.8 and will be removed in 3.0.'
+                                    .' Use the fully-qualified type class name instead.',
+                                    $type
+                                ),
+                                E_USER_DEPRECATED)
+                            ;
+                        }
+
+                        $that->assertTrue($isFQCN, sprintf('Unable to ensure %s is a FQCN', $type));
+                    }
+                }
+            }));
+
+        $type = new ColorType();
+        $type->buildForm($formBuilder, array());
+    }
+
+    public function testSubmitValidData()
+    {
+        $data = '#556b2f';
+
+        if (method_exists('Symfony\Component\Form\AbstractType', 'getBlockPrefix')) {
+            $type = 'Sonata\CoreBundle\Form\Type\ColorType';
+        } else {
+            $type = new ColorType();
+        }
+
+        $form = $this->factory->create($type);
+        $form->submit($data);
+        $this->assertTrue($form->isSynchronized());
+    }
+
+    public function testGetParent()
+    {
+        $form = new ColorType();
+
+        // NEXT_MAJOR: Remove this "if" (when requirement of Symfony is >= 2.8)
+        if (method_exists('Symfony\Component\Form\AbstractType', 'getBlockPrefix')) {
+            $parentRef = $form->getParent();
+
+            $isFQCN = class_exists($parentRef);
+            if (!$isFQCN && method_exists('Symfony\Component\Form\AbstractType', 'getName')) {
+                // 2.8
+                @trigger_error(
+                    sprintf(
+                        'Accessing type "%s" by its string name is deprecated since version 2.8 and will be removed in 3.0.'
+                        .' Use the fully-qualified type class name instead.',
+                        $parentRef
+                    ),
+                    E_USER_DEPRECATED)
+                ;
+            }
+
+            $this->assertTrue($isFQCN, sprintf('Unable to ensure %s is a FQCN', $parentRef));
+        }
+    }
+}