add span_first query

Author: Alessandro Chitolina

lib/Elastica/Query/AbstractSpanQuery.php

@@ -0,0 +1,11 @@
+<?php
+namespace Elastica\Query;
+
+/**
+ * Abstract query object. Should be extended by all query types.
+ *
+ * @author Alessandro Chitolina <[email protected]>
+ */
+abstract class AbstractSpanQuery extends AbstractQuery
+{
+}

lib/Elastica/Query/SpanFirst.php

@@ -0,0 +1,59 @@
+<?php
+namespace Elastica\Query;
+
+use Elastica\Exception\InvalidException;
+
+/**
+ * SpanFirst query.
+ *
+ * @author Alessandro Chitolina <[email protected]>
+ *
+ * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html
+ */
+class SpanFirst extends AbstractSpanQuery
+{
+    /**
+     * Set the query to be wrapped into the span multi query.
+     *
+     * @param \Elastica\Query\AbstractSpanQuery|array $args Matching query
+     *
+     * @return $this
+     */
+    public function setMatch($args)
+    {
+        return $this->_addQuery('match', $args);
+    }
+
+    /**
+     * Set the maximum end position for the match query.
+     *
+     * @param int $end
+     *
+     * @return $this
+     */
+    public function setEnd($end)
+    {
+        $this->setParam('end', $end);
+
+        return $this;
+    }
+
+    /**
+     * Adds a query to the current object.
+     *
+     * @param string                              $type Query type
+     * @param \Elastica\Query\AbstractQuery|array $args Query
+     *
+     * @throws \Elastica\Exception\InvalidException If not valid query
+     *
+     * @return $this
+     */
+    protected function _addQuery($type, $args)
+    {
+        if (!is_array($args) && !($args instanceof AbstractSpanQuery)) {
+            throw new InvalidException('Invalid parameter. Has to be array or instance of Elastica\Query\AbstractSpanQuery');
+        }
+
+        return $this->setParam($type, $args);
+    }
+}

lib/Elastica/Query/SpanMulti.php

@@ -6,9 +6,11 @@
 /**
  * SpanMulti query.
  *
+ * @author Alessandro Chitolina <[email protected]>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html
  */
-class SpanMulti extends AbstractQuery
+class SpanMulti extends AbstractSpanQuery
 {
     /**
      * Set the query to be wrapped into the span multi query.

lib/Elastica/Query/SpanTerm.php

@@ -4,9 +4,11 @@
 /**
  * SpanTerm query.
  *
+ * @author Alessandro Chitolina <[email protected]>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html
  */
-class SpanTerm extends AbstractQuery
+class SpanTerm extends AbstractSpanQuery
 {
     /**
      * Constructs the SpanTerm query object.

test/Elastica/Query/SpanFirstTest.php

@@ -0,0 +1,30 @@
+<?php
+namespace Elastica\Test\Query;
+
+use Elastica\Query\SpanFirst;
+use Elastica\Query\SpanTerm;
+use Elastica\Test\Base as BaseTest;
+
+class SpanFirstTest extends BaseTest
+{
+    /**
+     * @group unit
+     */
+    public function testToArray()
+    {
+        $query = new SpanFirst();
+        $query->setMatch(new SpanTerm(['user' => 'kimchy']));
+        $query->setEnd(3);
+
+        $data = $query->toArray();
+
+        $this->assertEquals([
+            'span_first' => [
+                'match' => [
+                    'span_term' => ['user' => 'kimchy'],
+                ],
+                'end' => 3,
+            ],
+        ], $data);
+    }
+}

test/Elastica/Query/SpanMultiTest.php

@@ -20,9 +20,9 @@ public function testToArray()
         $this->assertEquals([
             'span_multi' => [
                 'match' => [
-                    'prefix' => ['user' => ['value' => 'ki']]
-                ]
-            ]
+                    'prefix' => ['user' => ['value' => 'ki']],
+                ],
+            ],
         ], $data);
     }
 }