Translate sort and fields attribute to string when using dsl for a transport that doesnt support it

Author: nervetattoo

lib/ElasticSearchDSL.php

@@ -30,12 +30,18 @@ public function __construct(array $dsl) {
      * @return string
      */
     public function __toString() {
-        $dsl = $this->dsl['query'];
+        $dsl = $this->dsl;
+        $query = $dsl['query'];
+
         $string = "";
-        if (array_key_exists("term", $dsl))
-            $string .= $this->transformDSLTermToString($dsl['term']);
-        if (array_key_exists("wildcard", $dsl))
-            $string .= $this->transformDSLTermToString($dsl['wildcard']);
+        if (array_key_exists("term", $query))
+            $string .= $this->transformDSLTermToString($query['term']);
+        if (array_key_exists("wildcard", $query))
+            $string .= $this->transformDSLTermToString($query['wildcard']);
+        if (array_key_exists("sort", $dsl))
+            $string .= $this->transformDSLSortToString($dsl['sort']);
+        if (array_key_exists("fields", $dsl))
+            $string .= $this->transformDSLFieldsToString($dsl['fields']);
         return $string;
     }
 
@@ -51,20 +57,60 @@ protected function transformDSLTermToString($dslTerm) {
         if (is_array($dslTerm)) {
             $key = key($dslTerm);
             $value = $dslTerm[$key];
-
-            /**
-             * If a specific key is used as key in the array
-             * this should translate to searching in a specific field (field:term)
-             */
             if (is_string($key))
                 $string .= "$key:";
-            if (strpos(" ", $value) !== false)
-                $string .= '"' . $value . '"';
-            else
-                $string .= $value;
         }
         else
-            $string .= $dslTerm;
+            $value = $dslTerm;
+        /**
+         * If a specific key is used as key in the array
+         * this should translate to searching in a specific field (field:term)
+         */
+        if (strpos($value, " ") !== false)
+            $string .= '"' . $value . '"';
+        else
+            $string .= $value;
+        return $string;
+    }
+
+    /**
+     * Transform search parameters to string
+     *
+     * @return string
+     * @param mixed $dslSort
+     */
+    protected function transformDSLSortToString($dslSort) {
+        $string = "";
+        if (is_array($dslSort)) {
+            foreach ($dslSort as $sort) {
+                if (is_array($sort)) {
+                    $field = key($sort);
+                    $info = current($sort);
+                }
+                else
+                    $field = $sort;
+                $string .= "&sort=" . $field;
+                if (isset($info)) {
+                    if (is_string($info) && $info == "desc")
+                        $string .= ":reverse";
+                    elseif (is_array($info) && array_key_exists("reverse", $info) && $info['reverse'])
+                        $string .= ":reverse";
+                }
+            }
+        }
+        return $string;
+    }
+
+    /**
+     * Transform a selection of fields to return to string form
+     *
+     * @return string
+     * @param mixed $dslFields
+     */
+    protected function transformDSLFieldsToString($dslFields) {
+        $string = "";
+        if (is_array($dslFields))
+            $string .= "&fields=" . join(",", $dslFields);
         return $string;
     }
 }

tests/DSLTest.php

@@ -23,4 +23,58 @@ public function testTerm() {
         $strDsl = (string)$dsl;
         $this->assertEquals("cool", $strDsl);
     }
+
+    public function testGroupedTerms() {
+        $arr = array(
+            'query' => array(
+                'term' => 'cool stuff'
+            )
+        );
+        $dsl = new ElasticSearchDSL($arr);
+        $strDsl = (string)$dsl;
+        $this->assertEquals('"cool stuff"', $strDsl);
+    }
+
+    public function testNamedGroupedTerms() {
+        $arr = array(
+            'query' => array(
+                'term' => array('title' => 'cool stuff')
+            )
+        );
+        $dsl = new ElasticSearchDSL($arr);
+        $strDsl = (string)$dsl;
+        $this->assertEquals('title:"cool stuff"', $strDsl);
+    }
+
+    public function testSort() {
+        $arr = array(
+            'sort' => array(
+                array('title' => 'desc')
+            ),
+            'query' => array(
+                'term' => array('title' => 'cool stuff')
+            )
+        );
+        $dsl = new ElasticSearchDSL($arr);
+        $this->assertEquals('title:"cool stuff"&sort=title:reverse', (string)$dsl);
+
+        $arr['sort'] = array('title');
+        $dsl = new ElasticSearchDSL($arr);
+        $this->assertEquals('title:"cool stuff"&sort=title', (string)$dsl);
+
+        $arr['sort'] = array(array('title' => array('reverse' => true)));
+        $dsl = new ElasticSearchDSL($arr);
+        $this->assertEquals('title:"cool stuff"&sort=title:reverse', (string)$dsl);
+    }
+
+    public function testLimitReturnFields() {
+        $arr = array(
+            'fields' => array('title','body'),
+            'query' => array(
+                'term' => array('title' => 'cool')
+            )
+        );
+        $dsl = new ElasticSearchDSL($arr);
+        $this->assertEquals('title:cool&fields=title,body', (string)$dsl);
+    }
 }