Merge branch 'feature/config' of https://github.com/denixport/zf2 int…

…o hotfix/config-i18n
zendframework · Jul 2, 2012 · 70ca2ff · 70ca2ff
commit 70ca2ff
Show file tree

Hide file tree

Showing 47 changed files with 686 additions and 682 deletions.
diff --git a/src/Config.php b/src/Config.php
@@ -1,36 +1,30 @@
 <?php
 /**
- * Zend Framework
+ * Zend Framework (http://framework.zend.com/)
  *
- * LICENSE
- *
- * This source file is subject to the new BSD license that is bundled
- * with this package in the file LICENSE.txt.
- * It is also available through the world-wide-web at this URL:
- * http://framework.zend.com/license/new-bsd
- * If you did not receive a copy of the license and are unable to
- * obtain it through the world-wide-web, please send an email
- * to license@zend.com so we can send you a copy immediately.
- *
- * @category   Zend
- * @package    Zend_Config
- * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @package   Zend_Config
  */
 
 namespace Zend\Config;
 
 use Countable;
 use Iterator;
-use ArrayAccess,
-    Zend\Stdlib\ArrayUtils
-;
+use ArrayAccess;
+use Zend\Stdlib\ArrayUtils;
 
 /**
+ * Provides a property based interface to an array.
+ * The data are read-only unless $allowModifications is set to true
+ * on construction.
+ *
+ * Implements Countable, Iterator and ArrayAccess
+ * to facilitate easy access to the data.
+ *
  * @category   Zend
  * @package    Zend_Config
- * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 class Config implements Countable, Iterator, ArrayAccess
 {
@@ -64,16 +58,13 @@ class Config implements Countable, Iterator, ArrayAccess
     protected $skipNextIteration;
 
     /**
-     * Zend_Config provides a property based interface to
-     * an array. The data are read-only unless $allowModifications
-     * is set to true on construction.
+     * Constructor.
      *
-     * Zend_Config also implements Countable, Iterator and ArrayAccess to
-     * facilitate easy access to the data.
+     * Data is read-only unless $allowModifications is set to true
+     * on construction.
      *
      * @param  array   $array
      * @param  boolean $allowModifications
-     * @return void
      */
     public function __construct(array $array, $allowModifications = false)
     {
@@ -126,6 +117,7 @@ public function __get($name)
      * @param  string $name
      * @param  mixed  $value
      * @return void
+     * @throws Exception\RuntimeException
      */
     public function __set($name, $value)
     {
@@ -173,6 +165,7 @@ public function toArray()
         $array = array();
         $data  = $this->data;
 
+        /** @var self $value */
         foreach ($data as $key => $value) {
             if ($value instanceof self) {
                 $array[$key] = $value->toArray();
@@ -200,6 +193,7 @@ public function __isset($name)
      *
      * @param  string $name
      * @return void
+     * @throws Exception\InvalidArgumentException
      */
     public function __unset($name)
     {
@@ -342,11 +336,12 @@ public function offsetUnset($offset)
      * - Items in $merge with INTEGER keys will be appended.
      * - Items in $merge with STRING keys will overwrite current values.
      *
-     * @param  Config $replace
+     * @param  Config $merge
      * @return Config
      */
     public function merge(self $merge)
     {
+        /** @var Config $value */
         foreach ($merge as $key => $value) {
             if (array_key_exists($key, $this->data)) {
                 if (is_int($key)) {
@@ -384,6 +379,7 @@ public function setReadOnly()
     {
         $this->allowModifications = false;
 
+        /** @var Config $value */
         foreach ($this->data as $value) {
             if ($value instanceof self) {
                 $value->setReadOnly();

diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php
@@ -1,30 +1,19 @@
 <?php
 /**
- * Zend Framework
+ * Zend Framework (http://framework.zend.com/)
  *
- * LICENSE
- *
- * This source file is subject to the new BSD license that is bundled
- * with this package in the file LICENSE.txt.
- * It is also available through the world-wide-web at this URL:
- * http://framework.zend.com/license/new-bsd
- * If you did not receive a copy of the license and are unable to
- * obtain it through the world-wide-web, please send an email
- * to license@zend.com so we can send you a copy immediately.
- *
- * @category   Zend
- * @package    Zend_Config
- * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @package   Zend_Config
  */
 
 namespace Zend\Config\Exception;
 
 /**
  * @category   Zend
  * @package    Zend_Config
- * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @subpackage Exception
  */
 interface ExceptionInterface
 {}
diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -1,31 +1,19 @@
 <?php
 /**
- * Zend Framework
+ * Zend Framework (http://framework.zend.com/)
  *
- * LICENSE
- *
- * This source file is subject to the new BSD license that is bundled
- * with this package in the file LICENSE.txt.
- * It is also available through the world-wide-web at this URL:
- * http://framework.zend.com/license/new-bsd
- * If you did not receive a copy of the license and are unable to
- * obtain it through the world-wide-web, please send an email
- * to license@zend.com so we can send you a copy immediately.
- *
- * @category  Zend
- * @package   Zend_Config
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd     New BSD License
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @package   Zend_Config
  */
 
 namespace Zend\Config\Exception;
 
 /**
- * @category  Zend
- * @package   Zend_Config
- * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd     New BSD License
+ * @category   Zend
+ * @package    Zend_Config
+ * @subpackage Exception
  */
-class InvalidArgumentException extends \InvalidArgumentException implements 
-    ExceptionInterface
+class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
 {}
diff --git a/src/Exception/RuntimeException.php b/src/Exception/RuntimeException.php
@@ -1,30 +1,19 @@
 <?php
 /**
- * Zend Framework
+ * Zend Framework (http://framework.zend.com/)
  *
- * LICENSE
- *
- * This source file is subject to the new BSD license that is bundled
- * with this package in the file LICENSE.txt.
- * It is also available through the world-wide-web at this URL:
- * http://framework.zend.com/license/new-bsd
- * If you did not receive a copy of the license and are unable to
- * obtain it through the world-wide-web, please send an email
- * to license@zend.com so we can send you a copy immediately.
- *
- * @category  Zend
- * @package   Zend_Config
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd     New BSD License
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @package   Zend_Config
  */
 
 namespace Zend\Config\Exception;
 
 /**
- * @category  Zend
- * @package   Zend_Config
- * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd     New BSD License
+ * @category   Zend
+ * @package    Zend_Config
+ * @subpackage Exception
  */
 class RuntimeException extends \RuntimeException implements ExceptionInterface
 {}
diff --git a/src/Factory.php b/src/Factory.php
@@ -1,53 +1,52 @@
 <?php
 /**
- * Zend Framework
+ * Zend Framework (http://framework.zend.com/)
  *
- * LICENSE
- *
- * This source file is subject to the new BSD license that is bundled
- * with this package in the file LICENSE.txt.
- * It is also available through the world-wide-web at this URL:
- * http://framework.zend.com/license/new-bsd
- * If you did not receive a copy of the license and are unable to
- * obtain it through the world-wide-web, please send an email
- * to license@zend.com so we can send you a copy immediately.
- *
- * @category  Zend
- * @package   Zend_Config
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd     New BSD License
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @package   Zend_Config
  */
 
 namespace Zend\Config;
 
 use Zend\Stdlib\ArrayUtils;
 
 /**
- * Declared abstract to prevent instantiation
- * 
  * @category  Zend
  * @package   Zend_Config
- * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd     New BSD License
  */
-abstract class Factory
+class Factory
 {
     /**
-     * Readers used for config files.
+     * Plugin manager for loading readers
+     *
+     * @var null|ReaderPluginManager
+     */
+    public static $readers = null;
+
+    /**
+     * Registered config file extensions.
+     * key is extension, value is reader instance or plugin name
      *
      * @var array
      */
-    protected static $readers = array(
-        'ini' => 'Ini',
-        'xml' => 'Xml'
+    protected static $extensions = array(
+        'ini'  => 'ini',
+        'json' => 'json',
+        'xml'  => 'xml',
+        'yaml' => 'yaml',
     );
 
+
     /**
      * Read a config from a file.
      *
      * @param  string  $filename
      * @param  boolean $returnConfigObject 
      * @return array|Config
+     * @throws Exception\InvalidArgumentException
+     * @throws Exception\RuntimeException
      */
     public static function fromFile($filename, $returnConfigObject = false)
     {
@@ -64,17 +63,22 @@ public static function fromFile($filename, $returnConfigObject = false)
 
         if ($extension === 'php') {
             if (!is_file($filename) || !is_readable($filename)) {
-                throw new Exception\RuntimeException(sprintf('Filename "%s" is either not a file or not readable', $filename));
+                throw new Exception\RuntimeException(sprintf(
+                    "File '%s' doesn't exist or not readable",
+                    $filename
+                ));
             }
 
             $config = include $filename;
-        } elseif (isset(self::$readers[$extension])) {
-            if (is_string(self::$readers[$extension])) {
-                $classname = __NAMESPACE__ . '\\Reader\\' . self::$readers[$extension];
-                self::$readers[$extension] = new $classname();
+        } elseif (isset(self::$extensions[$extension])) {
+            $reader = self::$extensions[$extension];
+            if (!$reader instanceof Reader\ReaderInterface) {
+                $reader = self::getReaderPluginManager()->get($reader);
+                self::$extensions[$extension] = $reader;
             }
-
-            $config = self::$readers[$extension]->fromFile($filename);
+
+            /** @var Reader\ReaderInterface $reader  */
+            $config = $reader->fromFile($filename);
         } else {
             throw new Exception\RuntimeException(sprintf(
                 'Unsupported config file extension: .%s',
@@ -102,4 +106,50 @@ public static function fromFiles(array $files, $returnConfigObject = false)
 
         return ($returnConfigObject) ? new Config($config) : $config;
     }
+
+    /**
+     * Set reader plugin manager
+     *
+     * @param ReaderPluginManager $readers
+     */
+    public static function setReaderPluginManager(ReaderPluginManager $readers)
+    {
+        self::$readers = $readers;
+    }
+
+    /**
+     * Get the reader plugin manager
+     *
+     * @return ReaderPluginManager
+     */
+    public static function getReaderPluginManager()
+    {
+        if (static::$readers === null) {
+            static::$readers = new ReaderPluginManager();
+        }
+        return static::$readers;
+    }
+
+    /**
+     * Set config reader for file extension
+     *
+     * @param  string $extension
+     * @param  string|Reader\ReaderInterface $reader
+     * @throws Exception\InvalidArgumentException
+     */
+    public static function registerReader($extension, $reader)
+    {
+        $extension = strtolower($extension);
+
+        if (!is_string($reader) && !$reader instanceof Reader\ReaderInterface) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                'Reader should be plugin name, class name or ' .
+                'instance of %s\Reader\ReaderInterface; recieved "%s"',
+                __NAMESPACE__,
+                (is_object($reader) ? get_class($reader) : gettype($reader))
+            ));
+        }
+
+        self::$extensions[$extension] = $reader;
+    }
 }