Merge branch 'feature/event-manager-v3' into develop

Close #31

Author: weierophinney

.gitattributes

@@ -1,3 +1,4 @@
+/doc export-ignore
 /test export-ignore
 /vendor export-ignore
 .coveralls.yml export-ignore

.gitignore

@@ -6,6 +6,7 @@
 .*.sw*
 .*.un~
 nbproject
+doc/html/
 tmp/
 
 clover.xml

CHANGELOG.md

@@ -2,11 +2,13 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
-## 2.7.0 - TBD
+## 3.0.0 - TBD
 
 ### Added
 
-- Nothing.
+- [#31](https://github.com/zendframework/zend-mvc/pull/31) adds three required
+  arguments to the `Zend\Mvc\Application` constructor: an EventManager
+  instance, a Request instance, and a Response instance.
 
 ### Deprecated
 
@@ -18,6 +20,9 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
+- [#31](https://github.com/zendframework/zend-mvc/pull/31) updates the component
+  to use zend-eventmanager v3.
+
 ## 2.6.1 - TBD
 
 ### Added

composer.json

@@ -14,11 +14,12 @@
     },
     "require": {
         "php": ">=5.5",
-        "zendframework/zend-eventmanager": "~2.5",
+        "zendframework/zend-eventmanager": "dev-develop as 2.7.0",
         "zendframework/zend-servicemanager": "~2.5",
         "zendframework/zend-hydrator": "~1.0",
         "zendframework/zend-form": "~2.6",
-        "zendframework/zend-stdlib": "~2.7"
+        "zendframework/zend-stdlib": "~2.7",
+        "container-interop/container-interop": "^1.1"
     },
     "require-dev": {
         "zendframework/zend-authentication": "~2.5",
@@ -31,14 +32,14 @@
         "zendframework/zend-inputfilter": "~2.5",
         "zendframework/zend-json": "~2.5",
         "zendframework/zend-log": "~2.5",
-        "zendframework/zend-modulemanager": "~2.6",
+        "zendframework/zend-modulemanager": "dev-develop as 2.7.0",
         "zendframework/zend-session": "~2.5",
         "zendframework/zend-serializer": "~2.5",
         "zendframework/zend-text": "~2.5",
         "zendframework/zend-uri": "~2.5",
         "zendframework/zend-validator": "~2.5",
         "zendframework/zend-version": "~2.5",
-        "zendframework/zend-view": "~2.5",
+        "zendframework/zend-view": "dev-develop as 2.6.0",
         "fabpot/php-cs-fixer": "1.7.*",
         "phpunit/PHPUnit": "~4.0"
     },
@@ -67,7 +68,7 @@
     "extra": {
         "branch-alias": {
             "dev-master": "2.6-dev",
-            "dev-develop": "2.7-dev"
+            "dev-develop": "3.0-dev"
         }
     },
     "autoload-dev": {

doc/book/migration.md

@@ -0,0 +1,69 @@
+# Migration Guide
+
+This is a guide for migration from version 2 to version 3 of zend-mvc.
+
+## Application
+
+The constructor signature of `Zend\Mvc\Application` has changed. Previously, it
+was:
+
+```php
+__construct($configuration, ServiceManager $serviceManager)
+```
+
+and internally, it pulled the services `EventManager`, `Request`, and `Response`
+from the provided `$serviceManager` during initialization.
+
+The new constructor signature is:
+
+```php
+__construct(
+    $configuration,
+    ServiceManager $serviceManager,
+    EventManager $events,
+    RequestInterface $request,
+    ResponseInterface $response
+)
+```
+
+making all dependencies explicit. The factory
+`Zend\Mvc\Service\ApplicationFactory` was updated to follow the new signature.
+
+This change should only affect users who are manually instantiating the
+`Application` instance.
+
+## EventManager initializer and ControllerManager event manager injection
+
+zend-mvc provides two mechanisms for injecting event managers into
+`EventManagerAware` objects. One is the "EventManagerAwareInitializer"
+registered in `Zend\Mvc\Service\ServiceManagerConfig`, and the other is internal
+logic in `Zend\Mvc\Controller\ControllerManager`. In both cases, the logic was
+updated due to changes in the v3 version of zend-eventmanager. 
+
+Previously each would check if the instance's `getEventManager()` method
+returned an event manager instance, and, if so, inject the shared event manager:
+
+```php
+$events = $instance->getEventManager();
+if ($events instanceof EventManagerInterface) {
+    $events->setSharedManager($container->get('SharedEventManager'));
+}
+```
+
+In zend-eventmanager v3, event manager's are now injected with the shared
+manager at instantiation, and no setter exists for providing the shared manager.
+As such, the above logic changed to:
+
+```php
+$events = $instance->getEventManager();
+if (! $events || ! $events->getSharedManager()) {
+    $instance->setEventManager($container->get('EventManager'));
+}
+```
+
+In other words, it re-injects with a new event manager instance if the instance
+pulled does not have a shared manager composed.
+
+This likely will not cause regressions in existing code, but may be something to
+be aware of if you were previously depending on lazy-loaded event manager
+state.

doc/bookdown.json

@@ -0,0 +1,8 @@
+{
+  "title": "zend-mvc: MVC application provider",
+  "content": [
+    {"Intro": "../README.md"},
+    {"Migration Guide": "book/migration.md"}
+  ],
+  "target": "./html"
+}

src/Application.php

@@ -12,6 +12,7 @@
 use Zend\EventManager\EventManagerAwareInterface;
 use Zend\EventManager\EventManagerInterface;
 use Zend\ServiceManager\ServiceManager;
+use Zend\Stdlib\RequestInterface;
 use Zend\Stdlib\ResponseInterface;
 
 /**
@@ -103,15 +104,18 @@ class Application implements
      * @param mixed $configuration
      * @param ServiceManager $serviceManager
      */
-    public function __construct($configuration, ServiceManager $serviceManager)
-    {
+    public function __construct(
+        $configuration,
+        ServiceManager $serviceManager,
+        EventManagerInterface $events,
+        RequestInterface $request,
+        ResponseInterface $response
+    ) {
         $this->configuration  = $configuration;
         $this->serviceManager = $serviceManager;
-
-        $this->setEventManager($serviceManager->get('EventManager'));
-
-        $this->request        = $serviceManager->get('Request');
-        $this->response       = $serviceManager->get('Response');
+        $this->setEventManager($events);
+        $this->request        = $request;
+        $this->response       = $response;
     }
 
     /**
@@ -142,19 +146,20 @@ public function bootstrap(array $listeners = [])
         $listeners = array_unique(array_merge($this->defaultListeners, $listeners));
 
         foreach ($listeners as $listener) {
-            $events->attach($serviceManager->get($listener));
+            $serviceManager->get($listener)->attach($events);
         }
 
         // Setup MVC Event
         $this->event = $event  = new MvcEvent();
+        $event->setName(MvcEvent::EVENT_BOOTSTRAP);
         $event->setTarget($this);
-        $event->setApplication($this)
-              ->setRequest($this->request)
-              ->setResponse($this->response)
-              ->setRouter($serviceManager->get('Router'));
+        $event->setApplication($this);
+        $event->setRequest($this->request);
+        $event->setResponse($this->response);
+        $event->setRouter($serviceManager->get('Router'));
 
         // Trigger bootstrap events
-        $events->trigger(MvcEvent::EVENT_BOOTSTRAP, $event);
+        $events->triggerEvent($event);
         return $this;
     }
 
@@ -294,13 +299,15 @@ public function run()
         };
 
         // Trigger route event
-        $result = $events->trigger(MvcEvent::EVENT_ROUTE, $event, $shortCircuit);
+        $event->setName(MvcEvent::EVENT_ROUTE);
+        $result = $events->triggerEventUntil($shortCircuit, $event);
         if ($result->stopped()) {
             $response = $result->last();
             if ($response instanceof ResponseInterface) {
+                $event->setName(MvcEvent::EVENT_FINISH);
                 $event->setTarget($this);
                 $event->setResponse($response);
-                $events->trigger(MvcEvent::EVENT_FINISH, $event);
+                $events->triggerEvent($event);
                 $this->response = $response;
                 return $this;
             }
@@ -311,14 +318,16 @@ public function run()
         }
 
         // Trigger dispatch event
-        $result = $events->trigger(MvcEvent::EVENT_DISPATCH, $event, $shortCircuit);
+        $event->setName(MvcEvent::EVENT_DISPATCH);
+        $result = $events->triggerEventUntil($shortCircuit, $event);
 
         // Complete response
         $response = $result->last();
         if ($response instanceof ResponseInterface) {
+            $event->setName(MvcEvent::EVENT_FINISH);
             $event->setTarget($this);
             $event->setResponse($response);
-            $events->trigger(MvcEvent::EVENT_FINISH, $event);
+            $events->triggerEvent($event);
             $this->response = $response;
             return $this;
         }
@@ -350,8 +359,13 @@ protected function completeRequest(MvcEvent $event)
     {
         $events = $this->events;
         $event->setTarget($this);
-        $events->trigger(MvcEvent::EVENT_RENDER, $event);
-        $events->trigger(MvcEvent::EVENT_FINISH, $event);
+
+        $event->setName(MvcEvent::EVENT_RENDER);
+        $events->triggerEvent($event);
+
+        $event->setName(MvcEvent::EVENT_FINISH);
+        $events->triggerEvent($event);
+
         return $this;
     }
 }

src/Controller/AbstractController.php

@@ -109,13 +109,14 @@ public function dispatch(Request $request, Response $response = null)
         $this->response = $response;
 
         $e = $this->getEvent();
-        $e->setRequest($request)
-          ->setResponse($response)
-          ->setTarget($this);
+        $e->setName(MvcEvent::EVENT_DISPATCH);
+        $e->setRequest($request);
+        $e->setResponse($response);
+        $e->setTarget($this);
 
-        $result = $this->getEventManager()->trigger(MvcEvent::EVENT_DISPATCH, $e, function ($test) {
+        $result = $this->getEventManager()->triggerEventUntil(function ($test) {
             return ($test instanceof Response);
-        });
+        }, $e);
 
         if ($result->stopped()) {
             return $result->last();

src/Controller/ControllerManager.php

@@ -10,7 +10,7 @@
 namespace Zend\Mvc\Controller;
 
 use Zend\EventManager\EventManagerAwareInterface;
-use Zend\EventManager\EventManagerInterface;
+use Zend\EventManager\SharedEventManagerInterface;
 use Zend\Mvc\Exception;
 use Zend\ServiceManager\AbstractPluginManager;
 use Zend\ServiceManager\ConfigInterface;
@@ -73,10 +73,8 @@ public function injectControllerDependencies($controller, ServiceLocatorInterfac
             // is why the shared EM injection needs to happen; the conditional
             // will always pass.
             $events = $controller->getEventManager();
-            if (!$events instanceof EventManagerInterface) {
+            if (! $events || ! $events->getSharedManager() instanceof SharedEventManagerInterface) {
                 $controller->setEventManager($parentLocator->get('EventManager'));
-            } else {
-                $events->setSharedManager($parentLocator->get('SharedEventManager'));
             }
         }
 

src/Controller/Plugin/Forward.php

@@ -177,9 +177,9 @@ protected function detachProblemListeners(SharedEvents $sharedEvents)
             $results[$id] = [];
             foreach ($eventArray as $eventName => $classArray) {
                 $results[$id][$eventName] = [];
-                $events = $sharedEvents->getListeners($id, $eventName);
+                $events = $sharedEvents->getListeners([$id], $eventName);
                 foreach ($events as $currentEvent) {
-                    $currentCallback = $currentEvent->getCallback();
+                    $currentCallback = $currentEvent;
 
                     // If we have an array, grab the object
                     if (is_array($currentCallback)) {
@@ -193,7 +193,7 @@ protected function detachProblemListeners(SharedEvents $sharedEvents)
 
                     foreach ($classArray as $class) {
                         if ($currentCallback instanceof $class) {
-                            $sharedEvents->detach($id, $currentEvent);
+                            $sharedEvents->detach($currentEvent, $id);
                             $results[$id][$eventName][] = $currentEvent;
                         }
                     }