Merge branch '3.4' into 4.1

* 3.4:
  Command::addOption should allow int in $default
  [Form] Fixed keeping hash of equal \DateTimeInterface on submit
  [PhpUnitBridge] Fix typo
  [Form] Minor fixes in docs and cs
  [Config] Unset key during normalization
  [Form] Fixed empty data for compound date types
  invalidate forms on transformation failures
  [PropertyAccessor] Fix unable to write to singular property using setter while plural adder/remover exist

Author: nicolas-grekas

Extension/Core/CoreExtension.php

@@ -16,8 +16,10 @@
 use Symfony\Component\Form\ChoiceList\Factory\ChoiceListFactoryInterface;
 use Symfony\Component\Form\ChoiceList\Factory\DefaultChoiceListFactory;
 use Symfony\Component\Form\ChoiceList\Factory\PropertyAccessDecorator;
+use Symfony\Component\Form\Extension\Core\Type\TransformationFailureExtension;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Component\Translation\TranslatorInterface;
 
 /**
  * Represents the main form extension, which loads the core functionality.
@@ -28,11 +30,13 @@ class CoreExtension extends AbstractExtension
 {
     private $propertyAccessor;
     private $choiceListFactory;
+    private $translator;
 
-    public function __construct(PropertyAccessorInterface $propertyAccessor = null, ChoiceListFactoryInterface $choiceListFactory = null)
+    public function __construct(PropertyAccessorInterface $propertyAccessor = null, ChoiceListFactoryInterface $choiceListFactory = null, TranslatorInterface $translator = null)
     {
         $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
         $this->choiceListFactory = $choiceListFactory ?: new CachingFactoryDecorator(new PropertyAccessDecorator(new DefaultChoiceListFactory(), $this->propertyAccessor));
+        $this->translator = $translator;
     }
 
     protected function loadTypes()
@@ -74,4 +78,11 @@ protected function loadTypes()
             new Type\ColorType(),
         );
     }
+
+    protected function loadTypeExtensions()
+    {
+        return array(
+            new TransformationFailureExtension($this->translator),
+        );
+    }
 }

Extension/Core/DataMapper/PropertyPathMapper.php

@@ -73,16 +73,17 @@ public function mapFormsToData($forms, &$data)
             // Write-back is disabled if the form is not synchronized (transformation failed),
             // if the form was not submitted and if the form is disabled (modification not allowed)
             if (null !== $propertyPath && $config->getMapped() && $form->isSubmitted() && $form->isSynchronized() && !$form->isDisabled()) {
-                // If the field is of type DateTime and the data is the same skip the update to
+                $propertyValue = $form->getData();
+                // If the field is of type DateTimeInterface and the data is the same skip the update to
                 // keep the original object hash
-                if ($form->getData() instanceof \DateTime && $form->getData() == $this->propertyAccessor->getValue($data, $propertyPath)) {
+                if ($propertyValue instanceof \DateTimeInterface && $propertyValue == $this->propertyAccessor->getValue($data, $propertyPath)) {
                     continue;
                 }
 
                 // If the data is identical to the value in $data, we are
                 // dealing with a reference
-                if (!\is_object($data) || !$config->getByReference() || $form->getData() !== $this->propertyAccessor->getValue($data, $propertyPath)) {
-                    $this->propertyAccessor->setValue($data, $propertyPath, $form->getData());
+                if (!\is_object($data) || !$config->getByReference() || $propertyValue !== $this->propertyAccessor->getValue($data, $propertyPath)) {
+                    $this->propertyAccessor->setValue($data, $propertyPath, $propertyValue);
                 }
             }
         }

Extension/Core/EventListener/TransformationFailureListener.php

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Extension\Core\EventListener;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Form\FormError;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+use Symfony\Component\Translation\TranslatorInterface;
+
+/**
+ * @author Christian Flothmann <christian.flothmann@sensiolabs.de>
+ */
+class TransformationFailureListener implements EventSubscriberInterface
+{
+    private $translator;
+
+    public function __construct(TranslatorInterface $translator = null)
+    {
+        $this->translator = $translator;
+    }
+
+    public static function getSubscribedEvents()
+    {
+        return array(
+            FormEvents::POST_SUBMIT => array('convertTransformationFailureToFormError', -1024),
+        );
+    }
+
+    public function convertTransformationFailureToFormError(FormEvent $event)
+    {
+        $form = $event->getForm();
+
+        if (null === $form->getTransformationFailure() || !$form->isValid()) {
+            return;
+        }
+
+        foreach ($form as $child) {
+            if (!$child->isSynchronized()) {
+                return;
+            }
+        }
+
+        $clientDataAsString = is_scalar($form->getViewData()) ? (string) $form->getViewData() : \gettype($form->getViewData());
+        $messageTemplate = 'The value {{ value }} is not valid.';
+
+        if (null !== $this->translator) {
+            $message = $this->translator->trans($messageTemplate, array('{{ value }}' => $clientDataAsString));
+        } else {
+            $message = strtr($messageTemplate, array('{{ value }}' => $clientDataAsString));
+        }
+
+        $form->addError(new FormError($message, $messageTemplate, array('{{ value }}' => $clientDataAsString), null, $form->getTransformationFailure()));
+    }
+}

Extension/Core/Type/DateTimeType.php

@@ -91,6 +91,9 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 ));
             }
         } else {
+            // when the form is compound the entries of the array are ignored in favor of children data
+            // so we need to handle the cascade setting here
+            $emptyData = $builder->getEmptyData() ?: array();
             // Only pass a subset of the options to children
             $dateOptions = array_intersect_key($options, array_flip(array(
                 'years',
@@ -105,6 +108,10 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 'invalid_message_parameters',
             )));
 
+            if (isset($emptyData['date'])) {
+                $dateOptions['empty_data'] = $emptyData['date'];
+            }
+
             $timeOptions = array_intersect_key($options, array_flip(array(
                 'hours',
                 'minutes',
@@ -120,6 +127,10 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 'invalid_message_parameters',
             )));
 
+            if (isset($emptyData['time'])) {
+                $timeOptions['empty_data'] = $emptyData['time'];
+            }
+
             if (false === $options['label']) {
                 $dateOptions['label'] = false;
                 $timeOptions['label'] = false;
@@ -227,6 +238,9 @@ public function configureOptions(OptionsResolver $resolver)
             // this option.
             'data_class' => null,
             'compound' => $compound,
+            'empty_data' => function (Options $options) {
+                return $options['compound'] ? array() : '';
+            },
         ));
 
         // Don't add some defaults in order to preserve the defaults

Extension/Core/Type/DateType.php

@@ -76,7 +76,21 @@ public function buildForm(FormBuilderInterface $builder, array $options)
 
             $yearOptions = $monthOptions = $dayOptions = array(
                 'error_bubbling' => true,
+                'empty_data' => '',
             );
+            // when the form is compound the entries of the array are ignored in favor of children data
+            // so we need to handle the cascade setting here
+            $emptyData = $builder->getEmptyData() ?: array();
+
+            if (isset($emptyData['year'])) {
+                $yearOptions['empty_data'] = $emptyData['year'];
+            }
+            if (isset($emptyData['month'])) {
+                $monthOptions['empty_data'] = $emptyData['month'];
+            }
+            if (isset($emptyData['day'])) {
+                $dayOptions['empty_data'] = $emptyData['day'];
+            }
 
             if (isset($options['invalid_message'])) {
                 $dayOptions['invalid_message'] = $options['invalid_message'];
@@ -265,6 +279,9 @@ public function configureOptions(OptionsResolver $resolver)
             // this option.
             'data_class' => null,
             'compound' => $compound,
+            'empty_data' => function (Options $options) {
+                return $options['compound'] ? array() : '';
+            },
             'choice_translation_domain' => false,
         ));
 

Extension/Core/Type/TimeType.php

@@ -71,7 +71,15 @@ public function buildForm(FormBuilderInterface $builder, array $options)
         } else {
             $hourOptions = $minuteOptions = $secondOptions = array(
                 'error_bubbling' => true,
+                'empty_data' => '',
             );
+            // when the form is compound the entries of the array are ignored in favor of children data
+            // so we need to handle the cascade setting here
+            $emptyData = $builder->getEmptyData() ?: array();
+
+            if (isset($emptyData['hour'])) {
+                $hourOptions['empty_data'] = $emptyData['hour'];
+            }
 
             if (isset($options['invalid_message'])) {
                 $hourOptions['invalid_message'] = $options['invalid_message'];
@@ -136,10 +144,16 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             $builder->add('hour', self::$widgets[$options['widget']], $hourOptions);
 
             if ($options['with_minutes']) {
+                if (isset($emptyData['minute'])) {
+                    $minuteOptions['empty_data'] = $emptyData['minute'];
+                }
                 $builder->add('minute', self::$widgets[$options['widget']], $minuteOptions);
             }
 
             if ($options['with_seconds']) {
+                if (isset($emptyData['second'])) {
+                    $secondOptions['empty_data'] = $emptyData['second'];
+                }
                 $builder->add('second', self::$widgets[$options['widget']], $secondOptions);
             }
 
@@ -258,6 +272,9 @@ public function configureOptions(OptionsResolver $resolver)
             // representation is not \DateTime, but an array, we need to unset
             // this option.
             'data_class' => null,
+            'empty_data' => function (Options $options) {
+                return $options['compound'] ? array() : '';
+            },
             'compound' => $compound,
             'choice_translation_domain' => false,
         ));

Extension/Core/Type/TransformationFailureExtension.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Extension\Core\Type;
+
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\Extension\Core\EventListener\TransformationFailureListener;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Translation\TranslatorInterface;
+
+/**
+ * @author Christian Flothmann <christian.flothmann@sensiolabs.de>
+ */
+class TransformationFailureExtension extends AbstractTypeExtension
+{
+    private $translator;
+
+    public function __construct(TranslatorInterface $translator = null)
+    {
+        $this->translator = $translator;
+    }
+
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        if (!isset($options['invalid_message']) && !isset($options['invalid_message_parameters'])) {
+            $builder->addEventSubscriber(new TransformationFailureListener($this->translator));
+        }
+    }
+
+    public function getExtendedType()
+    {
+        return 'Symfony\Component\Form\Extension\Core\Type\FormType';
+    }
+}

Form.php

@@ -31,24 +31,26 @@
  *
  *   (1) the "model" format required by the form's object
  *   (2) the "normalized" format for internal processing
- *   (3) the "view" format used for display
+ *   (3) the "view" format used for display simple fields
+ *       or map children model data for compound fields
  *
  * A date field, for example, may store a date as "Y-m-d" string (1) in the
  * object. To facilitate processing in the field, this value is normalized
  * to a DateTime object (2). In the HTML representation of your form, a
- * localized string (3) is presented to and modified by the user.
+ * localized string (3) may be presented to and modified by the user, or it could be an array of values
+ * to be mapped to choices fields.
  *
  * In most cases, format (1) and format (2) will be the same. For example,
  * a checkbox field uses a Boolean value for both internal processing and
- * storage in the object. In these cases you simply need to set a value
+ * storage in the object. In these cases you simply need to set a view
  * transformer to convert between formats (2) and (3). You can do this by
  * calling addViewTransformer().
  *
  * In some cases though it makes sense to make format (1) configurable. To
  * demonstrate this, let's extend our above date field to store the value
  * either as "Y-m-d" string or as timestamp. Internally we still want to
  * use a DateTime object for processing. To convert the data from string/integer
- * to DateTime you can set a normalization transformer by calling
+ * to DateTime you can set a model transformer by calling
  * addModelTransformer(). The normalized data is then converted to the displayed
  * data as described before.
  *
@@ -217,7 +219,7 @@ public function getPropertyPath()
         }
 
         if (null === $this->getName() || '' === $this->getName()) {
-            return;
+            return null;
         }
 
         $parent = $this->parent;
@@ -340,8 +342,8 @@ public function setData($modelData)
             $modelData = $event->getData();
         }
 
-        // Treat data as strings unless a value transformer exists
-        if (!$this->config->getViewTransformers() && !$this->config->getModelTransformers() && is_scalar($modelData)) {
+        // Treat data as strings unless a transformer exists
+        if (is_scalar($modelData) && !$this->config->getViewTransformers() && !$this->config->getModelTransformers()) {
             $modelData = (string) $modelData;
         }
 
@@ -1014,7 +1016,7 @@ public function createView(FormView $parent = null)
     }
 
     /**
-     * Normalizes the value if a normalization transformer is set.
+     * Normalizes the value if a model transformer is set.
      *
      * @param mixed $value The value to transform
      *
@@ -1036,7 +1038,7 @@ private function modelToNorm($value)
     }
 
     /**
-     * Reverse transforms a value if a normalization transformer is set.
+     * Reverse transforms a value if a model transformer is set.
      *
      * @param string $value The value to reverse transform
      *
@@ -1060,7 +1062,7 @@ private function normToModel($value)
     }
 
     /**
-     * Transforms the value if a value transformer is set.
+     * Transforms the value if a view transformer is set.
      *
      * @param mixed $value The value to transform
      *
@@ -1091,7 +1093,7 @@ private function normToView($value)
     }
 
     /**
-     * Reverse transforms a value if a value transformer is set.
+     * Reverse transforms a value if a view transformer is set.
      *
      * @param string $value The value to reverse transform
      *

NativeRequestHandler.php

@@ -15,7 +15,7 @@
 use Symfony\Component\Form\Util\ServerParams;
 
 /**
- * A request handler using PHP's super globals $_GET, $_POST and $_SERVER.
+ * A request handler using PHP super globals $_GET, $_POST and $_SERVER.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  */
@@ -213,7 +213,7 @@ private static function stripEmptyFiles($data)
 
         if (self::$fileKeys === $keys) {
             if (UPLOAD_ERR_NO_FILE === $data['error']) {
-                return;
+                return null;
             }
 
             return $data;