[Form] Deprecated FormTypeInterface::getName() and passing of type in…

…stances
symfony · Jul 2, 2015 · 3b14634 · 3b14634
1 parent 8bd89dc
commit 3b14634
Show file tree

Hide file tree

Showing 108 changed files with 2,191 additions and 958 deletions.
diff --git a/AbstractExtension.php b/AbstractExtension.php
@@ -156,7 +156,15 @@ private function initTypes()
                 throw new UnexpectedTypeException($type, 'Symfony\Component\Form\FormTypeInterface');
             }
 
-            $this->types[$type->getName()] = $type;
+            // Since Symfony 3.0 types are identified by their FQCN
+            $fqcn = get_class($type);
+            $legacyName = $type->getName();
+
+            $this->types[$fqcn] = $type;
+
+            if ($legacyName) {
+                $this->types[$legacyName] = $type;
+            }
         }
     }
 

diff --git a/AbstractType.php b/AbstractType.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Form;
 
+use Symfony\Component\Form\Util\StringUtil;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\OptionsResolver\OptionsResolverInterface;
 
@@ -61,11 +62,37 @@ public function configureOptions(OptionsResolver $resolver)
     {
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        // As of Symfony 2.8, the name defaults to the fully-qualified class name
+        return get_class($this);
+    }
+
+    /**
+     * Returns the prefix of the template block name for this type.
+     *
+     * The block prefixes defaults to the underscored short class name with
+     * the "Type" suffix removed (e.g. "UserProfileType" => "user_profile").
+     *
+     * @return string The prefix of the template block name
+     */
+    public function getBlockPrefix()
+    {
+        $fqcn = get_class($this);
+        $name = $this->getName();
+
+        // For BC: Use the name as block prefix if one is set
+        return $name !== $fqcn ? $name : StringUtil::fqcnToBlockPrefix($fqcn);
+    }
+
     /**
      * {@inheritdoc}
      */
     public function getParent()
     {
-        return 'form';
+        return 'Symfony\Component\Form\Extension\Core\Type\FormType';
     }
 }
diff --git a/Extension/Core/Type/BaseType.php b/Extension/Core/Type/BaseType.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\FormView;
+use Symfony\Component\Form\Util\StringUtil;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
@@ -77,7 +78,17 @@ public function buildView(FormView $view, FormInterface $form, array $options)
 
         $blockPrefixes = array();
         for ($type = $form->getConfig()->getType(); null !== $type; $type = $type->getParent()) {
-            array_unshift($blockPrefixes, $type->getName());
+            if (method_exists($type, 'getBlockPrefix')) {
+                array_unshift($blockPrefixes, $type->getBlockPrefix());
+            } else {
+                @trigger_error(get_class($type).': The ResolvedFormTypeInterface::getBlockPrefix() method will be added in version 3.0. You should add it to your implementation.', E_USER_DEPRECATED);
+
+                $fqcn = get_class($type->getInnerType());
+                $name = $type->getName();
+                $hasCustomName = $name !== $fqcn;
+
+                array_unshift($blockPrefixes, $hasCustomName ? $name : StringUtil::fqcnToBlockPrefix($fqcn));
+            }
         }
         $blockPrefixes[] = $uniqueBlockPrefix;
 

diff --git a/Extension/Core/Type/BirthdayType.php b/Extension/Core/Type/BirthdayType.php
@@ -31,13 +31,21 @@ public function configureOptions(OptionsResolver $resolver)
      */
     public function getParent()
     {
-        return 'date';
+        return __NAMESPACE__.'\DateType';
     }
 
     /**
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'birthday';
     }

diff --git a/Extension/Core/Type/ButtonType.php b/Extension/Core/Type/ButtonType.php
@@ -32,6 +32,14 @@ public function getParent()
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'button';
     }

diff --git a/Extension/Core/Type/CheckboxType.php b/Extension/Core/Type/CheckboxType.php
@@ -66,6 +66,14 @@ public function configureOptions(OptionsResolver $resolver)
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'checkbox';
     }

diff --git a/Extension/Core/Type/ChoiceType.php b/Extension/Core/Type/ChoiceType.php
@@ -361,6 +361,14 @@ public function configureOptions(OptionsResolver $resolver)
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'choice';
     }
@@ -424,12 +432,12 @@ private function addSubForm(FormBuilderInterface $builder, $name, ChoiceView $ch
         );
 
         if ($options['multiple']) {
-            $choiceType = 'checkbox';
+            $choiceType = __NAMESPACE__.'\CheckboxType';
             // The user can check 0 or more checkboxes. If required
             // is true, he is required to check all of them.
             $choiceOpts['required'] = false;
         } else {
-            $choiceType = 'radio';
+            $choiceType = __NAMESPACE__.'\RadioType';
         }
 
         $builder->add($name, $choiceType, $choiceOpts);

diff --git a/Extension/Core/Type/CollectionType.php b/Extension/Core/Type/CollectionType.php
@@ -88,7 +88,7 @@ public function configureOptions(OptionsResolver $resolver)
             'prototype' => true,
             'prototype_data' => null,
             'prototype_name' => '__name__',
-            'type' => 'text',
+            'type' => __NAMESPACE__.'\TextType',
             'options' => array(),
             'delete_empty' => false,
         ));
@@ -100,6 +100,14 @@ public function configureOptions(OptionsResolver $resolver)
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'collection';
     }

diff --git a/Extension/Core/Type/CountryType.php b/Extension/Core/Type/CountryType.php
@@ -33,13 +33,21 @@ public function configureOptions(OptionsResolver $resolver)
      */
     public function getParent()
     {
-        return 'choice';
+        return __NAMESPACE__.'\ChoiceType';
     }
 
     /**
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'country';
     }

diff --git a/Extension/Core/Type/CurrencyType.php b/Extension/Core/Type/CurrencyType.php
@@ -33,13 +33,21 @@ public function configureOptions(OptionsResolver $resolver)
      */
     public function getParent()
     {
-        return 'choice';
+        return __NAMESPACE__.'\ChoiceType';
     }
 
     /**
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'currency';
     }

diff --git a/Extension/Core/Type/DateTimeType.php b/Extension/Core/Type/DateTimeType.php
@@ -161,8 +161,8 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                         'time' => $timeParts,
                     )),
                 )))
-                ->add('date', 'date', $dateOptions)
-                ->add('time', 'time', $timeOptions)
+                ->add('date', __NAMESPACE__.'\DateType', $dateOptions)
+                ->add('time', __NAMESPACE__.'\TimeType', $timeOptions)
             ;
         }
 
@@ -284,6 +284,14 @@ public function configureOptions(OptionsResolver $resolver)
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'datetime';
     }

diff --git a/Extension/Core/Type/DateType.php b/Extension/Core/Type/DateType.php
@@ -37,6 +37,11 @@ class DateType extends AbstractType
         \IntlDateFormatter::SHORT,
     );
 
+    private static $widgets = array(
+        'text' => 'Symfony\Component\Form\Extension\Core\Type\TextType',
+        'choice' => 'Symfony\Component\Form\Extension\Core\Type\ChoiceType',
+    );
+
     /**
      * {@inheritdoc}
      */
@@ -101,9 +106,9 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             }
 
             $builder
-                ->add('year', $options['widget'], $yearOptions)
-                ->add('month', $options['widget'], $monthOptions)
-                ->add('day', $options['widget'], $dayOptions)
+                ->add('year', self::$widgets[$options['widget']], $yearOptions)
+                ->add('month', self::$widgets[$options['widget']], $monthOptions)
+                ->add('day', self::$widgets[$options['widget']], $dayOptions)
                 ->addViewTransformer(new DateTimeToArrayTransformer(
                     $options['model_timezone'], $options['view_timezone'], array('year', 'month', 'day')
                 ))
@@ -253,6 +258,14 @@ public function configureOptions(OptionsResolver $resolver)
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'date';
     }

diff --git a/Extension/Core/Type/EmailType.php b/Extension/Core/Type/EmailType.php
@@ -20,13 +20,21 @@ class EmailType extends AbstractType
      */
     public function getParent()
     {
-        return 'text';
+        return __NAMESPACE__.'\TextType';
     }
 
     /**
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'email';
     }

diff --git a/Extension/Core/Type/FileType.php b/Extension/Core/Type/FileType.php
@@ -61,6 +61,14 @@ public function configureOptions(OptionsResolver $resolver)
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'file';
     }

diff --git a/Extension/Core/Type/FormType.php b/Extension/Core/Type/FormType.php
@@ -244,6 +244,14 @@ public function getParent()
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'form';
     }

diff --git a/Extension/Core/Type/HiddenType.php b/Extension/Core/Type/HiddenType.php
@@ -34,6 +34,14 @@ public function configureOptions(OptionsResolver $resolver)
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'hidden';
     }

diff --git a/Extension/Core/Type/IntegerType.php b/Extension/Core/Type/IntegerType.php
@@ -73,6 +73,14 @@ public function configureOptions(OptionsResolver $resolver)
      * {@inheritdoc}
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getBlockPrefix()
     {
         return 'integer';
     }