Merge pull request #72 from krzysztof-gzocha/pass-criteria-to-transfo…

…rmer

Pass previous criteria to chain transformer

docs/chain-search.rst

@@ -51,7 +51,7 @@ injected into the ``$statisticSearcher``:
         /**
          * @param mixed $results
          */
-        public function transform($results)
+        public function transform($results, CriteriaCollectionInterface $criteria)
         {
             // Assuming that UserIdsCriteria will holds an array of user IDs
             $userIdsCriteria = new UserIdsCriteria(array_map(
@@ -61,6 +61,8 @@ injected into the ``$statisticSearcher``:
                 $results
             ));
 
+            // We can use some criteria from previous search, but in this scenario we do not need them.
+
             return new CriteriaCollection($userIdsCriteria);
         }
 

src/KGzocha/Searcher/Chain/ChainSearch.php

@@ -59,7 +59,7 @@ public function search(
 
             $previousResults = $cell->getSearcher()->search($previousCriteria);
             if ($cell->hasTransformer()) {
-                $previousCriteria = $cell->getTransformer()->transform($previousResults);
+                $previousCriteria = $cell->getTransformer()->transform($previousResults, $previousCriteria);
             }
 
             if ($cell->getName()) {

src/KGzocha/Searcher/Chain/EndTransformer.php

@@ -2,6 +2,8 @@
 
 namespace KGzocha\Searcher\Chain;
 
+use KGzocha\Searcher\Criteria\Collection\CriteriaCollectionInterface;
+
 /**
  * Use this class to indicate that there is no more searchers in the chain.
  * It is like a NullObject. It does not do much.
@@ -13,7 +15,7 @@ final class EndTransformer implements TransformerInterface
     /**
      * @inheritDoc
      */
-    public function transform($results)
+    public function transform($results, CriteriaCollectionInterface $criteria)
     {
         throw new \RuntimeException(
             'Transform method on EmptyTransformer should never be called.'

src/KGzocha/Searcher/Chain/TransformerInterface.php

@@ -5,7 +5,7 @@
 use KGzocha\Searcher\Criteria\Collection\CriteriaCollectionInterface;
 
 /**
- * Only responsibility of services implementing this interface is to transform results from previous
+ * Only responsibility of services implementing this interface is to transform results and(/or) criteria from previous
  * search to CriteriaCollectionInterface that can be used in next search.
  *
  * @author Krzysztof Gzocha <[email protected]>
@@ -14,10 +14,11 @@ interface TransformerInterface
 {
     /**
      * @param mixed $results
+     * @param CriteriaCollectionInterface $criteria
      *
      * @return CriteriaCollectionInterface
      */
-    public function transform($results);
+    public function transform($results, CriteriaCollectionInterface $criteria);
 
     /**
      * Important! Results might be null when cell will be used as first one.

tests/Chain/EndTransformerTest.php

@@ -3,6 +3,7 @@
 namespace KGzocha\Searcher\Test\Chain;
 
 use KGzocha\Searcher\Chain\EndTransformer;
+use KGzocha\Searcher\Criteria\Collection\CriteriaCollection;
 
 /**
  * @author Krzysztof Gzocha <[email protected]>
@@ -21,6 +22,6 @@ public function testSkipMethod()
     public function testTransformMethod()
     {
         $transformer = new EndTransformer();
-        $transformer->transform([]);
+        $transformer->transform([], new CriteriaCollection());
     }
 }