First work on debug component

library/Solarium/Client/RequestBuilder/Select/Component/Debug.php

+<?php
+/**
+ * Copyright 2011 Bas de Nooijer. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this listof conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are
+ * those of the authors and should not be interpreted as representing official
+ * policies, either expressed or implied, of the copyright holder.
+ *
+ * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
+ * @license http://github.com/basdenooijer/solarium/raw/master/COPYING
+ * @link http://www.solarium-project.org/
+ *
+ * @package Solarium
+ * @subpackage Client
+ */
+
+/**
+ * Add select component debug to the request
+ *
+ * @package Solarium
+ * @subpackage Client
+ */
+class Solarium_Client_RequestBuilder_Select_Component_Debug
+{
+
+    /**
+     * Add request settings for the debug component
+     *
+     * @param Solarium_Query_Select_Component_Debug $component
+     * @param Solarium_Client_Request $request
+     * @return Solarium_Client_Request
+     */
+    public function build($component, $request)
+    {
+        $request->addParam('debugQuery', 'true');
+        $request->addParam('debug.explain.structured', 'true');
+        $request->addParam('explainOther', $component->getExplainOther());
+
+        return $request;
+    }
+}
\ No newline at end of file

library/Solarium/Query/Select.php

@@ -99,6 +99,11 @@ class Solarium_Query_Select extends Solarium_Query
      */
     const COMPONENT_STATS = 'stats';
 
+    /**
+     * Query component debug
+     */
+    const COMPONENT_DEBUG = 'debug';
+
     /**
      * Get type for this query
      *
@@ -170,6 +175,11 @@ class Solarium_Query_Select extends Solarium_Query
             'requestbuilder' => 'Solarium_Client_RequestBuilder_Select_Component_Stats',
             'responseparser' => 'Solarium_Client_ResponseParser_Select_Component_Stats',
         ),
+        self::COMPONENT_DEBUG => array(
+            'component' => 'Solarium_Query_Select_Component_Debug',
+            'requestbuilder' => 'Solarium_Client_RequestBuilder_Select_Component_Debug',
+            'responseparser' => 'Solarium_Client_ResponseParser_Select_Component_Debug',
+        ),
     );
 
     /**
@@ -896,4 +906,16 @@ class Solarium_Query_Select extends Solarium_Query
         return $this->getComponent(Solarium_Query_Select::COMPONENT_STATS, true);
     }
 
+    /**
+     * Get a Debug component instance
+     *
+     * This is a convenience method that maps presets to getComponent
+     *
+     * @return Solarium_Query_Select_Component_Debug
+     */
+    public function getDebug()
+    {
+        return $this->getComponent(Solarium_Query_Select::COMPONENT_DEBUG, true);
+    }
+
 }

library/Solarium/Query/Select/Component/Debug.php

+<?php
+/**
+ * Copyright 2011 Bas de Nooijer. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this listof conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are
+ * those of the authors and should not be interpreted as representing official
+ * policies, either expressed or implied, of the copyright holder.
+ *
+ * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
+ * @license http://github.com/basdenooijer/solarium/raw/master/COPYING
+ * @link http://www.solarium-project.org/
+ *
+ * @package Solarium
+ * @subpackage Query
+ */
+
+/**
+ * Debug component
+ *
+ * @link http://wiki.apache.org/solr/CommonQueryParameters#Debugging
+ *
+ * @package Solarium
+ * @subpackage Query
+ */
+class Solarium_Query_Select_Component_Debug extends Solarium_Query_Select_Component
+{
+
+    /**
+     * Component type
+     *
+     * @var string
+     */
+    protected $_type = Solarium_Query_Select::COMPONENT_DEBUG;
+
+    /**
+     * Get the explainOther option
+     *
+     * @return string|null
+     */
+    public function getExplainOther()
+    {
+        return $this->getOption('explainother');
+    }
+
+    /**
+     * Set the explainOther query
+     *
+     * @param string $query
+     * @return self Provides fluent interface
+     */
+    public function setExplainOther($query)
+    {
+        return $this->_setOption('explainother', $query);
+    }
+
+}
\ No newline at end of file