Implemented Collection::toList() to avoid confusion when getting results

cakephp · Jan 4, 2015 · 1662f2e · 1662f2e
1 parent 7f5d029
commit 1662f2e
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/src/Collection/CollectionInterface.php b/src/Collection/CollectionInterface.php
@@ -625,6 +625,7 @@ public function nest($idPath, $parentPath);
      * @return \Cake\Collection\CollectionInterface
      */
     public function insert($path, $values);
+
     /**
      * Returns an array representation of the results
      *
@@ -636,6 +637,14 @@ public function insert($path, $values);
      */
     public function toArray($preserveKeys = true);
 
+    /**
+     * Returns an numerically-indexed array representation of the results.
+     * This is equivalent to calling `toArray(false)`
+     *
+     * @return array
+     */
+    public function toList();
+
     /**
      * Convert a result set into JSON.
      *

diff --git a/src/Collection/CollectionTrait.php b/src/Collection/CollectionTrait.php
@@ -414,6 +414,15 @@ public function toArray($preserveKeys = true)
         return iterator_to_array($this, $preserveKeys);
     }
 
+    /**
+     * {@inheritDoc}
+     *
+     */
+    public function toList()
+    {
+        return iterator_to_array($this, false);
+    }
+
     /**
      * {@inheritDoc}
      *

diff --git a/tests/TestCase/Collection/CollectionTest.php b/tests/TestCase/Collection/CollectionTest.php
@@ -528,6 +528,18 @@ public function testToArray()
         $this->assertEquals($data, $collection->toArray());
     }
 
+    /**
+     * Test toList method
+     *
+     * @return void
+     */
+    public function testToList()
+    {
+        $data = [100 => 1, 300 => 2, 500 => 3, 1 => 4];
+        $collection = new Collection($data);
+        $this->assertEquals(array_values($data), $collection->toList());
+    }
+
     /**
      * Test json enconding
      *