Vary PluginManager implementation based on zend-servicemanager version detected

`PluginManager` overrides the `get()` method, which has a different
signature in v2 than in v3. Until PHP 7.2, this was not a problem;
however, in 7.2, even optional values must follow the exact same
signature as the parent. As a result, we now need to vary the
implementations.

This patch provides `AbstractPluginManager`, which contains the bulk of the
logic for implementing the `PluginManager`. It then introduces the
following:

- `PluginManagerSM2`, which extends `AbstractPluginManager` and
  implements the zend-servicemanager v2 `get()` signature.
- `PluginManagerSM3`, which extends `AbstractPluginManager` and
  implements the zend-servicemanager v3 `get()` signature.

It removes the `PluginManager` class.

It then adds a file-based autoloader that checks to see if
`Zend\ServiceManager\PluginManagerInterface` exists. If it does, it
aliases `PluginManager` to `PluginManagerSM3`; otherwise, it aliases it
to `PluginManagerSM2`.

Additionally, this patch updates to zend-servicemanager 2.7.10, which
has important fixes to how it handles creation options with
InvokableFactory that are necessary here.

Author: weierophinney

composer.json

@@ -8,14 +8,17 @@
     ],
     "homepage": "https://github.com/zendframework/zend-mvc",
     "autoload": {
+        "files": [
+            "src/autoload.php"
+        ],
         "psr-4": {
             "Zend\\Mvc\\": "src/"
         }
     },
     "require": {
         "php": "^5.5 || ^7.0",
         "zendframework/zend-eventmanager": "^2.6.4 || ^3.0",
-        "zendframework/zend-servicemanager": "^2.7.9 || ^3.0.3",
+        "zendframework/zend-servicemanager": "^2.7.10 || ^3.0.3",
         "zendframework/zend-hydrator": "^1.1 || ^2.4",
         "zendframework/zend-form": "^2.11",
         "zendframework/zend-stdlib": "^2.7.5 || ^3.0",

composer.lock

@@ -1,27 +1,27 @@
 <?php
 /**
- * Zend Framework (http://framework.zend.com/)
- *
- * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/zend-mvc for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License
  */
 
 namespace Zend\Mvc\Controller;
 
 use Zend\Mvc\Exception;
-use Zend\ServiceManager\AbstractPluginManager;
+use Zend\ServiceManager\AbstractPluginManager as BasePluginManager;
 use Zend\ServiceManager\Exception\InvalidServiceException;
 use Zend\ServiceManager\Factory\InvokableFactory;
 use Zend\Stdlib\DispatchableInterface;
 
 /**
- * Plugin manager implementation for controllers
+ * Base functionality for the controller plugins plugin manager.
  *
- * Registers a number of default plugins, and contains an initializer for
- * injecting plugins with the current controller.
+ * Functionality is split between two concrete implementations as the signatures
+ * for `get()` vary between zend-servicemanager v2 and v3. The autoloader aliases
+ * `Zend\Mvc\Controller\PluginManager` to the version-appropriate class, which
+ * in turn composses this trait.
  */
-class PluginManager extends AbstractPluginManager
+abstract class AbstractPluginManager extends BasePluginManager
 {
     /**
      * Plugins must be of this type.
@@ -106,28 +106,6 @@ class PluginManager extends AbstractPluginManager
      */
     protected $controller;
 
-    /**
-     * Retrieve a registered instance
-     *
-     * After the plugin is retrieved from the service locator, inject the
-     * controller in the plugin every time it is requested. This is required
-     * because a controller can use a plugin and another controller can be
-     * dispatched afterwards. If this second controller uses the same plugin
-     * as the first controller, the reference to the controller inside the
-     * plugin is lost.
-     *
-     * @param  string $name
-     * @return DispatchableInterface
-     */
-    public function get($name, array $options = null, $usePeeringServiceManagers = true)
-    {
-        $options = $options ?: [];
-        $plugin = parent::get($name, $options);
-        $this->injectController($plugin);
-
-        return $plugin;
-    }
-
     /**
      * Set controller
      *

src/Controller/PluginManager.php renamed to src/Controller/AbstractPluginManager.php

@@ -13,7 +13,7 @@
 use Zend\EventManager\EventManagerAwareInterface;
 use Zend\EventManager\SharedEventManagerInterface;
 use Zend\Mvc\Exception;
-use Zend\ServiceManager\AbstractPluginManager;
+use Zend\ServiceManager\AbstractPluginManager as BasePluginManager;
 use Zend\ServiceManager\ConfigInterface;
 use Zend\ServiceManager\Exception\InvalidServiceException;
 use Zend\ServiceManager\ServiceLocatorAwareInterface;
@@ -24,7 +24,7 @@
  *
  * Does not define any controllers by default, but does add a validator.
  */
-class ControllerManager extends AbstractPluginManager
+class ControllerManager extends BasePluginManager
 {
     /**
      * We do not want arbitrary classes instantiated as controllers.

src/Controller/ControllerManager.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-mvc for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Zend\Mvc\Controller;
+
+use Zend\Stdlib\DispatchableInterface;
+
+class PluginManagerSM2 extends AbstractPluginManager
+{
+    /**
+     * Retrieve a registered instance
+     *
+     * After the plugin is retrieved from the service locator, inject the
+     * controller in the plugin every time it is requested. This is required
+     * because a controller can use a plugin and another controller can be
+     * dispatched afterwards. If this second controller uses the same plugin
+     * as the first controller, the reference to the controller inside the
+     * plugin is lost.
+     *
+     * @param  string $name
+     * @return DispatchableInterface
+     */
+    public function get($name, $options = [], $usePeeringServiceManagers = true)
+    {
+        $options = is_array($options) && empty($options) ? null : $options;
+        $plugin = parent::get($name, $options);
+        $this->injectController($plugin);
+
+        return $plugin;
+    }
+}

src/Controller/PluginManagerSM2.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-mvc for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Zend\Mvc\Controller;
+
+use Zend\Stdlib\DispatchableInterface;
+
+class PluginManagerSM3 extends AbstractPluginManager
+{
+    /**
+     * Retrieve a registered instance
+     *
+     * After the plugin is retrieved from the service locator, inject the
+     * controller in the plugin every time it is requested. This is required
+     * because a controller can use a plugin and another controller can be
+     * dispatched afterwards. If this second controller uses the same plugin
+     * as the first controller, the reference to the controller inside the
+     * plugin is lost.
+     *
+     * @param string $name
+     * @param null|array $options
+     * @return DispatchableInterface
+     */
+    public function get($name, array $options = null)
+    {
+        $plugin = parent::get($name, $options);
+        $this->injectController($plugin);
+
+        return $plugin;
+    }
+}

src/Controller/PluginManagerSM3.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-mvc for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Zend\Mvc;
+
+use Zend\ServiceManager\PluginManagerInterface;
+
+if (class_exists(PluginManagerInterface::class)) {
+    class_alias(Controller\PluginManagerSM3::class, Controller\PluginManager::class, true);
+} else {
+    class_alias(Controller\PluginManagerSM2::class, Controller\PluginManager::class, true);
+}