Enhanced the triggering of E_USER_DEPRECATED errors

- Removed useless error handlers around FormEvent as the triggering has been fixed in it. - Enhanced the triggering of deprecation errors for places where the BC method provide some user logic needing to be converted to a new way. - Enhanced the deprecation messages to mention the replacement whenever possible.
symfony · Jan 10, 2013 · 5412a4e · 5412a4e
1 parent 2d5bede
commit 5412a4e
Show file tree

Hide file tree

Showing 16 changed files with 101 additions and 97 deletions.
diff --git a/AbstractType.php b/AbstractType.php
@@ -51,10 +51,20 @@ public function finishView(FormView $view, FormInterface $form, array $options)
      */
     public function setDefaultOptions(OptionsResolverInterface $resolver)
     {
-        set_error_handler(array('Symfony\Component\Form\Test\DeprecationErrorHandler', 'handleBC'));
-        $resolver->setDefaults($this->getDefaultOptions(array()));
-        $resolver->addAllowedValues($this->getAllowedOptionValues(array()));
-        restore_error_handler();
+        $defaults = $this->getDefaultOptions(array());
+        $allowedTypes = $this->getAllowedOptionValues(array());
+
+        if (!empty($defaults)) {
+            trigger_error('getDefaultOptions() is deprecated since version 2.1 and will be removed in 2.3. Use setDefaultOptions() instead.', E_USER_DEPRECATED);
+
+            $resolver->setDefaults($defaults);
+        }
+
+        if (!empty($allowedTypes)) {
+            trigger_error('getAllowedOptionValues() is deprecated since version 2.1 and will be removed in 2.3. Use setDefaultOptions() instead.', E_USER_DEPRECATED);
+
+            $resolver->addAllowedValues($allowedTypes);
+        }
     }
 
     /**
@@ -69,8 +79,6 @@ public function setDefaultOptions(OptionsResolverInterface $resolver)
      */
     public function getDefaultOptions(array $options)
     {
-        trigger_error('getDefaultOptions() is deprecated since version 2.1 and will be removed in 2.3. Use setDefaultOptions() instead.', E_USER_DEPRECATED);
-
         return array();
     }
 
@@ -86,8 +94,6 @@ public function getDefaultOptions(array $options)
      */
     public function getAllowedOptionValues(array $options)
     {
-        trigger_error('getAllowedOptionValues() is deprecated since version 2.1 and will be removed in 2.3. Use setDefaultOptions() instead.', E_USER_DEPRECATED);
-
         return array();
     }
 

diff --git a/AbstractTypeExtension.php b/AbstractTypeExtension.php
@@ -44,10 +44,20 @@ public function finishView(FormView $view, FormInterface $form, array $options)
      */
     public function setDefaultOptions(OptionsResolverInterface $resolver)
     {
-        set_error_handler(array('Symfony\Component\Form\Test\DeprecationErrorHandler', 'handleBC'));
-        $resolver->setDefaults($this->getDefaultOptions());
-        $resolver->addAllowedValues($this->getAllowedOptionValues());
-        restore_error_handler();
+        $defaults = $this->getDefaultOptions(array());
+        $allowedTypes = $this->getAllowedOptionValues(array());
+
+        if (!empty($defaults)) {
+            trigger_error('getDefaultOptions() is deprecated since version 2.1 and will be removed in 2.3. Use setDefaultOptions() instead.', E_USER_DEPRECATED);
+
+            $resolver->setDefaults($defaults);
+        }
+
+        if (!empty($allowedTypes)) {
+            trigger_error('getAllowedOptionValues() is deprecated since version 2.1 and will be removed in 2.3. Use setDefaultOptions() instead.', E_USER_DEPRECATED);
+
+            $resolver->addAllowedValues($allowedTypes);
+        }
     }
 
     /**
@@ -60,8 +70,6 @@ public function setDefaultOptions(OptionsResolverInterface $resolver)
      */
     public function getDefaultOptions()
     {
-        trigger_error('getDefaultOptions() is deprecated since version 2.1 and will be removed in 2.3. Use setDefaultOptions() instead.', E_USER_DEPRECATED);
-
         return array();
     }
 
@@ -75,8 +83,6 @@ public function getDefaultOptions()
      */
     public function getAllowedOptionValues()
     {
-        trigger_error('getAllowedOptionValues() is deprecated since version 2.1 and will be removed in 2.3. Use setDefaultOptions() instead.', E_USER_DEPRECATED);
-
         return array();
     }
 }
diff --git a/CallbackValidator.php b/CallbackValidator.php
@@ -27,7 +27,7 @@ class CallbackValidator implements FormValidatorInterface
      */
     public function __construct($callback)
     {
-        trigger_error('CallbackValidator is deprecated since version 2.1 and will be removed in 2.3.', E_USER_DEPRECATED);
+        trigger_error('CallbackValidator is deprecated since version 2.1 and will be removed in 2.3. Use the FormEvents::POST_BIND event instead.', E_USER_DEPRECATED);
 
         $this->callback = $callback;
     }

diff --git a/Form.php b/Form.php
@@ -367,11 +367,12 @@ public function setData($modelData)
 
         // Hook to change content of the data
         if ($dispatcher->hasListeners(FormEvents::PRE_SET_DATA) || $dispatcher->hasListeners(FormEvents::SET_DATA)) {
-            set_error_handler(array('Symfony\Component\Form\Test\DeprecationErrorHandler', 'handleBC'));
             $event = new FormEvent($this, $modelData);
-            restore_error_handler();
             $dispatcher->dispatch(FormEvents::PRE_SET_DATA, $event);
             // BC until 2.3
+            if ($dispatcher->hasListeners(FormEvents::SET_DATA)) {
+                trigger_error('The FormEvents::SET_DATA event is deprecated since 2.1 and will be removed in 2.3. Use the FormEvents::PRE_SET_DATA event instead.', E_USER_DEPRECATED);
+            }
             $dispatcher->dispatch(FormEvents::SET_DATA, $event);
             $modelData = $event->getData();
         }
@@ -532,11 +533,12 @@ public function bind($submittedData)
 
         // Hook to change content of the data bound by the browser
         if ($dispatcher->hasListeners(FormEvents::PRE_BIND) || $dispatcher->hasListeners(FormEvents::BIND_CLIENT_DATA)) {
-            set_error_handler(array('Symfony\Component\Form\Test\DeprecationErrorHandler', 'handleBC'));
             $event = new FormEvent($this, $submittedData);
-            restore_error_handler();
             $dispatcher->dispatch(FormEvents::PRE_BIND, $event);
             // BC until 2.3
+            if ($dispatcher->hasListeners(FormEvents::BIND_CLIENT_DATA)) {
+                trigger_error('The FormEvents::BIND_CLIENT_DATA event is deprecated since 2.1 and will be removed in 2.3. Use the FormEvents::PRE_BIND event instead.', E_USER_DEPRECATED);
+            }
             $dispatcher->dispatch(FormEvents::BIND_CLIENT_DATA, $event);
             $submittedData = $event->getData();
         }
@@ -594,11 +596,12 @@ public function bind($submittedData)
             // Hook to change content of the data into the normalized
             // representation
             if ($dispatcher->hasListeners(FormEvents::BIND) || $dispatcher->hasListeners(FormEvents::BIND_NORM_DATA)) {
-                set_error_handler(array('Symfony\Component\Form\Test\DeprecationErrorHandler', 'handleBC'));
                 $event = new FormEvent($this, $normData);
-                restore_error_handler();
                 $dispatcher->dispatch(FormEvents::BIND, $event);
                 // BC until 2.3
+                if ($dispatcher->hasListeners(FormEvents::BIND_NORM_DATA)) {
+                    trigger_error('The FormEvents::BIND_NORM_DATA event is deprecated since 2.1 and will be removed in 2.3. Use the FormEvents::BIND event instead.', E_USER_DEPRECATED);
+                }
                 $dispatcher->dispatch(FormEvents::BIND_NORM_DATA, $event);
                 $normData = $event->getData();
             }
@@ -621,10 +624,14 @@ public function bind($submittedData)
         }
 
         set_error_handler(array('Symfony\Component\Form\Test\DeprecationErrorHandler', 'handleBC'));
-        foreach ($this->config->getValidators() as $validator) {
+        $validators = $this->config->getValidators();
+        restore_error_handler();
+
+        foreach ($validators as $validator) {
+            trigger_error(sprintf('FormConfigInterface::getValidators() is deprecated since 2.1 and will be removed in 2.3. Convert your %s class to a listener on the FormEvents::POST_BIND event.', get_class($validator)), E_USER_DEPRECATED);
+
             $validator->validate($this);
         }
-        restore_error_handler();
 
         return $this;
     }

diff --git a/FormBuilder.php b/FormBuilder.php
@@ -301,12 +301,12 @@ public function getIterator()
      */
     public function getTypes()
     {
+        trigger_error('getTypes() is deprecated since version 2.1 and will be removed in 2.3. Use getConfig() and FormConfigInterface::getType() instead.', E_USER_DEPRECATED);
+
         if ($this->locked) {
             throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
         }
 
-        trigger_error('getTypes() is deprecated since version 2.1 and will be removed in 2.3. Use getConfig() and FormConfigInterface::getType() instead.', E_USER_DEPRECATED);
-
         $types = array();
 
         for ($type = $this->getType(); null !== $type; $type = $type->getParent()) {

diff --git a/Test/DeprecationErrorHandler.php b/Test/DeprecationErrorHandler.php
@@ -2,9 +2,6 @@
 
 namespace Symfony\Component\Form\Test;
 
-use Symfony\Component\Form\FormInterface as NonTestFormInterface;
-use Symfony\Component\Form\FormEvent;
-
 class DeprecationErrorHandler
 {
     public static function handle($errorNumber, $message, $file, $line, $context)
@@ -24,13 +21,4 @@ public static function handleBC($errorNumber, $message, $file, $line, $context)
 
         return false;
     }
-
-    public static function getFormEvent(NonTestFormInterface $form, $data)
-    {
-        set_error_handler(array('Symfony\Component\Form\Test\DeprecationErrorHandler', 'handle'));
-        $event = new FormEvent($form, $data);
-        restore_error_handler();
-
-        return $event;
-    }
 }
diff --git a/Tests/CompoundFormTest.php b/Tests/CompoundFormTest.php
@@ -231,9 +231,7 @@ public function testRemove()
         $this->form->remove('foo');
 
         $this->assertNull($child->getParent());
-        set_error_handler(array('Symfony\Component\Form\Test\DeprecationErrorHandler', 'handle'));
-        $this->assertFalse($this->form->hasChildren());
-        restore_error_handler();
+        $this->assertCount(0, $this->form);
     }
 
     /**

diff --git a/Tests/Extension/Core/EventListener/FixRadioInputListenerTest.php b/Tests/Extension/Core/EventListener/FixRadioInputListenerTest.php
@@ -11,9 +11,9 @@
 
 namespace Symfony\Component\Form\Tests\Extension\Core\EventListener;
 
+use Symfony\Component\Form\FormEvent;
 use Symfony\Component\Form\Extension\Core\EventListener\FixRadioInputListener;
 use Symfony\Component\Form\Extension\Core\ChoiceList\SimpleChoiceList;
-use Symfony\Component\Form\Test\DeprecationErrorHandler;
 
 class FixRadioInputListenerTest extends \PHPUnit_Framework_TestCase
 {
@@ -42,7 +42,7 @@ public function testFixRadio()
     {
         $data = '1';
         $form = $this->getMock('Symfony\Component\Form\Test\FormInterface');
-        $event = DeprecationErrorHandler::getFormEvent($form, $data);
+        $event = new FormEvent($form, $data);
 
         $this->listener->preBind($event);
 
@@ -53,7 +53,7 @@ public function testFixZero()
     {
         $data = '0';
         $form = $this->getMock('Symfony\Component\Form\Test\FormInterface');
-        $event = DeprecationErrorHandler::getFormEvent($form, $data);
+        $event = new FormEvent($form, $data);
 
         $this->listener->preBind($event);
 
@@ -64,7 +64,7 @@ public function testIgnoreEmptyString()
     {
         $data = '';
         $form = $this->getMock('Symfony\Component\Form\Test\FormInterface');
-        $event = DeprecationErrorHandler::getFormEvent($form, $data);
+        $event = new FormEvent($form, $data);
 
         $this->listener->preBind($event);
 

diff --git a/Tests/Extension/Core/EventListener/FixUrlProtocolListenerTest.php b/Tests/Extension/Core/EventListener/FixUrlProtocolListenerTest.php
@@ -11,8 +11,8 @@
 
 namespace Symfony\Component\Form\Tests\Extension\Core\EventListener;
 
+use Symfony\Component\Form\FormEvent;
 use Symfony\Component\Form\Extension\Core\EventListener\FixUrlProtocolListener;
-use Symfony\Component\Form\Test\DeprecationErrorHandler;
 
 class FixUrlProtocolListenerTest extends \PHPUnit_Framework_TestCase
 {
@@ -27,7 +27,7 @@ public function testFixHttpUrl()
     {
         $data = "www.symfony.com";
         $form = $this->getMock('Symfony\Component\Form\Test\FormInterface');
-        $event = DeprecationErrorHandler::getFormEvent($form, $data);
+        $event = new FormEvent($form, $data);
 
         $filter = new FixUrlProtocolListener('http');
         $filter->onBind($event);
@@ -39,7 +39,7 @@ public function testSkipKnownUrl()
     {
         $data = "http://www.symfony.com";
         $form = $this->getMock('Symfony\Component\Form\Test\FormInterface');
-        $event = DeprecationErrorHandler::getFormEvent($form, $data);
+        $event = new FormEvent($form, $data);
 
         $filter = new FixUrlProtocolListener('http');
         $filter->onBind($event);
@@ -51,7 +51,7 @@ public function testSkipOtherProtocol()
     {
         $data = "ftp://www.symfony.com";
         $form = $this->getMock('Symfony\Component\Form\Test\FormInterface');
-        $event = DeprecationErrorHandler::getFormEvent($form, $data);
+        $event = new FormEvent($form, $data);
 
         $filter = new FixUrlProtocolListener('http');
         $filter->onBind($event);

diff --git a/Tests/Extension/Core/EventListener/MergeCollectionListenerTest.php b/Tests/Extension/Core/EventListener/MergeCollectionListenerTest.php
@@ -11,8 +11,8 @@
 
 namespace Symfony\Component\Form\Tests\Extension\Core\EventListener;
 
+use Symfony\Component\Form\FormEvent;
 use Symfony\Component\Form\Extension\Core\EventListener\MergeCollectionListener;
-use Symfony\Component\Form\Test\DeprecationErrorHandler;
 
 abstract class MergeCollectionListenerTest extends \PHPUnit_Framework_TestCase
 {
@@ -84,7 +84,7 @@ public function testAddExtraEntriesIfAllowAdd($allowDelete)
 
         $this->form->setData($originalData);
 
-        $event = DeprecationErrorHandler::getFormEvent($this->form, $newData);
+        $event = new FormEvent($this->form, $newData);
         $listener->onBind($event);
 
         // The original object was modified
@@ -108,7 +108,7 @@ public function testAddExtraEntriesIfAllowAddDontOverwriteExistingIndices($allow
 
         $this->form->setData($originalData);
 
-        $event = DeprecationErrorHandler::getFormEvent($this->form, $newData);
+        $event = new FormEvent($this->form, $newData);
         $listener->onBind($event);
 
         // The original object was modified
@@ -133,7 +133,7 @@ public function testDoNothingIfNotAllowAdd($allowDelete)
 
         $this->form->setData($originalData);
 
-        $event = DeprecationErrorHandler::getFormEvent($this->form, $newData);
+        $event = new FormEvent($this->form, $newData);
         $listener->onBind($event);
 
         // We still have the original object
@@ -157,7 +157,7 @@ public function testRemoveMissingEntriesIfAllowDelete($allowAdd)
 
         $this->form->setData($originalData);
 
-        $event = DeprecationErrorHandler::getFormEvent($this->form, $newData);
+        $event = new FormEvent($this->form, $newData);
         $listener->onBind($event);
 
         // The original object was modified
@@ -182,7 +182,7 @@ public function testDoNothingIfNotAllowDelete($allowAdd)
 
         $this->form->setData($originalData);
 
-        $event = DeprecationErrorHandler::getFormEvent($this->form, $newData);
+        $event = new FormEvent($this->form, $newData);
         $listener->onBind($event);
 
         // We still have the original object
@@ -201,7 +201,7 @@ public function testDoNothingIfNotAllowDelete($allowAdd)
     public function testRequireArrayOrTraversable($allowAdd, $allowDelete)
     {
         $newData = 'no array or traversable';
-        $event = DeprecationErrorHandler::getFormEvent($this->form, $newData);
+        $event = new FormEvent($this->form, $newData);
         $listener = new MergeCollectionListener($allowAdd, $allowDelete);
         $listener->onBind($event);
     }
@@ -215,7 +215,7 @@ public function testDealWithNullData()
 
         $this->form->setData($originalData);
 
-        $event = DeprecationErrorHandler::getFormEvent($this->form, $newData);
+        $event = new FormEvent($this->form, $newData);
         $listener->onBind($event);
 
         $this->assertSame($originalData, $event->getData());
@@ -233,7 +233,7 @@ public function testDealWithNullOriginalDataIfAllowAdd($allowDelete)
 
         $this->form->setData($originalData);
 
-        $event = DeprecationErrorHandler::getFormEvent($this->form, $newData);
+        $event = new FormEvent($this->form, $newData);
         $listener->onBind($event);
 
         $this->assertSame($newData, $event->getData());
@@ -251,7 +251,7 @@ public function testDontDealWithNullOriginalDataIfNotAllowAdd($allowDelete)
 
         $this->form->setData($originalData);
 
-        $event = DeprecationErrorHandler::getFormEvent($this->form, $newData);
+        $event = new FormEvent($this->form, $newData);
         $listener->onBind($event);
 
         $this->assertNull($event->getData());