Fixed examples and a bug in spellcheck response parsing, added a unittest

examples/5.3.1-plugin-event-hooks.php

@@ -3,7 +3,7 @@ require(__DIR__.'/init.php');
 
 
 // this very simple plugin shows a timing for each event and display some request debug info
-class basicDebug extends Solarium\Core\Plugin
+class basicDebug extends Solarium\Core\Plugin\Plugin
 {
 
     protected $start;

examples/5.3.2-plugin-solarium-presets.php

 <?php
 require(__DIR__.'/init.php');
 use Solarium\Client;
-use Solarium\Core\Plugin;
+use Solarium\Core\Plugin\Plugin;
 use Solarium\QueryType\Select\Query\Query as Select;
 
 // This is a custom query class that could have some customized logic

library/Solarium/QueryType/Select/ResponseParser/Component/Spellcheck.php

@@ -79,18 +79,13 @@ class Spellcheck extends ResponseParserAbstract implements ComponentParserInterf
             $collations = array();
 
             foreach ($spellcheckResults as $key => $value) {
+
                 switch ($key) {
                     case 'correctlySpelled':
                         $correctlySpelled = $value;
                         break;
                     case 'collation':
-                        if (!array_key_exists('collation', $value)) {
-                            foreach ($value as $collationValue) {
-                                $collations[] = $this->parseCollation($query, $collationValue);
-                            }
-                        } else {
-                            $collations[] = $this->parseCollation($query, $value);
-                        }
+                        $collations = $this->parseCollation($query, $value);
                         break;
                     default:
                         $suggestions[] = $this->parseSuggestion($key, $value);
@@ -108,51 +103,69 @@ class Spellcheck extends ResponseParserAbstract implements ComponentParserInterf
      *
      * @param  Query     $queryObject
      * @param  array     $values
-     * @return Collation
+     * @return Collation[]
      */
     protected function parseCollation($queryObject, $values)
     {
+        $collations = array();
         if (is_string($values)) {
-            return new Collation($values, null, array());
 
-        } else {
+            $collations[] = new Collation($values, null, array());
 
-            $query = null;
-            $hits = null;
-            $correctionResult = null;
+        } else if (is_array($values) && isset($values[0]) && is_string($values[0]) && $values[0] !== 'collationQuery') {
 
-            if ($queryObject->getResponseWriter() == $queryObject::WT_JSON) {
-                $values = $this->convertToKeyValueArray($values);
+            foreach ($values as $value) {
+                $collations[] = new Collation($value, null, array());
             }
 
-            foreach ($values as $key => $value) {
-                switch ($key) {
-                    case 'collationQuery':
-                        $query = $value;
-                        break;
-                    case 'hits':
-                        $hits = $value;
-                        break;
-                    case 'misspellingsAndCorrections':
-                        $correctionResult = $value;
-                        break;
+        } else {
+
+            if ($queryObject->getResponseWriter() == $queryObject::WT_JSON) {
+                if(is_array(current($values))){
+                    foreach($values as $key => $value) {
+                        $values[$key] = $this->convertToKeyValueArray($value);
+                    }
+                } else {
+                    $values = array($this->convertToKeyValueArray($values));
                 }
             }
 
-            $corrections = array();
-            if ($correctionResult !== null) {
-
-                if ($queryObject->getResponseWriter() == $queryObject::WT_JSON) {
-                    $correctionResult = $this->convertToKeyValueArray($correctionResult);
+            foreach($values as $collationValue) {
+                $query = null;
+                $hits = null;
+                $correctionResult = null;
+
+                foreach ($collationValue as $key => $value) {
+                    switch ($key) {
+                        case 'collationQuery':
+                            $query = $value;
+                            break;
+                        case 'hits':
+                            $hits = $value;
+                            break;
+                        case 'misspellingsAndCorrections':
+                            $correctionResult = $value;
+                            break;
+                    }
                 }
 
-                foreach ($correctionResult as $input => $correction) {
-                    $corrections[$input] = $correction;
+                $corrections = array();
+                if ($correctionResult !== null) {
+
+                    if ($queryObject->getResponseWriter() == $queryObject::WT_JSON) {
+                        $correctionResult = $this->convertToKeyValueArray($correctionResult);
+                    }
+
+                    foreach ($correctionResult as $input => $correction) {
+                        $corrections[$input] = $correction;
+                    }
                 }
-            }
 
-            return new Collation($query, $hits, $corrections);
+                $collations[] = new Collation($query, $hits, $corrections);
+            }
         }
+
+        return $collations;
     }
 
     /**

tests/Solarium/Tests/QueryType/Select/ResponseParser/Component/SpellcheckTest.php

@@ -170,6 +170,47 @@ class SpellcheckTest extends \PHPUnit_Framework_TestCase
 
     }
 
+    public function testParseSingleCollation()
+    {
+        $data = array(
+            'spellcheck' => array(
+                'suggestions' => array(
+                    0 => 'delll',
+                    1 => array (
+                        'numFound' => 1,
+                        'startOffset' => 0,
+                        'endOffset' => 5,
+                        'origFreq' => 0,
+                        'suggestion' => array (
+                            0 => 'dell',
+                        ),
+                    ),
+                    2 => 'ultrashar',
+                    3 => array (
+                        'numFound' => 1,
+                        'startOffset' => 6,
+                        'endOffset' => 15,
+                        'origFreq' => 0,
+                        'suggestion' => array (
+                            0 => array (
+                                'word' => 'ultrasharp',
+                                'freq' => 1
+                            ),
+                        ),
+                    ),
+                    4 => 'correctlySpelled',
+                    5 => false,
+                    6 => 'collation',
+                    7 => 'dell ultrasharp',
+                )
+            )
+        );
+
+        $result = $this->parser->parse($this->query, null, $data);
+        $collations = $result->getCollations();
+        $this->assertEquals('dell ultrasharp', $collations[0]->getQuery());
+    }
+
     public function testParseNoData()
     {
         $result = $this->parser->parse($this->query, null, array());