- added Solarium_Escape class

- removed escape method in Solarium_Query
- updated tests for escaping changes
- added some extra phpdoc to the select query

library/Solarium/Escape.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
+ *
+ * @package Solarium
+ */
+
+/**
+ * Escape data for usage in a Solr query
+ *
+ * Any (user) input for a query can be passed to one of the escape methods to
+ * prevent any issues with special characters.
+ *
+ * Do mind that you cannot build a complete query first and then pass it to
+ * this method, the whole query will be escaped. You need to escape only the
+ * 'content' of your query.
+ *
+ * @package Solarium
+ */
+class Solarium_Escape
+{
+
+    /**
+     * Escape a term
+     *
+     * A term is a single word.
+     * All characters that have a special meaning in a Solr query are escaped.
+     *
+     * @link http://lucene.apache.org/java/docs/queryparsersyntax.html#Escaping%20Special%20Characters
+     *
+     * If you want to use the input as a phrase please use the {@link phrase()}
+     * method, because a phrase requires much less escaping.
+     *
+     * @param string $input
+     * @return string
+     */
+    static public function term($input)
+    {
+		$pattern = '/(\+|-|&&|\|\||!|\(|\)|\{|}|\[|]|\^|"|~|\*|\?|:|\\\)/';
+
+		return preg_replace($pattern, '\\\$1', $input);
+    }
+
+    /**
+     * Escape a phrase
+     *
+     * A phrase is a group of words.
+     * Special characters will be escaped and the phrase will be surrounded by
+     * double quotes to group the input into a single phrase. So don't put
+     * quotes around the input.
+     *
+     * @param string $input
+     * @return string
+     */
+    static public function phrase($input)
+    {
+		return '"' . preg_replace('/("|\\\)/', '\\\$1', $input) . '"';
+    }
+
+    
+
+}
\ No newline at end of file

library/Solarium/Query.php

@@ -92,31 +92,5 @@ class Solarium_Query extends Solarium_Configurable
     {
         return $this->getOption('resultclass');
     }
-    
-    /**
-     * Escape special Solr characters in a value
-     *
-     * This can be used for building Solr query strings. Any (user) input for
-     * the query can be passed to this function to prevent any issues with
-     * special characters.
-     *
-     * Do mind that you cannot build a complete query first and then pass it to
-     * this method, the whole query will be escaped. You need to escape only the
-     * 'content' of your query.
-     *
-     * @param string $string
-     * @return string
-     */
-    public function escapeValue($string)
-    {
-        $match = array('\\', '+', '-', '&', '|', '!', '(', ')', '{', '}', '[',
-                        ']', '^', '~', '*', '?', ':', '"', ';', ' ');
-        $replace = array('\\\\', '\\+', '\\-', '\\&', '\\|', '\\!', '\\(',
-                        '\\)', '\\{', '\\}', '\\[', '\\]', '\\^', '\\~', '\\*',
-                        '\\?', '\\:', '\\"', '\\;', '\\ ');
-        $string = str_replace($match, $replace, $string);
-
-        return $string;
-    }
 
 }
\ No newline at end of file

library/Solarium/Query/Select.php

@@ -38,6 +38,10 @@
 /**
  * Select Query
  *
+ * Can be used to select documents and/or facets from Solr. This querytype has
+ * lots of options and there are many Solarium subclasses for it.
+ * See the Solr documentation and the relevant Solarium classes for more info.
+ *
  * @package Solarium
  * @subpackage Query
  */

tests/Solarium/EscapeTest.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.
+ */
+
+class Solarium_EscapeTest extends PHPUnit_Framework_TestCase
+{
+
+    public function testTerm()
+    {
+        $this->assertEquals(
+            'a\\+b',
+            Solarium_Escape::term('a+b')
+        );
+    }
+
+    public function testTermNoEscape()
+    {
+        $this->assertEquals(
+            'abc',
+            Solarium_Escape::term('abc')
+        );
+    }
+
+    public function testPhrase()
+    {
+        $this->assertEquals(
+            '"a+\\"b"',
+            Solarium_Escape::phrase('a+"b')
+        );
+    }
+
+    public function testPhraseNoEscape()
+    {
+        $this->assertEquals(
+            '"a+b"',
+            Solarium_Escape::phrase('a+b')
+        );
+    }
+    
+}
\ No newline at end of file

tests/Solarium/QueryTest.php

@@ -45,14 +45,5 @@ class Solarium_QueryTest extends PHPUnit_Framework_TestCase
         $query->setResultClass('myResultClass');
         $this->assertEquals('myResultClass', $query->getResultClass());
     }
-
-    public function testEscapeValue()
-    {
-        $query = new Solarium_Query();
-        $this->assertEquals(
-            'a\\+b',
-            $query->escapeValue('a+b')
-        );
-    }
     
 }
\ No newline at end of file