Merge pull request #93 from K-Phoen/improve-doc

Improve doc

doc/cookbooks/doctrine_orm.md

@@ -83,7 +83,9 @@ $playersQueryBuilder = $entityManager
 
 $rule = '"ROLE_ADMIN" IN group.roles';
 
-var_dump($rulerz->filter($playersQueryBuilder, $rule));
+var_dump(
+    iterator_to_array($rulerz->filter($playersQueryBuilder, $rule))
+);
 ```
 
 It's important to notice that `group` is not an ordinary attribute: it's another
@@ -104,7 +106,9 @@ $playersQueryBuilder = $entityManager
 
 $rule = '"ROLE_ADMIN" IN g.roles';
 
-var_dump($rulerz->filter($playersQueryBuilder, $rule));
+var_dump(
+    iterator_to_array($rulerz->filter($playersQueryBuilder, $rule))
+);
 ```
 
 This time, RulerZ is smart enough to understand that `g` might be a joined

doc/cookbooks/elastic_elasticsearch_php.md

@@ -65,7 +65,9 @@ $executionContext = [
     'type'  => 'type_name',
 ];
 
-var_dump($rulerz->filter($client, $rule, $parameters, $executionContext));
+var_dump(
+    iterator_to_array($rulerz->filter($client, $rule, $parameters, $executionContext))
+);
 ```
 
 **N.B**: you'll notice an unusual variable named `$executionContext`. It

doc/cookbooks/eloquent_orm.md

@@ -55,9 +55,11 @@ $parameters = [
     'gender' => 'M',
 ];
 
-var_dump($rulerz->filter($queryBuilder, $rule, $parameters));
+var_dump(
+    iterator_to_array($rulerz->filter($queryBuilder, $rule, $parameters))
+);
 ```
 
 ## That was it!
 
-[Return to the index to explore the other possibilities of the library](../index.md)
+[Return to the index to explore the other possibilities of the library](../index.md)

doc/cookbooks/pomm.md

@@ -56,9 +56,11 @@ $parameters = [
     'gender' => 'M',
 ];
 
-var_dump($rulerz->filter($playerModel, $rule, $parameters));
+var_dump(
+    iterator_to_array($rulerz->filter($playerModel, $rule, $parameters))
+);
 ```
 
 ## That was it!
 
-[Return to the index to explore the other possibilities of the library](../index.md)
+[Return to the index to explore the other possibilities of the library](../index.md)

doc/cookbooks/ruflin_elastica.md

@@ -69,7 +69,9 @@ $parameters = [
     'gender' => 'M',
 ];
 
-var_dump($rulerz->filter($search, $rule, $parameters));
+var_dump(
+    iterator_to_array($rulerz->filter($search, $rule, $parameters))
+);
 ```
 
 ## That was it!

doc/cookbooks/solarium.md

@@ -68,7 +68,9 @@ $parameters = [
     'gender' => 'M',
 ];
 
-var_dump($rulerz->filter($client, $rule, $parameters));
+var_dump(
+    iterator_to_array($rulerz->filter($client, $rule, $parameters))
+);
 ```
 
 ## That was it!

doc/filter.md

@@ -5,7 +5,9 @@ This guide will show you how to filter any kind of target using a simple languag
 
 Here is a summary of what you will have to do:
 
- * [instantiate the RulerZ engine](writing_rules.md#step-1-instantiate-the-rulerz-engine) ;
+ * [instantiate the RulerZ engine](writing_rules.md#step-1-instantiate-the-rulerz-engine)
+   and be sure to **include an instance of `\RulerZ\Target\Native\Native` to the
+   compilation targets** ;
  * [write a rule](writing_rules.md#step-2-write-a-rule) ;
  * [filter your target](#filter-your-target).
 
@@ -21,6 +23,9 @@ $users = [
 ];
 ```
 
+**Note:** RulerZ will work the same way, whether you want to filter a collection
+of arrays or a collection of objects.
+
 ## Filter your target
 
 Let's say that we want to retrieve the female players having at least 30 points.
@@ -44,7 +49,11 @@ Once the rule is written and the parameters are defined, only the easiest part
 remains: filtering the target.
 
 ```php
-var_dump($rulerz->filter($players, $rule, $parameters)); // the parameters can be omitted if empty
+var_dump(
+    iterator_to_array(
+        $rulerz->filter($players, $rule, $parameters) // the parameters can be omitted if empty
+    )
+);
 
 // will return:
 /*

doc/index.md

@@ -26,6 +26,7 @@ composer require 'kphoen/rulerz'
 
 ## Cookbooks
 
+ * [Using native PHP arrays or objects](filter.md)
  * [Using Doctrine ORM](cookbooks/doctrine_orm.md)
  * [Using Pomm](cookbooks/pomm.md)
  * [Using Elasticsearch and ruflin/Elastica](cookbooks/ruflin_elastica.md)

src/Parser/Parser.php

@@ -118,6 +118,7 @@ public function visit(Visitor\Element $element, &$handle = null, $eldnah = null)
                     switch ($child->getId()) {
                         case '#attribute_access':
                             $name->attribute($_child);
+
                             break;
                     }
                 }

tests/features/bootstrap/BaseContext.php

@@ -54,13 +54,13 @@ public function __construct()
         $this->initialize();
     }
 
-     /**
-      * @BeforeSuite
-      */
-     public static function prepare(BeforeSuiteScope $scope)
-     {
-         echo 'Current suite: '.$scope->getSuite()->getName();
-     }
+    /**
+     * @BeforeSuite
+     */
+    public static function prepare(BeforeSuiteScope $scope)
+    {
+        echo 'Current suite: '.$scope->getSuite()->getName();
+    }
 
     /**
      * Will be called right after the construction of the context, useful to