bug #18677 [DoctrineBridge] Fixed bc layer after #18069 (HeahDude)

fabpot · fabpot · commit 97ebca15289c · 2016-05-11T12:50:28.000-05:00
This PR was merged into the 3.1-dev branch. Discussion ---------- [DoctrineBridge] Fixed bc layer after #18069 | Q | A | ------------- | --- | Branch? | master | Bug fix? | BC break | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | ~ | License | MIT | Doc PR | ~ Commits ------- 8a6cf9d [DoctrineBridge] fixed bc layer from #18069
diff --git a/src/Symfony/Bridge/Doctrine/Form/EventListener/MergeDoctrineCollectionListener.php b/src/Symfony/Bridge/Doctrine/Form/EventListener/MergeDoctrineCollectionListener.php
@@ -27,29 +27,32 @@
  */
 class MergeDoctrineCollectionListener implements EventSubscriberInterface
 {
-    // Keeps BC. To be removed in 4.0
+    // Keep BC. To be removed in 4.0
     private $bc = true;
+    private $bcLayer = false;
 
     public static function getSubscribedEvents()
     {
         // Higher priority than core MergeCollectionListener so that this one
         // is called before
         return array(
             FormEvents::SUBMIT => array(
-                // BC
-                array('onBind', 10),
+                array('onBind', 10), // deprecated
                 array('onSubmit', 5),
             ),
         );
     }
 
     public function onSubmit(FormEvent $event)
     {
-        // If onBind() is overridden then logic has been executed
         if ($this->bc) {
+            // onBind() has been overridden from a child class
             @trigger_error('The onBind() method is deprecated since version 3.1 and will be removed in 4.0. Use the onSubmit() method instead.', E_USER_DEPRECATED);
 
-            return;
+            if (!$this->bcLayer) {
+                // If parent::onBind() has not been called, then logic has been executed
+                return;
+            }
         }
 
         $collection = $event->getForm()->getData();
@@ -68,10 +71,13 @@ public function onSubmit(FormEvent $event)
      * @deprecated since version 3.1, to be removed in 4.0.
      *             Use {@link onSubmit()} instead.
      */
-    public function onBind()
+    public function onBind(FormEvent $event)
     {
         if (__CLASS__ === get_class($this)) {
             $this->bc = false;
+        } else {
+            // parent::onBind() has been called
+            $this->bcLayer = true;
         }
     }
 }
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Form/EventListener/MergeDoctrineCollectionListenerTest.php b/src/Symfony/Bridge/Doctrine/Tests/Form/EventListener/MergeDoctrineCollectionListenerTest.php
@@ -18,7 +18,7 @@
 use Symfony\Component\Form\FormEvent;
 use Symfony\Component\Form\FormEvents;
 
-class MergeDoctrineCollectionTest extends \PHPUnit_Framework_TestCase
+class MergeDoctrineCollectionListenerTest extends \PHPUnit_Framework_TestCase
 {
     /** @var \Doctrine\Common\Collections\ArrayCollection */
     private $collection;
@@ -77,4 +77,37 @@ public function testOnSubmitNullClearCollection()
 
         $this->assertTrue($this->collection->isEmpty());
     }
+
+    /**
+     * @group legacy
+     */
+    public function testLegacyChildClassOnSubmitCallParent()
+    {
+        $form = $this->getBuilder('name')
+            ->setData($this->collection)
+            ->addEventSubscriber(new TestClassExtendingMergeDoctrineCollectionListener())
+            ->getForm();
+        $submittedData = array();
+        $event = new FormEvent($form, $submittedData);
+
+        $this->dispatcher->dispatch(FormEvents::SUBMIT, $event);
+
+        $this->assertTrue($this->collection->isEmpty());
+        $this->assertTrue(TestClassExtendingMergeDoctrineCollectionListener::$onBindCalled);
+    }
+}
+
+/**
+ * @group legacy
+ */
+class TestClassExtendingMergeDoctrineCollectionListener extends MergeDoctrineCollectionListener
+{
+    public static $onBindCalled = false;
+
+    public function onBind(FormEvent $event)
+    {
+        self::$onBindCalled = true;
+
+        parent::onBind($event);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -27,29 +27,32 @@`
`27`	`27`	`*/`
`28`	`28`	`class MergeDoctrineCollectionListener implements EventSubscriberInterface`
`29`	`29`	`{`
`30`		`- // Keeps BC. To be removed in 4.0`
	`30`	`+ // Keep BC. To be removed in 4.0`
`31`	`31`	`private $bc = true;`
	`32`	`+ private $bcLayer = false;`
`32`	`33`
`33`	`34`	`public static function getSubscribedEvents()`
`34`	`35`	`{`
`35`	`36`	`// Higher priority than core MergeCollectionListener so that this one`
`36`	`37`	`// is called before`
`37`	`38`	`return array(`
`38`	`39`	`FormEvents::SUBMIT => array(`
`39`		`- // BC`
`40`		`- array('onBind', 10),`
	`40`	`+ array('onBind', 10), // deprecated`
`41`	`41`	`array('onSubmit', 5),`
`42`	`42`	`),`
`43`	`43`	`);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`public function onSubmit(FormEvent $event)`
`47`	`47`	`{`
`48`		`- // If onBind() is overridden then logic has been executed`
`49`	`48`	`if ($this->bc) {`
	`49`	`+ // onBind() has been overridden from a child class`
`50`	`50`	`@trigger_error('The onBind() method is deprecated since version 3.1 and will be removed in 4.0. Use the onSubmit() method instead.', E_USER_DEPRECATED);`
`51`	`51`
`52`		`- return;`
	`52`	`+ if (!$this->bcLayer) {`
	`53`	`+ // If parent::onBind() has not been called, then logic has been executed`
	`54`	`+ return;`
	`55`	`+ }`
`53`	`56`	`}`
`54`	`57`
`55`	`58`	`$collection = $event->getForm()->getData();`
`@@ -68,10 +71,13 @@ public function onSubmit(FormEvent $event)`
`68`	`71`	`* @deprecated since version 3.1, to be removed in 4.0.`
`69`	`72`	`* Use {@link onSubmit()} instead.`
`70`	`73`	`*/`
`71`		`- public function onBind()`
	`74`	`+ public function onBind(FormEvent $event)`
`72`	`75`	`{`
`73`	`76`	`if (__CLASS__ === get_class($this)) {`
`74`	`77`	`$this->bc = false;`
	`78`	`+ } else {`
	`79`	`+ // parent::onBind() has been called`
	`80`	`+ $this->bcLayer = true;`
`75`	`81`	`}`
`76`	`82`	`}`
`77`	`83`	`}`