add zend service proxy (#7)

This will allow to inject any zend defined service into a symfony defined service.

Author: tonivdv

README.md

@@ -52,21 +52,52 @@ return [
 
 # Usage
 
-Any existing service will directly be available through the Service Manager of Zend:
+Refer to the documentation of the [Symfony DI Component](https://symfony.com/doc/3.4/components/dependency_injection.html) for information on how to use the DI container.
+
+#### Obtain a symfony defined service
+
+Any existing symfony service will directly be available through the Service Manager of Zend:
 
 ```php
 <?php
 
 $service = $this->getServiceLocator()->get(\My\Public\Service::class);
 ```
 
-But you can also retrieve the symfony container:
+#### Build a symfony defined service with a Zend service dependency
+
+It will happen that you have to use a dependency which is already loaded into the Zend Service Manager. For example, if you are using the Doctrine Module and you
+need to have the instance of the Entity Manager, you can leverage the ZendServiceProxyFactory class:
+
+```yaml
+services:
+
+  _defaults:
+
+    autowire: true      # Automatically injects dependencies in your services.
+    autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
+    public: false       # Allows optimizing the container by removing unused services; this also means
+                        # fetching services directly from the container via $container->get() won't work.
+                        # The best practice is to be explicit about your dependencies anyway.
+
+  #
+  # Define service that needs to be retrieved via the Zend Service Manager
+  #
+
+  Doctrine\ORM\EntityManagerInterface:
+    factory: ['Adlogix\ZfSymfonyContainer\Service\Factory\ZendServiceProxyFactory', getService]
+    arguments: ['@zend.container', 'doctrine.entitymanager.orm_default']
+    class: Doctrine\ORM\EntityManagerInterface
+
+```
+
+With this configuration, and service defined with the symfony container requiring an instance of Doctrine\ORM\EntityManagerInterface will receive this from
+the Zend Service Manager.
 
+#### Obtain the symfony container instance
 
 ```php
 <?php
 
 $container = $this->getServiceLocator()->get('zf_symfony_container');
 ```
-
-Refer to the documentation of the [Symfony DI Component](https://symfony.com/doc/3.4/components/dependency_injection.html) for more information on how to use the container.

src/Service/Factory/SymfonyContainerAbstractFactory.php

@@ -16,6 +16,10 @@
 use Zend\ServiceManager\ServiceLocatorInterface;
 
 /**
+ * Abstract Zend factory which will delegate service lookup in the symfony container when available.
+ *
+ * This allows to load symfony services transparently via the traditional $serviceLocator->get() method.
+ *
  * @author Toni Van de Voorde <[email protected]>
  */
 final class SymfonyContainerAbstractFactory implements AbstractFactoryInterface

src/Service/Factory/SymfonyContainerFactory.php

@@ -37,10 +37,10 @@ public function createService(ServiceLocatorInterface $serviceLocator)
     /**
      * {@inheritdoc}
      */
-    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
+    public function __invoke(ContainerInterface $zfContainer, $requestedName, array $options = null)
     {
         /** @var Configuration $configuration */
-        $configuration = $container->get('zf_symfony_container_config');
+        $configuration = $zfContainer->get('zf_symfony_container_config');
 
         $cachedFilePath = $configuration->getCacheDir() . DIRECTORY_SEPARATOR . $configuration->getCacheFilename();
 
@@ -50,6 +50,13 @@ public function __invoke(ContainerInterface $container, $requestedName, array $o
             $containerBuilder = new ContainerBuilder();
             $loader = new YamlFileLoader($containerBuilder, new FileLocator([$configuration->getConfigDir()]));
             $loader->load('services.yaml');
+
+            // Register a synthetic service placement. This is where we are going to inject the zend service manager.
+            // This is important so we can make use of the ZendServiceProxyFactory
+            $containerBuilder
+                ->register('zend.container')
+                ->setSynthetic(true);
+
             $containerBuilder->compile();
 
             $dumper = new PhpDumper($containerBuilder);
@@ -64,6 +71,9 @@ public function __invoke(ContainerInterface $container, $requestedName, array $o
 
         require_once $cachedFilePath;
 
-        return new \Adlogix\ZfSymfonyContainer\DependencyInjection\CachedContainer();
+        $cachedContainer = new \Adlogix\ZfSymfonyContainer\DependencyInjection\CachedContainer();
+        $cachedContainer->set('zend.container', $zfContainer);
+
+        return $cachedContainer;
     }
 }

src/Service/Factory/ZendServiceProxyFactory.php

@@ -0,0 +1,34 @@
+<?php
+/*
+ * This file is part of the Adlogix package.
+ *
+ * (c) Allan Segebarth <[email protected]>
+ * (c) Jean-Jacques Courtens <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Adlogix\ZfSymfonyContainer\Service\Factory;
+
+use Interop\Container\ContainerInterface;
+
+/**
+ * A symfony container factory, allowing the load zend specific services. This is crucial when requiring to load
+ * services that have been injected in the Zend service manager through e.g. third party modules.
+ *
+ * @author Toni Van de Voorde <[email protected]>
+ */
+final class ZendServiceProxyFactory
+{
+    /**
+     * @param ContainerInterface $container
+     * @param string             $service
+     *
+     * @return mixed
+     */
+    public static function getService(ContainerInterface $container, $service)
+    {
+        return $container->get($service);
+    }
+}

tests/Fixtures/Zend/DummyThree.php

@@ -0,0 +1,16 @@
+<?php
+/*
+ * This file is part of the Adlogix package.
+ *
+ * (c) Allan Segebarth <[email protected]>
+ * (c) Jean-Jacques Courtens <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Adlogix\ZfSymfonyContainer\Test\Fixtures\Zend;
+
+class DummyThree
+{
+}

tests/Service/Factory/ZendServiceProxyFactoryTest.php

@@ -0,0 +1,37 @@
+<?php
+/*
+ * This file is part of the Adlogix package.
+ *
+ * (c) Allan Segebarth <[email protected]>
+ * (c) Jean-Jacques Courtens <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Adlogix\ZfSymfonyContainer\Test\Service\Factory;
+
+use Adlogix\ZfSymfonyContainer\Test\Fixtures\Zend\DummyThree;
+use Adlogix\ZfSymfonyContainer\Test\Util\ServiceManagerFactory;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * @author Toni Van de Voorde <[email protected]>
+ */
+final class ZendServiceProxyFactoryTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function getService_givenAnExistingZendService_shouldReturnTheService()
+    {
+        /** @var ContainerInterface $container */
+        $container = ServiceManagerFactory::getServiceManager()
+            ->get('zf_symfony_container');
+
+        $dummy = $container->get(DummyThree::class);
+
+        $this->assertInstanceOf(DummyThree::class, $dummy);
+    }
+}

tests/sandbox/config/services.yaml

@@ -4,5 +4,15 @@ services:
 
     autowire: true      # Automatically injects dependencies in your services.
 
+  #
+  # Define service that needs to be retrieved via the Zend Service Manager
+  #
+
+  Adlogix\ZfSymfonyContainer\Test\Fixtures\Zend\DummyThree:
+    factory: ['Adlogix\ZfSymfonyContainer\Service\Factory\ZendServiceProxyFactory', getService]
+    arguments: ['@zend.container', 'Adlogix\ZfSymfonyContainer\Test\Fixtures\Zend\DummyThree']
+    class: Adlogix\ZfSymfonyContainer\Test\Fixtures\Zend\DummyThree
+
   Adlogix\ZfSymfonyContainer\Test\Fixtures\:
-    resource: '../../Fixtures/*'
+    resource: '../../Fixtures/*'
+    exclude: '../../Fixtures/Zend/*'

tests/testing.config.php

@@ -9,6 +9,8 @@
  * file that was distributed with this source code.
  */
 
+use Adlogix\ZfSymfonyContainer\Test\Fixtures\Zend\DummyThree;
+
 return [
 
     'zf_symfony_container' => [
@@ -27,4 +29,12 @@
 
         ],
     ],
+
+    'service_manager' => [
+
+        'invokables' => [
+            DummyThree::class => DummyThree::class
+        ]
+
+    ]
 ];