issue #796 Add eDisMax component

library/Solarium/Client/RequestBuilder/Select/Component/eDisMax.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 dismax to the request
+ *
+ * @package Solarium
+ * @subpackage Client
+ */
+class Solarium_Client_RequestBuilder_Select_Component_eDisMax
+{
+    
+    /**
+     * Add request settings for eDismax
+     *
+     * @param Solarium_Query_Select_Component_Dismax $component
+     * @param Solarium_Client_Request $request
+     * @return Solarium_Client_Request
+     */
+    public function build($component, $request)
+    {
+        // enable dismax
+        $request->addParam('defType', 'edismax');
+
+        $request->addParam('q.alt', $component->getQueryAlternative());
+        $request->addParam('qf', $component->getQueryFields());
+        $request->addParam('mm', $component->getMinimumMatch());
+        $request->addParam('pf', $component->getPhraseFields());
+        $request->addParam('ps', $component->getPhraseSlop());
+        $request->addParam('qs', $component->getQueryPhraseSlop());
+        $request->addParam('tie', $component->getTie());
+        $request->addParam('bq', $component->getBoostQuery());
+        $request->addParam('boost', $component->getBoostFunctions());
+
+        return $request;
+    }
+}

library/Solarium/Query/Select.php

@@ -60,6 +60,7 @@ class Solarium_Query_Select extends Solarium_Query
      */
     const COMPONENT_FACETSET = 'facetset';
     const COMPONENT_DISMAX = 'dismax';
+	const COMPONENT_EDISMAX = 'edismax';
     const COMPONENT_MORELIKETHIS = 'morelikethis';
     const COMPONENT_HIGHLIGHTING = 'highlighting';
 	const COMPONENT_SPELLCHECK = 'spellcheck';
@@ -105,6 +106,11 @@ class Solarium_Query_Select extends Solarium_Query
             'requestbuilder' => 'Solarium_Client_RequestBuilder_Select_Component_DisMax',
             'responseparser' => null,
         ),
+        self::COMPONENT_EDISMAX => array(
+            'component' => 'Solarium_Query_Select_Component_eDisMax',
+            'requestbuilder' => 'Solarium_Client_RequestBuilder_Select_Component_eDisMax',
+            'responseparser' => null,
+        ),
         self::COMPONENT_MORELIKETHIS => array(
             'component' => 'Solarium_Query_Select_Component_MoreLikeThis',
             'requestbuilder' => 'Solarium_Client_RequestBuilder_Select_Component_MoreLikeThis',
@@ -768,4 +774,16 @@ class Solarium_Query_Select extends Solarium_Query
         return $this->getComponent(Solarium_Query_Select::COMPONENT_SPELLCHECK, true);
     }
 
+    /**
+     * Get a edismax component instance
+     *
+     * This is a convenience method that maps presets to getComponent
+     *
+     * @return Solarium_Query_Select_Component_eDisMax
+     */
+    public function getEDisMax()
+    {
+        return $this->getComponent(Solarium_Query_Select::COMPONENT_EDISMAX, true);
+    }
+
 }
\ No newline at end of file

library/Solarium/Query/Select/Component/eDisMax.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
+ */
+
+/**
+ * eDisMax component
+ *
+ * @link http://wiki.apache.org/solr/DisMaxQParserPlugin
+ * 
+ * @package Solarium
+ * @subpackage Query
+ */
+class Solarium_Query_Select_Component_eDisMax extends Solarium_Query_Select_Component
+{
+
+    /**
+     * Component type
+     * 
+     * @var string
+     */
+    protected $_type = Solarium_Query_Select::COMPONENT_EDISMAX;
+
+    /**
+     * Set QueryAlternative option
+     *
+     * If specified, this query will be used (and parsed by default using
+     * standard query parsing syntax) when the main query string is not
+     * specified or blank.
+     *
+     * @param string $queryAlternative
+     * @return Solarium_Query_Select_Component_DisMax Provides fluent interface
+     */
+    public function setQueryAlternative($queryAlternative)
+    {
+        return $this->_setOption('queryalternative', $queryAlternative);
+    }
+
+    /**
+     * Get QueryAlternative option
+     *
+     * @return string|null
+     */
+    public function getQueryAlternative()
+    {
+        return $this->getOption('queryalternative');
+    }
+
+    /**
+     * Set QueryFields option
+     *
+     * List of fields and the "boosts" to associate with each of them when
+     * building DisjunctionMaxQueries from the user's query.
+     *
+     * The format supported is "fieldOne^2.3 fieldTwo fieldThree^0.4"
+     *
+     * @param string $queryFields
+     * @return Solarium_Query_Select_Component_DisMax Provides fluent interface
+     */
+    public function setQueryFields($queryFields)
+    {
+        return $this->_setOption('queryfields', $queryFields);
+    }
+
+    /**
+     * Get QueryFields option
+     *
+     * @return string|null
+     */
+    public function getQueryFields()
+    {
+        return $this->getOption('queryfields');
+    }
+
+    /**
+     * Set MinimumMatch option
+     *
+     * This option makes it possible to say that a certain minimum number of
+     * clauses must match. See Solr manual for details.
+     *
+     * @param string $minimumMatch
+     * @return Solarium_Query_Select_Component_DisMax Provides fluent interface
+     */
+    public function setMinimumMatch($minimumMatch)
+    {
+        return $this->_setOption('minimummatch', $minimumMatch);
+    }
+
+    /**
+     * Get MinimumMatch option
+     *
+     * @return string|null
+     */
+    public function getMinimumMatch()
+    {
+        return $this->getOption('minimummatch');
+    }
+
+    /**
+     * Set PhraseFields option
+     *
+     * This param can be used to "boost" the score of documents in cases
+     * where all of the terms in the "q" param appear in close proximity.
+     *
+     * Format is: "fieldA^1.0 fieldB^2.2"
+     *
+     * @param string $phraseFields
+     * @return Solarium_Query_Select_Component_DisMax Provides fluent interface
+     */
+    public function setPhraseFields($phraseFields)
+    {
+        return $this->_setOption('phrasefields', $phraseFields);
+    }
+
+    /**
+     * Get PhraseFields option
+     *
+     * @return string|null
+     */
+    public function getPhraseFields()
+    {
+        return $this->getOption('phrasefields');
+    }
+
+    /**
+     * Set PhraseSlop option
+     *
+     * Amount of slop on phrase queries built for "pf" fields
+     * (affects boosting)
+     *
+     * @param string $phraseSlop
+     * @return Solarium_Query_Select_Component_DisMax Provides fluent interface
+     */
+    public function setPhraseSlop($phraseSlop)
+    {
+        return $this->_setOption('phraseslop', $phraseSlop);
+    }
+
+    /**
+     * Get PhraseSlop option
+     *
+     * @return string|null
+     */
+    public function getPhraseSlop()
+    {
+        return $this->getOption('phraseslop');
+    }
+
+    /**
+     * Set QueryPhraseSlop option
+     *
+     * Amount of slop on phrase queries explicitly included in the user's
+     * query string (in qf fields; affects matching)
+     *
+     * @param string $queryPhraseSlop
+     * @return Solarium_Query_Select_Component_DisMax Provides fluent interface
+     */
+    public function setQueryPhraseSlop($queryPhraseSlop)
+    {
+        return $this->_setOption('queryphraseslop', $queryPhraseSlop);
+    }
+
+    /**
+     * Get QueryPhraseSlop option
+     *
+     * @return string|null
+     */
+    public function getQueryPhraseSlop()
+    {
+        return $this->getOption('queryphraseslop');
+    }
+
+    /**
+     * Set Tie option
+     *
+     * Float value to use as tiebreaker in DisjunctionMaxQueries
+     *
+     * @param float $tie
+     * @return Solarium_Query_Select_Component_DisMax Provides fluent interface
+     */
+    public function setTie($tie)
+    {
+        return $this->_setOption('tie', $tie);
+    }
+
+    /**
+     * Get Tie option
+     *
+     * @return float|null
+     */
+    public function getTie()
+    {
+        return $this->getOption('tie');
+    }
+
+    /**
+     * Set BoostQuery option
+     *
+     * A raw query string (in the SolrQuerySyntax) that will be included
+     * with the user's query to influence the score.
+     *
+     * @param string $boostQuery
+     * @return Solarium_Query_Select_Component_DisMax Provides fluent interface
+     */
+    public function setBoostQuery($boostQuery)
+    {
+        return $this->_setOption('boostquery', $boostQuery);
+    }
+
+    /**
+     * Get BoostQuery option
+     *
+     * @return string|null
+     */
+    public function getBoostQuery()
+    {
+        return $this->getOption('boostquery');
+    }
+
+    /**
+     * Set BoostFunctions option
+     *
+     * Functions (with optional boosts) that will be included in the
+     * user's query to influence the score.
+     *
+     * Format is: "funcA(arg1,arg2)^1.2 funcB(arg3,arg4)^2.2"
+     *
+     * @param string $boostFunctions
+     * @return Solarium_Query_Select_Component_DisMax Provides fluent interface
+     */
+    public function setBoostFunctions($boostFunctions)
+    {
+        return $this->_setOption('boostfunctions', $boostFunctions);
+    }
+
+    /**
+     * Get BoostFunctions option
+     *
+     * @return string|null
+     */
+    public function getBoostFunctions()
+    {
+        return $this->getOption('boostfunctions');
+    }
+
+}