[EventDispatcher] Deprecate ContainerAwareEventDispatcher::getContainer() && ::lazyLoad()

nicolas-grekas · nicolas-grekas · commit 0b8ac0348f65 · 2016-12-15T16:32:21.000+01:00
diff --git a/src/Symfony/Component/EventDispatcher/ContainerAwareEventDispatcher.php b/src/Symfony/Component/EventDispatcher/ContainerAwareEventDispatcher.php
@@ -52,6 +52,18 @@ class ContainerAwareEventDispatcher extends EventDispatcher
     public function __construct(ContainerInterface $container)
     {
         $this->container = $container;
+
+        $class = get_class($this);
+        if ($this instanceof \PHPUnit_Framework_MockObject_MockObject || $this instanceof \Prophecy\Doubler\DoubleInterface) {
+            $class = get_parent_class($class);
+        }
+        if (__CLASS__ === $class) {
+            return;
+        }
+        $r = new \ReflectionMethod($class, 'lazyLoad');
+        if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
+            @trigger_error(sprintf('Extending %s::lazyLoad() in %s is deprecated since version 3.3 and won\'t be supported anymore in 4.0 as it will be private.', __CLASS__, $class), E_USER_DEPRECATED);
+        }
     }
 
     /**
@@ -161,8 +173,13 @@ public function addSubscriberService($serviceId, $class)
         }
     }
 
+    /**
+     * @deprecated since version 3.3, to be removed in 4.0. Inject the container or the services you need in your listeners/subscribers instead.
+     */
     public function getContainer()
     {
+        @trigger_error('The '.__METHOD__.'() method is deprecated since version 3.3 and will be removed in 4.0. Inject the container or the services you need in your listeners/subscribers instead.', E_USER_DEPRECATED);
+
         return $this->container;
     }
 
@@ -173,6 +190,8 @@ public function getContainer()
      * @param string $eventName The name of the event to dispatch. The name of
      *                          the event is the name of the method that is
      *                          invoked on listeners.
+     *
+     * @deprecated since version 3.3, will be private in 4.0.
      */
     protected function lazyLoad($eventName)
     {

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,18 @@ class ContainerAwareEventDispatcher extends EventDispatcher`
`52`	`52`	`public function __construct(ContainerInterface $container)`
`53`	`53`	`{`
`54`	`54`	`$this->container = $container;`
	`55`	`+`
	`56`	`+ $class = get_class($this);`
	`57`	`+ if ($this instanceof \PHPUnit_Framework_MockObject_MockObject \|\| $this instanceof \Prophecy\Doubler\DoubleInterface) {`
	`58`	`+ $class = get_parent_class($class);`
	`59`	`+ }`
	`60`	`+ if (__CLASS__ === $class) {`
	`61`	`+ return;`
	`62`	`+ }`
	`63`	`+ $r = new \ReflectionMethod($class, 'lazyLoad');`
	`64`	`+ if (__CLASS__ !== $r->getDeclaringClass()->getName()) {`
	`65`	`+ @trigger_error(sprintf('Extending %s::lazyLoad() in %s is deprecated since version 3.3 and won\'t be supported anymore in 4.0 as it will be private.', __CLASS__, $class), E_USER_DEPRECATED);`
	`66`	`+ }`
`55`	`67`	`}`
`56`	`68`
`57`	`69`	`/**`
`@@ -161,8 +173,13 @@ public function addSubscriberService($serviceId, $class)`
`161`	`173`	`}`
`162`	`174`	`}`
`163`	`175`
	`176`	`+ /**`
	`177`	`+ * @deprecated since version 3.3, to be removed in 4.0. Inject the container or the services you need in your listeners/subscribers instead.`
	`178`	`+ */`
`164`	`179`	`public function getContainer()`
`165`	`180`	`{`
	`181`	`+ @trigger_error('The '.__METHOD__.'() method is deprecated since version 3.3 and will be removed in 4.0. Inject the container or the services you need in your listeners/subscribers instead.', E_USER_DEPRECATED);`
	`182`	`+`
`166`	`183`	`return $this->container;`
`167`	`184`	`}`
`168`	`185`
`@@ -173,6 +190,8 @@ public function getContainer()`
`173`	`190`	`* @param string $eventName The name of the event to dispatch. The name of`
`174`	`191`	`* the event is the name of the method that is`
`175`	`192`	`* invoked on listeners.`
	`193`	`+ *`
	`194`	`+ * @deprecated since version 3.3, will be private in 4.0.`
`176`	`195`	`*/`
`177`	`196`	`protected function lazyLoad($eventName)`
`178`	`197`	`{`