Re-added functionality removed in previous patches

This patch re-introduces the following classes from the
`Zend\Mvc\Service` namespace, along with related tests:

- `ConfigFactory`
- `ControllerLoaderFactory`
- `DiAbstractServiceFactoryFactory`
- `DiFactory`
- `DiServiceInitializerFactory`
- `DiStrictAbstractServiceFactory`
- `DiStrictAbstractServiceFactoryFactory`

It also re-instates the `ServiceManagerAware` and `ServiceLocatorAware`
initializers in the `ServiceManagerConfig` class (though they will now
emit deprecation notices), and ensures that class properly defines
services such that they'll be accessible identically between v2 and v3
of zend-servicemanager.

Author: weierophinney

CHANGELOG.md

@@ -40,25 +40,20 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Deprecated
 
-- Nothing.
+- Two initializers registered by `Zend\Mvc\Service\ServiceManagerConfig` are now
+  deprecated, and will be removed starting in version 3.0:
+  - `ServiceManagerAwareInitializer`, which injects classes implementing
+    `Zend\ServiceManager\ServiceManagerAwareInterface` with the service manager
+    instance. Users should create factories for such classes that directly
+    inject their dependencies instead.
+  - `ServiceLocatorAwareInitializer`, which injects classes implementing
+    `Zend\ServiceManager\ServiceLocatorAwareInterface` with the service manager
+    instance. Users should create factories for such classes that directly
+    inject their dependencies instead.
 
 ### Removed
 
-- [#36](https://github.com/zendframework/zend-mvc/pull/36) removes
-  `Zend\Mvc\Service\ConfigFactory`, as the functionality is now incorporated
-  into `Zend\ModuleManager\Listener\ServiceListener`.
-- [#36](https://github.com/zendframework/zend-mvc/pull/36) removes
-  the `ServiceLocatorAware` intializer, as zend-servicemanager v3 no longer
-  defines the interface.
-- [#36](https://github.com/zendframework/zend-mvc/pull/36) removes
-  `Zend\Mvc\Service\ControllerLoaderFactory` and replaces it with
-  `Zend\Mvc\Service\ControllerManagerFactory`.
-- [#36](https://github.com/zendframework/zend-mvc/pull/36) removes
-  `Zend\Mvc\Service\DiFactory`, `Zend\Mvc\Service\DiAbstractServiceFactory`,
-  `Zend\Mvc\Service\DiStrictAbstractServiceFactory`,
-  `Zend\Mvc\Service\DiStrictAbstractServiceFactoryFactory`,
-  and `Zend\Mvc\Service\DiServiceInitializerFactory`, as zend-servicemanager v3
-  removes `Zend\Di` integration.
+- Nothing.
 
 ### Fixed
 

src/Service/ConfigFactory.php

@@ -0,0 +1,37 @@
+<?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
+ */
+
+namespace Zend\Mvc\Service;
+
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class ConfigFactory implements FactoryInterface
+{
+    /**
+     * Create the application configuration service
+     *
+     * Retrieves the Module Manager from the service locator, and executes
+     * {@link Zend\ModuleManager\ModuleManager::loadModules()}.
+     *
+     * It then retrieves the config listener from the module manager, and from
+     * that the merged configuration.
+     *
+     * @param  ServiceLocatorInterface $serviceLocator
+     * @return array|\Traversable
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $mm           = $serviceLocator->get('ModuleManager');
+        $mm->loadModules();
+        $moduleParams = $mm->getEvent()->getParams();
+        $config       = $moduleParams['configListener']->getMergedConfig(false);
+        return $config;
+    }
+}

src/Service/ControllerLoaderFactory.php

@@ -0,0 +1,48 @@
+<?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
+ */
+
+namespace Zend\Mvc\Service;
+
+use Zend\Mvc\Controller\ControllerManager;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class ControllerLoaderFactory implements FactoryInterface
+{
+    /**
+     * Create the controller loader service
+     *
+     * Creates and returns an instance of ControllerManager. The
+     * only controllers this manager will allow are those defined in the
+     * application configuration's "controllers" array. If a controller is
+     * matched, the scoped manager will attempt to load the controller.
+     * Finally, it will attempt to inject the controller plugin manager
+     * if the controller implements a setPluginManager() method.
+     *
+     * This plugin manager is _not_ peered against DI, and as such, will
+     * not load unknown classes.
+     *
+     * @param  ServiceLocatorInterface $serviceLocator
+     * @return ControllerManager
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $controllerLoader = new ControllerManager();
+        $controllerLoader->setServiceLocator($serviceLocator);
+        $controllerLoader->addPeeringServiceManager($serviceLocator);
+
+        $config = $serviceLocator->get('Config');
+
+        if (isset($config['di']) && isset($config['di']['allowed_controllers']) && $serviceLocator->has('Di')) {
+            $controllerLoader->addAbstractFactory($serviceLocator->get('DiStrictAbstractServiceFactory'));
+        }
+
+        return $controllerLoader;
+    }
+}

src/Service/DiAbstractServiceFactoryFactory.php

@@ -0,0 +1,36 @@
+<?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
+ */
+
+namespace Zend\Mvc\Service;
+
+use Zend\ServiceManager\Di\DiAbstractServiceFactory;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use Zend\ServiceManager\ServiceManager;
+
+class DiAbstractServiceFactoryFactory implements FactoryInterface
+{
+    /**
+     * Class responsible for instantiating a DiAbstractServiceFactory
+     *
+     * @param  ServiceLocatorInterface $serviceLocator
+     * @return DiAbstractServiceFactory
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $factory = new DiAbstractServiceFactory($serviceLocator->get('Di'), DiAbstractServiceFactory::USE_SL_BEFORE_DI);
+
+        if ($serviceLocator instanceof ServiceManager) {
+            /* @var $serviceLocator ServiceManager */
+            $serviceLocator->addAbstractFactory($factory, false);
+        }
+
+        return $factory;
+    }
+}

src/Service/DiFactory.php

@@ -0,0 +1,44 @@
+<?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
+ */
+
+namespace Zend\Mvc\Service;
+
+use Zend\Di\Config;
+use Zend\Di\Di;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class DiFactory implements FactoryInterface
+{
+    /**
+     * Create and return abstract factory seeded by dependency injector
+     *
+     * Creates and returns an abstract factory seeded by the dependency
+     * injector. If the "di" key of the configuration service is set, that
+     * sub-array is passed to a DiConfig object and used to configure
+     * the DI instance. The DI instance is then used to seed the
+     * DiAbstractServiceFactory, which is then registered with the service
+     * manager.
+     *
+     * @param  ServiceLocatorInterface $serviceLocator
+     * @return Di
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $di     = new Di();
+        $config = $serviceLocator->get('Config');
+
+        if (isset($config['di'])) {
+            $config = new Config($config['di']);
+            $config->configure($di);
+        }
+
+        return $di;
+    }
+}

src/Service/DiServiceInitializerFactory.php

@@ -0,0 +1,28 @@
+<?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
+ */
+
+namespace Zend\Mvc\Service;
+
+use Zend\ServiceManager\Di\DiServiceInitializer;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class DiServiceInitializerFactory implements FactoryInterface
+{
+    /**
+     * Class responsible for instantiating a DiServiceInitializer
+     *
+     * @param  ServiceLocatorInterface $serviceLocator
+     * @return DiServiceInitializer
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        return new DiServiceInitializer($serviceLocator->get('Di'), $serviceLocator);
+    }
+}

src/Service/DiStrictAbstractServiceFactory.php

@@ -0,0 +1,142 @@
+<?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
+ */
+
+namespace Zend\Mvc\Service;
+
+use Zend\Di\Di;
+use Zend\Di\Exception\ClassNotFoundException;
+use Zend\Mvc\Exception\DomainException;
+use Zend\ServiceManager\AbstractFactoryInterface;
+use Zend\ServiceManager\AbstractPluginManager;
+use Zend\ServiceManager\Exception;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class DiStrictAbstractServiceFactory extends Di implements AbstractFactoryInterface
+{
+    /**@#+
+     * constants
+     */
+    const USE_SL_BEFORE_DI = 'before';
+    const USE_SL_AFTER_DI  = 'after';
+    const USE_SL_NONE      = 'none';
+    /**@#-*/
+
+    /**
+     * @var Di
+     */
+    protected $di = null;
+
+    /**
+     * @var string
+     */
+    protected $useServiceLocator = self::USE_SL_AFTER_DI;
+
+    /**
+     * @var ServiceLocatorInterface
+     */
+    protected $serviceLocator = null;
+
+    /**
+     * @var array an array of whitelisted service names (keys are the service names)
+     */
+    protected $allowedServiceNames = [];
+
+    /**
+     * @param Di $di
+     * @param string $useServiceLocator
+     */
+    public function __construct(Di $di, $useServiceLocator = self::USE_SL_NONE)
+    {
+        $this->useServiceLocator = $useServiceLocator;
+        // since we are using this in a proxy-fashion, localize state
+        $this->di              = $di;
+        $this->definitions     = $this->di->definitions;
+        $this->instanceManager = $this->di->instanceManager;
+    }
+
+    /**
+     * @param array $allowedServiceNames
+     */
+    public function setAllowedServiceNames(array $allowedServiceNames)
+    {
+        $this->allowedServiceNames = array_flip(array_values($allowedServiceNames));
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllowedServiceNames()
+    {
+        return array_keys($this->allowedServiceNames);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * Allows creation of services only when in a whitelist
+     */
+    public function createServiceWithName(ServiceLocatorInterface $serviceLocator, $serviceName, $requestedName)
+    {
+        if (!isset($this->allowedServiceNames[$requestedName])) {
+            throw new Exception\InvalidServiceNameException('Service "' . $requestedName . '" is not whitelisted');
+        }
+
+        if ($serviceLocator instanceof AbstractPluginManager) {
+            /* @var $serviceLocator AbstractPluginManager */
+            $this->serviceLocator = $serviceLocator->getServiceLocator();
+        } else {
+            $this->serviceLocator = $serviceLocator;
+        }
+
+        return parent::get($requestedName);
+    }
+
+    /**
+     * Overrides Zend\Di to allow the given serviceLocator's services to be reused by Di itself
+     *
+     * {@inheritDoc}
+     *
+     * @throws Exception\InvalidServiceNameException
+     */
+    public function get($name, array $params = [])
+    {
+        if (null === $this->serviceLocator) {
+            throw new DomainException('No ServiceLocator defined, use `createServiceWithName` instead of `get`');
+        }
+
+        if (self::USE_SL_BEFORE_DI === $this->useServiceLocator && $this->serviceLocator->has($name)) {
+            return $this->serviceLocator->get($name);
+        }
+
+        try {
+            return parent::get($name, $params);
+        } catch (ClassNotFoundException $e) {
+            if (self::USE_SL_AFTER_DI === $this->useServiceLocator && $this->serviceLocator->has($name)) {
+                return $this->serviceLocator->get($name);
+            }
+
+            throw new Exception\ServiceNotFoundException(
+                sprintf('Service %s was not found in this DI instance', $name),
+                null,
+                $e
+            );
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * Allows creation of services only when in a whitelist
+     */
+    public function canCreateServiceWithName(ServiceLocatorInterface $serviceLocator, $name, $requestedName)
+    {
+        // won't check if the service exists, we are trusting the user's whitelist
+        return isset($this->allowedServiceNames[$requestedName]);
+    }
+}