Comments

src/DoctrineTransformer.php

@@ -36,6 +36,12 @@ public function setQueryBuilder($queryBuilder)
         $this->queryBuilder = $queryBuilder;
     }
 
+    /**
+     * Modify query builder according to specification
+     *
+     * @param Specification $specification
+     * @return QueryBuilder modified query builder
+     */
     public function transform(Specification $specification)
     {
         $queryBuilder = clone $this->queryBuilder;
@@ -47,14 +53,20 @@ private function getTransformers()
         return $this->transformers;
     }
 
+    /**
+     * Add transformer to collection to use to transform specifications
+     * @param FilterTransformerInterface $transformer
+     */
     public function addTransformer(FilterTransformerInterface $transformer)
     {
         $this->transformers[] = $transformer;
     }
 
     /**
+     * Build where part
      * @param Specification $specification
      * @param $queryBuilder
+     *
      * @return QueryBuilder
      */
     private function addWhere(Specification $specification, $queryBuilder)

src/ParametersBag.php

@@ -4,18 +4,36 @@
 
 class ParametersBag
 {
+    /**
+     * @var array DQL Parameters array
+     */
     private $parameters = [];
 
+    /**
+     * Clears parameters array
+     */
     public function clear()
     {
         $this->parameters = [];
     }
 
+    /**
+     * Returns parameters array
+     *
+     * @return array
+     */
     public function get()
     {
         return $this->parameters;
     }
 
+    /**
+     * Add new parameter to collection and returns it's name
+     *
+     * @param $value mixed parameter value
+     *
+     * @return string DQL Parameter name
+     */
     public function add($value)
     {
         $key = count($this->parameters) + 1;
@@ -24,6 +42,11 @@ public function add($value)
         return '?' . $key;
     }
 
+    /**
+     * Checks whether the parameters array is non empty
+     *
+     * @return bool
+     */
     public function has()
     {
         return (boolean)count($this->parameters);

src/Transformer/ComparisonTransformer.php

@@ -23,11 +23,17 @@ class ComparisonTransformer implements FilterTransformerInterface
      */
     private $queryBuilder;
 
+    /**
+     * @inheritdoc
+     */
     public function setQueryBuilder(QueryBuilder $queryBuilder)
     {
         $this->queryBuilder = $queryBuilder;
     }
 
+    /**
+     * @inheritdoc
+     */
     public function supports(FilterInterface $object)
     {
         if ($object instanceof Comparison) {
@@ -44,6 +50,9 @@ public function supports(FilterInterface $object)
         return false;
     }
 
+    /**
+     * @inheritdoc
+     */
     public function transform(FilterInterface $filter, ParametersBag $parameters)
     {
         if ($filter instanceof Equals) {

src/Transformer/FilterTransformer.php

@@ -16,16 +16,25 @@ class FilterTransformer implements FilterTransformerInterface
      */
     private $queryBuilder;
 
+    /**
+     * @inheritdoc
+     */
     public function setQueryBuilder(QueryBuilder $queryBuilder)
     {
         $this->queryBuilder = $queryBuilder;
     }
 
+    /**
+     * @inheritdoc
+     */
     public function supports(FilterInterface $filter)
     {
         return $filter instanceof IsNotNull || $filter instanceof IsNull;
     }
 
+    /**
+     * @inheritdoc
+     */
     public function transform(FilterInterface $filter, ParametersBag $parameters)
     {
         if ($filter instanceof IsNull) {

src/Transformer/FilterTransformerInterface.php

@@ -8,9 +8,25 @@
 
 interface FilterTransformerInterface
 {
+    /**
+     * Return true when transformer supports class
+     *
+     * @param FilterInterface $filter
+     * @return boolean
+     */
     public function supports(FilterInterface $filter);
 
+    /**
+     * Transform filter to DQL part
+     * @param FilterInterface $filter
+     * @param ParametersBag $parameters
+     *
+     * @return string
+     */
     public function transform(FilterInterface $filter, ParametersBag $parameters);
 
+    /**
+     * @param QueryBuilder $queryBuilder
+     */
     public function setQueryBuilder(QueryBuilder $queryBuilder);
 }