getShuffledResults method

Author: Mauro Cassani

README.md

@@ -221,6 +221,20 @@ foreach ($qb->getResults() as $element){
 }
 ```
 
+## Shuffled Results
+
+You can shuffle query results by using `getShuffledResults` method:
+
+```php
+use ArrayQuery\QueryBuilder;
+
+$qb = QueryBuilder::create($array);
+
+foreach ($qb->getShuffledResults() as $element){
+    // ...
+}
+```
+
 ## More examples
 
 Please refer to [QueryBuilderTest](https://github.com/mauretto78/array-query/blob/master/tests/QueryBuilderTest.php) for more examples.

src/QueryBuilder.php

@@ -225,6 +225,22 @@ public function getLastResult()
         return $this->getResults()[$count-1] ?: [];
     }
 
+    /**
+     * @return array
+     */
+    public function getShuffledResults()
+    {
+        $shuffledArray = [];
+        $keys = array_keys($this->getResults());
+        shuffle($keys);
+
+        foreach ($keys as $key) {
+            $shuffledArray[$key] = $this->getResults()[$key];
+        }
+
+        return $shuffledArray;
+    }
+
     /**
      * @param array $array
      *

tests/QueryBuilderTest.php

@@ -617,4 +617,16 @@ public function it_should_get_results_from_a_query_with_aliases()
             $this->assertArrayHasKey('add', $qb->getResults()[1]);
         }
     }
+
+    /**
+     * @test
+     */
+    public function it_should_get_shuffled_results_from_a_query()
+    {
+        foreach ($this->usersArrays as $array) {
+            $qb = QueryBuilder::create($array);
+
+            $this->assertCount(10, $qb->getShuffledResults());
+        }
+    }
 }