Merge pull request #61 from mvar/update_to_array_structure

Include query type in query's toArray() response

CHANGELOG.md

@@ -6,6 +6,7 @@ v2.0.0 (2016-x)
 
 - [BC break] Aggregation name is not prefixed anymore
 - [BC break] Removed all filters and filtered query
+- [BC break] Query's `toArray()` now returns array WITH query type
 
 v1.1.1 (2016-01-26)
 ---

src/Aggregation/FilterAggregation.php

@@ -68,9 +68,7 @@ class FilterAggregation extends AbstractAggregation
             throw new \LogicException("Filter aggregation `{$this->getName()}` has no filter added");
         }
 
-        $filterData = [$this->filter->getType() => $this->filter->toArray()];
-
-        return $filterData;
+        return $this->filter->toArray();
     }
 
     /**

src/Aggregation/TopHitsAggregation.php

@@ -125,12 +125,15 @@ class TopHitsAggregation extends AbstractAggregation
      */
     public function getArray()
     {
+        $output = $this->getSort() ? $this->getSort()->toArray() : [];
         $output = array_filter(
-            [
-                'sort' => $this->getSort() ? $this->getSort()->toArray() : null,
-                'size' => $this->getSize(),
-                'from' => $this->getFrom(),
-            ],
+            array_merge(
+                $output,
+                [
+                    'size' => $this->getSize(),
+                    'from' => $this->getFrom(),
+                ]
+            ),
             function ($val) {
                 return (($val || is_array($val) || ($val || is_numeric($val))));
             }

src/BuilderInterface.php

@@ -19,10 +19,7 @@ interface BuilderInterface
     /**
      * Generates array which will be passed to elasticsearch-php client.
      *
-     * WARNING: the output of this method will change in version v2.0. It will
-     * always return array WITH query/aggregation type as key.
-     *
-     * @return array|object
+     * @return array
      */
     public function toArray();
 

src/Query/BoolQuery.php

@@ -41,18 +41,6 @@ class BoolQuery implements BuilderInterface
         $this->container = [];
     }
 
-    /**
-     * Checks if bool expression is relevant.
-     *
-     * @return bool
-     *
-     * @deprecated Will be removed in 2.0. No replacement. Always use full structure.
-     */
-    public function isRelevant()
-    {
-        return true;
-    }
-
     /**
      * @param  null $boolType
      * @return array
@@ -103,16 +91,23 @@ class BoolQuery implements BuilderInterface
      */
     public function toArray()
     {
+        if (count($this->container) === 1 && isset($this->container[self::MUST])
+                && count($this->container[self::MUST]) === 1) {
+            $query = reset($this->container[self::MUST]);
+
+            return $query->toArray();
+        }
+
         $output = [];
 
         foreach ($this->container as $boolType => $builders) {
             /** @var BuilderInterface $builder */
             foreach ($builders as $builder) {
-                $output[$boolType][] = [$builder->getType() => $builder->toArray()];
+                $output[$boolType][] = $builder->toArray();
             }
         }
 
-        return $output;
+        return [$this->getType() => $output];
     }
 
     /**

src/Query/BoostingQuery.php

@@ -59,11 +59,11 @@ class BoostingQuery implements BuilderInterface
     public function toArray()
     {
         $query = [
-            'positive' => [$this->positive->getType() => $this->positive->toArray()],
-            'negative' => [$this->negative->getType() => $this->negative->toArray()],
+            'positive' => $this->positive->toArray(),
+            'negative' => $this->negative->toArray(),
             'negative_boost' => $this->negativeBoost,
         ];
 
-        return $query;
+        return [$this->getType() => $query];
     }
 }

src/Query/CommonTermsQuery.php

@@ -64,6 +64,6 @@ class CommonTermsQuery implements BuilderInterface
             $this->field => $this->processArray($query),
         ];
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/ConstantScoreQuery.php

@@ -50,13 +50,11 @@ class ConstantScoreQuery implements BuilderInterface
     public function toArray()
     {
         $query = [
-            'filter' => [
-                $this->query->getType() => $this->query->toArray(),
-            ],
+            'filter' => $this->query->toArray(),
         ];
 
         $output = $this->processArray($query);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/DisMaxQuery.php

@@ -65,10 +65,10 @@ class DisMaxQuery implements BuilderInterface
     {
         $query = [];
         foreach ($this->queries as $type) {
-            $query['queries'][] = [$type->getType() => $type->toArray()];
+            $query = array_merge($query, $type->toArray());
         }
-        $output = $this->processArray($query);
+        $output = $this->processArray(['queries' => $query]);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/ExistsQuery.php

@@ -49,7 +49,9 @@ class ExistsQuery implements BuilderInterface
     public function toArray()
     {
         return [
-            'field' => $this->field,
+            $this->getType() => [
+                'field' => $this->field,
+            ],
         ];
     }
 }

src/Query/FunctionScoreQuery.php

@@ -15,17 +15,15 @@ use ONGR\ElasticsearchDSL\BuilderInterface;
 use ONGR\ElasticsearchDSL\ParametersTrait;
 
 /**
- * Elasticsearch function_score query class.
+ * Represents Elasticsearch "function_score" query.
+ *
+ * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html
  */
 class FunctionScoreQuery implements BuilderInterface
 {
     use ParametersTrait;
 
     /**
-     * Query of filter.
-     *
-     * In Function score could be used query or filter. Use setDslType() to change type.
-     *
      * @var BuilderInterface
      */
     private $query;
@@ -62,9 +60,7 @@ class FunctionScoreQuery implements BuilderInterface
     private function applyQuery(array &$function, BuilderInterface $query = null)
     {
         if ($query) {
-            $function['query'] = [
-                $query->getType() => $query->toArray(),
-            ];
+            $function['query'] = $query->toArray();
         }
     }
 
@@ -222,14 +218,12 @@ class FunctionScoreQuery implements BuilderInterface
     public function toArray()
     {
         $query = [
-            'query' => [
-                $this->query->getType() => $this->query->toArray(),
-            ],
+            'query' => $this->query->toArray(),
             'functions' => $this->functions,
         ];
 
         $output = $this->processArray($query);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/FuzzyLikeThisFieldQuery.php

-<?php
-
-/*
- * This file is part of the ONGR package.
- *
- * (c) NFQ Technologies UAB <info@nfq.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace ONGR\ElasticsearchDSL\Query;
-
-use ONGR\ElasticsearchDSL\BuilderInterface;
-use ONGR\ElasticsearchDSL\ParametersTrait;
-
-/**
- * Elasticsearch fuzzy_like_this_field query class.
- */
-class FuzzyLikeThisFieldQuery implements BuilderInterface
-{
-    use ParametersTrait;
-
-    /**
-     * @var string
-     */
-    private $field;
-
-    /**
-     * @var string
-     */
-    private $likeText;
-
-    /**
-     * @param string $field
-     * @param string $likeText
-     * @param array  $parameters
-     */
-    public function __construct($field, $likeText, array $parameters = [])
-    {
-        $this->field = $field;
-        $this->likeText = $likeText;
-        $this->setParameters($parameters);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getType()
-    {
-        return 'fuzzy_like_this_field';
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function toArray()
-    {
-        $query = [
-            'like_text' => $this->likeText,
-        ];
-
-        $output = [
-            $this->field => $this->processArray($query),
-        ];
-
-        return $output;
-    }
-}

src/Query/FuzzyLikeThisQuery.php

-<?php
-
-/*
- * This file is part of the ONGR package.
- *
- * (c) NFQ Technologies UAB <info@nfq.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace ONGR\ElasticsearchDSL\Query;
-
-use ONGR\ElasticsearchDSL\BuilderInterface;
-use ONGR\ElasticsearchDSL\ParametersTrait;
-
-/**
- * Elasticsearch fuzzy_like_this query class.
- */
-class FuzzyLikeThisQuery implements BuilderInterface
-{
-    use ParametersTrait;
-
-    /**
-     * @var string[]
-     */
-    private $fields;
-
-    /**
-     * @var string
-     */
-    private $likeText;
-
-    /**
-     * @param string|string[] $fields     Multiple fields can be set via comma or just an array.
-     * @param string          $likeText
-     * @param array           $parameters
-     */
-    public function __construct($fields, $likeText, array $parameters = [])
-    {
-        if (!is_array($fields)) {
-            $fields = explode(',', $fields);
-        }
-
-        $this->fields = $fields;
-        $this->likeText = $likeText;
-        $this->setParameters($parameters);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getType()
-    {
-        return 'fuzzy_like_this';
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function toArray()
-    {
-        $output = [
-            'fields' => $this->fields,
-            'like_text' => $this->likeText,
-        ];
-
-        return $this->processArray($output);
-    }
-}

src/Query/FuzzyQuery.php

@@ -64,6 +64,6 @@ class FuzzyQuery implements BuilderInterface
             $this->field => $this->processArray($query),
         ];
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/GeoBoundingBoxQuery.php

@@ -80,6 +80,6 @@ class GeoBoundingBoxQuery implements BuilderInterface
 
         $output = $this->processArray($query);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/GeoDistanceQuery.php

@@ -72,6 +72,6 @@ class GeoDistanceQuery implements BuilderInterface
         ];
         $output = $this->processArray($query);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/GeoDistanceRangeQuery.php

@@ -69,6 +69,6 @@ class GeoDistanceRangeQuery implements BuilderInterface
         $query = $this->range + [$this->field => $this->location];
         $output = $this->processArray($query);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/GeoPolygonQuery.php

@@ -61,6 +61,6 @@ class GeoPolygonQuery implements BuilderInterface
         $query = [$this->field => ['points' => $this->points]];
         $output = $this->processArray($query);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/GeoShapeQuery.php

@@ -97,6 +97,6 @@ class GeoShapeQuery implements BuilderInterface
     {
         $output = $this->processArray($this->fields);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/GeohashCellQuery.php

@@ -62,6 +62,6 @@ class GeohashCellQuery implements BuilderInterface
         $query = [$this->field => $this->location];
         $output = $this->processArray($query);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }