1.1.0

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All Notable changes to `Vars` will be documented in this file
 
+## 1.1.0 - 2016-02-05
+
+### Added
+- Support for `_globals`
+- Support to merge globals into `$app` for Silex
+
 ## 1.0.0 - 2016-01-19
 
 ### Added

README.md

@@ -59,7 +59,7 @@ Sometimes you're forced to use different formats for config files and one of Var
 by supporting the most common config formats so you don't have to switch libraries to deal with the different formats.
 
 Another aim is to support different frameworks so again you don't have to switch libraries when dealing with different frameworks.
-Currently only supporting Silex with support for Laravel and Symfony to follow shortly.
+Currently only supporting Silex using a service provider, support for Laravel and Symfony to follow shortly.
 
 With a simple API and intuitive loading options, Vars tries to make config loading and providing as easy as possible for you.
 
@@ -293,6 +293,9 @@ $vars = new Vars(__DIR__.'/config/config.yml', [
         'foo' => 'bar',
         'foobar' => 'barfoo'
     ],
+    
+    // Merge globals -- see globals section for more detail
+    'merge_globals' => true,
 
     // The file loaders to load the configs -- see loader section for more detail
     'loaders' => [
@@ -465,6 +468,38 @@ Will be accessed by:
 getenv('test_key_1.test_key_2'); // value
 ```
 
+#### Globals
+
+`Globals` in `Vars` refer to variables defined as such:
+
+```yaml
+_globals:
+    test_key_1: test_value_1
+```
+
+Basically they are just encapsulated in an `_globals` array -- the use of these are so you can access them from `getGlobals()` from `Vars`
+
+The default action is to merge them into the other file contents, so that:
+
+```yaml
+_globals:
+    test_key_1: test_value_1
+test_key_2: test_value_2
+```
+
+Becomes:
+```php
+[
+    'test_key_1' => 'test_value_1',
+    'test_key_2' => 'test_value_2',
+]
+```
+But you can override this by changing `merge_globals` to `false` via the options.
+
+If this doesn't make sense then you probably won't need to use globals at all, but they're useful for working with framesworks
+which encapsulate everything under say `$app` and you want to be able to access some key => values like so: `$app['test_key_1']`. 
+See the Silex provider section for more examples.
+
 #### Caching
 
 Vars automatically caches the resources for 5 minutes, you can turn this off by setting the `cache` option to `false`.
@@ -554,7 +589,7 @@ $vars = new Vars(__DIR__.'/config/config.yml', [
 
 It's pretty straightforward to use this library with Silex, just register it when you register other service providers:
 ```php
-$app->register(new M1\Vars\Provider\Silex\VarsServiceProvider(__DIR__.'/../../app/config/example.yml'), [
+$app->register(new M1\Vars\Provider\Silex\VarsServiceProvider('example.yml'), [
     'vars.path' => __DIR__.'/../../app/config/test/',
     'vars.options' => [
         'cache' => true,
@@ -567,6 +602,7 @@ $app->register(new M1\Vars\Provider\Silex\VarsServiceProvider(__DIR__.'/../../ap
             'yml',
             'json'
         ],
+        'merge_globals' => true,
         'replacements' => __DIR__.'/../../app/config/replacements.json',
     ]]);
 ```
@@ -588,6 +624,31 @@ $app['vars']['test_key_1.test_key_2']; // value
 $app['vars']['test_key_3']; // value
 ```
 
+You can also merge globals into `$app` like so:
+
+```yaml
+# example.yml
+_globals:
+    monolog.logfile: log.log
+test_key_1: test_value_2
+```
+
+```php
+$app->register(new M1\Vars\Provider\Silex\VarsServiceProvider('example.yml'));
+
+// register monolog here and other service providers
+
+$app['vars.merge']();
+```
+
+Note the `$app['vars.merge']()` -- This overrides the service provider defaults so in this example `monolog` will use 
+the log file defined in the vars config.
+
+You must call `vars.merge` after you've called the service providers you provide config values for in your config.
+
+You can also access `test_key_1` via `$app['vars.test_key_1']` and similary if you want, you can access globals like so
+`$app['monolog.logfile']`.
+
 ## Public API
 
 ### Vars
@@ -694,6 +755,9 @@ $vars->toDots();
 # ]
 ```
 
+##### `getGlobals()`
+
+Gets the values defined in `_globals`
 
 ##### `set($key, $value)`
 Set a config key:

src/Cache/CacheProvider.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Loader/AbstractLoader.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Loader/DirectoryLoader.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Loader/EnvLoader.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Loader/IniLoader.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Loader/JsonLoader.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Loader/LoaderProvider.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Loader/PhpLoader.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Loader/TomlLoader.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Loader/XmlLoader.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Loader/YamlLoader.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Provider/Silex/VarsServiceProvider.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE
@@ -46,7 +46,8 @@ class VarsServiceProvider implements ServiceProviderInterface
         'cache_path',
         'cache_expire',
         'loaders',
-        'replacements'
+        'replacements',
+        'merge_globals',
     );
 
     /**
@@ -69,6 +70,22 @@ public function register(Application $app)
         $app['vars'] = function ($app) {
             return new Vars($this->entity, $this->createOptions($app));
         };
+
+        $app['vars.merge'] = $app->protect(function () use ($app) {
+            static $initialized = false;
+            if ($initialized) {
+                return;
+            }
+            $initialized = true;
+
+            foreach ($app['vars']->getGlobals() as $key => $value) {
+                $app[$key] = $value;
+            }
+
+            foreach ($app['vars']->toDots(false) as $key => $value) {
+                $app['vars.'.$key] = $value;
+            }
+        });
     }
 
     /**
@@ -90,6 +107,10 @@ private function createOptions($app)
             $options = $this->createKeyedOptions($options, $app['vars.options']);
         }
 
+        if (!isset($options['merge_globals']) || is_null($options['merge_globals'])) {
+            $options['merge_globals'] = false;
+        }
+
         if (isset($app['debug']) && $app['debug']) {
             $options['cache'] = false;
         }

src/Resource/AbstractResource.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Resource/FileResource.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Resource/ResourceProvider.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Traits/FileTrait.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Traits/PathTrait.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Traits/ResourceFlagsTrait.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE

src/Traits/TransformerTrait.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  *
  * @package     m1/vars
- * @version     1.0.0
+ * @version     1.1.0
  * @author      Miles Croxford <[email protected]>
  * @copyright   Copyright (c) Miles Croxford <[email protected]>
  * @license     http://github.com/m1/vars/blob/master/LICENSE
@@ -25,7 +25,6 @@
  */
 trait TransformerTrait
 {
-
     /**
      * Makes it so the content is available in getenv()
      */
@@ -43,28 +42,34 @@ public function toEnv()
     /**
      * Converts the array into a flat dot notation array
      *
+     * @param bool $flatten_array Flatten arrays into none existent keys
+     *
      * @return array The dot notation array
      */
-    public function toDots()
+    public function toDots($flatten_array = true)
     {
-        return (!is_null($this->content)) ? $this->dotTransformer($this->content) : $this->content;
+        return (!is_null($this->content)) ? $this->dotTransformer($this->content, $flatten_array) : $this->content;
     }
 
     /**
      * Converts the array into a flat dot notation array
      *
-     * @param array  $content The content array
-     * @param string $prefix  The prefix for the key
+     * @param array  $content       The content array
+     * @param bool   $flatten_array Flatten arrays into none existent keys
+     * @param string $prefix        The prefix for the key
      *
      * @return array The dot notation array
      */
-    private function dotTransformer($content, $prefix = '')
+    private function dotTransformer($content, $flatten_array, $prefix = '')
     {
         $parsed = array();
-
         foreach ($content as $arr_k => $arr_v) {
             if (is_array($arr_v)) {
-                $parsed = array_merge($parsed, $this->dotTransformer($arr_v, $prefix.$arr_k."."));
+                if (!$flatten_array) {
+                    $parsed[$prefix.$arr_k] = $arr_v;
+                }
+
+                $parsed = array_merge($parsed, $this->dotTransformer($arr_v, $flatten_array, $prefix.$arr_k."."));
             } else {
                 $parsed[$prefix.$arr_k] = $arr_v;
             }