use the zend config into the Symfony container (#8)

With this commit it's now possible to use the ZF config into the Symfony service container.

When the system creates the Symfony container it injects the ZF config. Since ZF is using the same naming convention with a different meaning as Symfony we need to translate them before the import.

Author: laudeco

README.md

@@ -101,3 +101,36 @@ the Zend Service Manager.
 
 $container = $this->getServiceLocator()->get('zf_symfony_container');
 ```
+
+#### Use the Zend config as Symfony parameters
+The module takes care of transforming all zend configurations into [Symfony parameters](https://symfony.com/doc/current/service_container/parameters.html) allowing you to immediately use the parameters in the service definition file:
+```php
+<?php
+// global.php
+return [
+    'myconfig' => 'hello world' 
+];
+```
+```yaml
+services:
+  Some\Service:
+    arguments: ['%myconfig%']
+```
+When the Zend configuration contains deep level keys, the "keys" will be concatenated with a dot.
+```php
+<?php
+// global.php
+return [
+    'deep' => [
+        'level' => [
+            'config' => 'hello world'            
+        ]    
+    ]    
+];
+```
+```yaml
+services:
+  Some\Service:
+    arguments: ['%deep.level.config%']
+```
+_Note: zend configurations using callables will be ignored and cannot be used!_ 

src/ParameterBag/ZendFrameworkParameterBag.php

@@ -0,0 +1,57 @@
+<?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\ParameterBag;
+
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
+
+/**
+ * Translate the ZF config into Symfony parameters.
+ *
+ * @author Laurent De Coninck <[email protected]>
+ */
+class ZendFrameworkParameterBag extends ParameterBag
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function add(array $parameters)
+    {
+        foreach ($parameters as $key => $value) {
+            if (is_array($value)) {
+                $this->addChildren($key, $value);
+                continue;
+            }
+
+            if (is_callable($value)) {
+                //not supported by Symfony
+                continue;
+            }
+
+            $this->set($key, str_replace('%', '%%', $value));
+        }
+    }
+
+    /**
+     * @param string $previousKey
+     * @param array  $children
+     */
+    private function addChildren($previousKey, array $children)
+    {
+        $formattedChildren = [];
+
+        foreach ($children as $key => $value) {
+            $formattedChildren[$previousKey . '.' . $key] = $value;
+        }
+
+        $this->add($formattedChildren);
+    }
+}

src/Service/Factory/SymfonyContainerFactory.php

@@ -12,6 +12,7 @@
 namespace Adlogix\ZfSymfonyContainer\Service\Factory;
 
 use Adlogix\ZfSymfonyContainer\Options\Configuration;
+use Adlogix\ZfSymfonyContainer\ParameterBag\ZendFrameworkParameterBag;
 use Interop\Container\ContainerInterface;
 use Symfony\Component\Config\ConfigCache;
 use Symfony\Component\Config\FileLocator;
@@ -47,7 +48,8 @@ public function __invoke(ContainerInterface $zfContainer, $requestedName, array
         $containerConfigCache = new ConfigCache($cachedFilePath, $configuration->isDebug());
 
         if (!$containerConfigCache->isFresh()) {
-            $containerBuilder = new ContainerBuilder();
+            $zfConfig = $zfContainer->get('config');
+            $containerBuilder = new ContainerBuilder(new ZendFrameworkParameterBag($zfConfig));
             $loader = new YamlFileLoader($containerBuilder, new FileLocator([$configuration->getConfigDir()]));
             $loader->load('services.yaml');
 

tests/ParameterBag/ZendFrameworkParameterBagTest.php

@@ -0,0 +1,96 @@
+<?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\ParameterBag;
+
+use Adlogix\ZfSymfonyContainer\ParameterBag\ZendFrameworkParameterBag;
+
+/**
+ * @author Laurent De Coninck <[email protected]>
+ */
+class ZendFrameworkParameterBagTest extends \PHPUnit_Framework_TestCase
+{
+
+    /**
+     * @param array $parameters
+     *
+     * @return ZendFrameworkParameterBag
+     */
+    private function createParameterBag(array $parameters)
+    {
+        return new ZendFrameworkParameterBag($parameters);
+    }
+
+    /**
+     * @test
+     */
+    public function add_WithValues_Success()
+    {
+        $data = [
+            'key'        => 'value1',
+            'anotherKey' => '%value1%',
+        ];
+
+        $parameterBag = $this->createParameterBag($data);
+
+        $this->assertEquals('value1', $parameterBag->get('key'));
+        $this->assertEquals('%%value1%%', $parameterBag->get('anotherKey'));
+    }
+
+    /**
+     * @test
+     */
+    public function add_WithTables_Success()
+    {
+        $data = [
+            'key'         => 'value1',
+            'associative' => [
+                'a' => 1,
+                'c' => 2,
+                'd' => 3,
+            ],
+            'index' => [
+                'A',
+                'B',
+                'C',
+            ],
+            'arrayOfArray' => [
+                'a' => [
+                    'A',
+                    'B',
+                    'C',
+                ],
+            ],
+        ];
+
+        $parameterBag = $this->createParameterBag($data);
+        $this->assertEquals('value1', $parameterBag->get('key'));
+        $this->assertEquals(2, $parameterBag->get('associative.c'));
+        $this->assertEquals('B', $parameterBag->get('index.1'));
+        $this->assertEquals('B', $parameterBag->get('arrayOfArray.a.1'));
+    }
+
+    /**
+     * @test
+     */
+    public function add_WithCallable_Skipped()
+    {
+        $data = [
+            'callback' => function () {
+                return true;
+            },
+        ];
+
+        $parameterBag = $this->createParameterBag($data);
+
+        $this->assertFalse($parameterBag->has('callback'));
+    }
+}