Allow using Traversable objects to define routes

weierophinney · weierophinney · commit f0e5f4bdb7b9 · 2011-10-14T12:05:52.000-05:00
- Added Zend\Stdlib\IteratorToArray class for recursive conversion of
  iterators to arrays
- Updated factory() signatures, addRoutes() signatures, and
  routeFromArray() implementations to allow both arrays and
  Traversables; consues IteratorToArray for conversions when necessary
- Changes will allow using Zend\Config objects directly in factories
diff --git a/src/IteratorToArray.php b/src/IteratorToArray.php
@@ -0,0 +1,63 @@
+<?php
+
+namespace Zend\Stdlib;
+
+use Traversable;
+
+/**
+ * Convert an iterator to an array, recursively
+ *
+ * Declared abstract, as we have no need for instantiation.
+ */
+abstract class IteratorToArray
+{
+    /**
+     * Convert an iterator to an array, recursively
+     *
+     * Converts an iterator to an array. The $recursive flag, on by default, 
+     * hints whether or not you want to do so recursively.
+     *
+     * @param  array|Traversable $iterator 
+     * @return array
+     */
+    public static function convert($iterator, $recursive = true)
+    {
+        if (!is_array($iterator) && !$iterator instanceof Traversable) {
+            throw new Exception\InvalidArgumentException(__METHOD__ . ' expects an array or Traversable object');
+        }
+
+        if (!$recursive) {
+            if (is_array($iterator)) {
+                return $iterator;
+            }
+
+            return iterator_to_array($iterator);
+        }
+
+        if (method_exists($iterator, 'toArray')) {
+            return $iterator->toArray();
+        }
+
+        $array = array();
+        foreach ($iterator as $key => $value) {
+            if (is_scalar($value)) {
+                $array[$key] = $value;
+                continue;
+            }
+
+            if ($value instanceof Traversable) {
+                $array[$key] = static::convert($value, $recursive);
+                continue;
+            }
+
+            if (is_array($value)) {
+                $array[$key] = static::convert($value, $recursive);
+                continue;
+            }
+
+            $array[$key] = $value;
+        }
+
+        return $array;
+    }
+}
diff --git a/test/IteratorToArrayTest.php b/test/IteratorToArrayTest.php
@@ -0,0 +1,90 @@
+<?php
+
+namespace ZendTest\Stdlib;
+
+use ArrayObject,
+    PHPUnit_Framework_TestCase as TestCase,
+    stdClass,
+    Zend\Config\Config,
+    Zend\Stdlib\IteratorToArray;
+
+class IteratorToArrayTest extends TestCase
+{
+    public static function validIterators()
+    {
+        return array(
+            array(array(
+                'foo' => 'bar',
+            ), array(
+                'foo' => 'bar',
+            )),
+            array(new Config(array(
+                'foo' => array(
+                    'bar' => array(
+                        'baz' => array(
+                            'baz' => 'bat',
+                        ),
+                    ),
+                ),
+            )), array(
+                'foo' => array(
+                    'bar' => array(
+                        'baz' => array(
+                            'baz' => 'bat',
+                        ),
+                    ),
+                ),
+            )),
+            array(new ArrayObject(array(
+                'foo' => array(
+                    'bar' => array(
+                        'baz' => array(
+                            'baz' => 'bat',
+                        ),
+                    ),
+                ),
+            )), array(
+                'foo' => array(
+                    'bar' => array(
+                        'baz' => array(
+                            'baz' => 'bat',
+                        ),
+                    ),
+                ),
+            )),
+        );
+    }
+
+    public static function invalidIterators()
+    {
+        return array(
+            array(null),
+            array(true),
+            array(false),
+            array(0),
+            array(1),
+            array(0.0),
+            array(1.0),
+            array('string'),
+            array(new stdClass),
+        );
+    }
+
+    /**
+     * @dataProvider validIterators
+     */
+    public function testValidIteratorsReturnArrayRepresentation($test, $expected)
+    {
+        $result = IteratorToArray::convert($test);
+        $this->assertEquals($expected, $result);
+    }
+
+    /**
+     * @dataProvider invalidIterators
+     */
+    public function testInvalidIteratorsRaiseInvalidArgumentException($test)
+    {
+        $this->setExpectedException('Zend\Stdlib\Exception\InvalidArgumentException');
+        $this->assertFalse(IteratorToArray::convert($test));
+    }
+}
