feature symfony#20937 [EventDispatcher] Deprecate ContainerAwareEventDispatcher (nicolas-grekas)

This PR was merged into the 3.3-dev branch.

Discussion
----------

[EventDispatcher] Deprecate ContainerAwareEventDispatcher

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | yes
| Tests pass?   | no
| Fixed tickets | -
| License       | MIT
| Doc PR        | -

These methods shouldn't be available to end users.

Commits
-------

c4a6a8a [EventDispatcher] Deprecate ContainerAwareEventDispatcher

Author: fabpot

UPGRADE-3.3.md

@@ -16,6 +16,12 @@ DependencyInjection
  * The `DefinitionDecorator` class is deprecated and will be removed in 4.0, use
    the `ChildDefinition` class instead.
 
+EventDispatcher
+---------------
+
+ * The `ContainerAwareEventDispatcher` class has been deprecated.
+   Use `EventDispatcher` with closure-proxy injection instead.
+
 Finder
 ------
 

UPGRADE-4.0.md

@@ -42,6 +42,12 @@ DependencyInjection
  * Requesting a private service with the `Container::get()` method is no longer
    supported.
 
+EventDispatcher
+---------------
+
+ * The `ContainerAwareEventDispatcher` class has been removed.
+   Use `EventDispatcher` with closure-proxy injection instead.
+
 ExpressionLanguage
 ----------
 

src/Symfony/Component/EventDispatcher/CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+3.3.0
+-----
+
+  * The ContainerAwareEventDispatcher class has been deprecated. Use EventDispatcher with closure-proxy injection instead.
+
 3.0.0
 -----
 

src/Symfony/Component/EventDispatcher/ContainerAwareEventDispatcher.php

@@ -20,6 +20,8 @@
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Jordan Alliot <jordan.alliot@gmail.com>
+ *
+ * @deprecated since 3.3, to be removed in 4.0. Use EventDispatcher with closure-proxy injection instead.
  */
 class ContainerAwareEventDispatcher extends EventDispatcher
 {
@@ -52,6 +54,14 @@ 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) {
+            @trigger_error(sprintf('The %s class is deprecated since version 3.3 and will be removed in 4.0. Use EventDispatcher with closure-proxy injection instead.', __CLASS__), E_USER_DEPRECATED);
+        }
     }
 
     /**
@@ -68,6 +78,8 @@ public function __construct(ContainerInterface $container)
      */
     public function addListenerService($eventName, $callback, $priority = 0)
     {
+        @trigger_error(sprintf('The %s class is deprecated since version 3.3 and will be removed in 4.0. Use EventDispatcher with closure-proxy injection instead.', __CLASS__), E_USER_DEPRECATED);
+
         if (!is_array($callback) || 2 !== count($callback)) {
             throw new \InvalidArgumentException('Expected an array("service", "method") argument');
         }
@@ -148,6 +160,8 @@ public function getListenerPriority($eventName, $listener)
      */
     public function addSubscriberService($serviceId, $class)
     {
+        @trigger_error(sprintf('The %s class is deprecated since version 3.3 and will be removed in 4.0. Use EventDispatcher with closure-proxy injection instead.', __CLASS__), E_USER_DEPRECATED);
+
         foreach ($class::getSubscribedEvents() as $eventName => $params) {
             if (is_string($params)) {
                 $this->listenerIds[$eventName][] = array($serviceId, $params, 0);
@@ -163,6 +177,8 @@ public function addSubscriberService($serviceId, $class)
 
     public function getContainer()
     {
+        @trigger_error('The '.__METHOD__.'() method is deprecated since version 3.3 as its class 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;
     }
 

src/Symfony/Component/EventDispatcher/Tests/ContainerAwareEventDispatcherTest.php

@@ -16,6 +16,9 @@
 use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
+/**
+ * @group legacy
+ */
 class ContainerAwareEventDispatcherTest extends AbstractEventDispatcherTest
 {
     protected function createEventDispatcher()