Fix AnalyzeAPI with 'explain' parameter (#1254)

Author: thePanz

CHANGELOG.md

@@ -14,6 +14,8 @@ All notable changes to this project will be documented in this file based on the
 
 ### Improvements
 
+- added support for the "explain" flag of AnalyzeAPI [PR-1254](https://github.com/ruflin/Elastica/pull/1254)
+
 ### Deprecated
 
 - Deprecated `\Elastica\Exception\ElasticsearchException` which is irrelevant since Elasticsearch now exposes the errors as a structured array instead of a single string.

lib/Elastica/Index.php

@@ -536,6 +536,12 @@ public function analyze($text, $args = [])
     {
         $data = $this->request('_analyze', Request::POST, $text, $args)->getData();
 
+        // Support for "Explain" parameter, that returns a different response structure from Elastic
+        // @see: https://www.elastic.co/guide/en/elasticsearch/reference/current/_explain_analyze.html
+        if (isset($args['explain']) && $args['explain']) {
+            return $data['detail'];
+        }
+
         return $data['tokens'];
     }
 }

test/lib/Elastica/Test/IndexTest.php

@@ -914,6 +914,18 @@ public function testAnalyze()
         $this->assertEquals($tokens, $returnedTokens);
     }
 
+    /**
+     * @group functional
+     */
+    public function testAnalyzeExplain()
+    {
+        $index = $this->_createIndex();
+        $index->refresh();
+        $data = $index->analyze('foo', ['explain' => true]);
+
+        $this->assertArrayHasKey('custom_analyzer', $data);
+    }
+
     /**
      * @group unit
      * @expectedException \Elastica\Exception\InvalidException