Merge branch 'release/2.1.0' into develop

examples/1.3-basic-update.php

@@ -6,19 +6,19 @@ htmlHeader();
 if ($_POST) {
     // if data is posted add it to solr
 
-    // create a new document for the data
-    // please note that any type of validation is missing in this example to keep it simple!
-    $doc = new Solarium_Document_ReadWrite();
-    $doc->id = $_POST['id'];
-    $doc->name = $_POST['name'];
-    $doc->price = $_POST['price'];
-
     // create a client instance
     $client = new Solarium_Client($config);
 
     // get an update query instance
     $update = $client->createUpdate();
 
+    // create a new document for the data
+    // please note that any type of validation is missing in this example to keep it simple!
+    $doc = $update->createDocument();
+    $doc->id = $_POST['id'];
+    $doc->name = $_POST['name'];
+    $doc->price = $_POST['price'];
+    
     // add the document and a commit command to the update query
     $update->addDocument($doc);
     $update->addCommit();

examples/3.1-add-docs.php

@@ -3,25 +3,24 @@
 require('init.php');
 htmlHeader();
 
+// create a client instance
+$client = new Solarium_Client($config);
+
+// get an update query instance
+$update = $client->createUpdate();
 
 // create a new document for the data
-$doc1 = new Solarium_Document_ReadWrite();
+$doc1 = $update->createDocument();
 $doc1->id = 123;
 $doc1->name = 'testdoc-1';
 $doc1->price = 364;
 
 // and a second one
-$doc2 = new Solarium_Document_ReadWrite();
+$doc2 = $update->createDocument();
 $doc2->id = 124;
 $doc2->name = 'testdoc-2';
 $doc2->price = 340;
 
-// create a client instance
-$client = new Solarium_Client($config);
-
-// get an update query instance
-$update = $client->createUpdate();
-
 // add the documents and a commit command to the update query
 $update->addDocuments(array($doc1, $doc2));
 $update->addCommit();

examples/6.2-escaping.php

@@ -13,6 +13,7 @@ $query = $client->createSelect();
 $input = 'ATA "133';
 
 // in this case phrase escaping is used (most common) but you can also do term escaping, see the manual
+// also note that the same can be done using the placeholder syntax, see example 6.3
 $helper = $query->getHelper();
 $query->setQuery('features:' . $helper->escapePhrase($input));
 

examples/6.3-demo-app.php

-<?php
-
-require('init.php');
-htmlHeader();
-
-echo 'TODO';
-
-htmlFooter();
\ No newline at end of file

examples/6.3-placeholder-syntax.php

+<?php
+
+require('init.php');
+htmlHeader();
+
+// create a client instance
+$client = new Solarium_Client($config);
+
+// get a select query instance
+$query = $client->createSelect();
+
+// search input string, this value fails without escaping because of the double-quote
+$input = 'ATA "133';
+
+// the placeholder syntax applies phrase escaping to the first term
+// see the manual for all supported formats
+$query->setQuery('features: %p1% AND inStock:%2%',array($input,1));
+
+// show the result after replacing the placeholders with values
+echo $query->getQuery() . '<br/>';
+
+// this executes the query and returns the result
+$resultset = $client->select($query);
+
+// display the total number of documents found by solr
+echo 'NumFound: '.$resultset->getNumFound();
+
+// show documents using the resultset iterator
+foreach ($resultset as $document) {
+
+    echo '<hr/><table>';
+
+    // the documents are also iterable, to get all fields
+    foreach($document AS $field => $value)
+    {
+        // this converts multivalue fields to a comma-separated string
+        if(is_array($value)) $value = implode(', ', $value);
+        
+        echo '<tr><th>' . $field . '</th><td>' . $value . '</td></tr>';
+    }
+
+    echo '</table>';
+}
+
+htmlFooter();
\ No newline at end of file

examples/index.html

@@ -82,7 +82,7 @@
             <ul style="list-style:none;">
                 <li><a href="6.1-zend-http-adapter.php">6.1 Zend_Http adapter</a></li>
                 <li><a href="6.2-escaping.php">6.2 Escaping</a></li>
-                <li><a href="6.3-demo-app.php">2.7 Demo search (mini) application</a></li>
+                <li><a href="6.3-placeholder-syntax.php">6.3 Placeholder syntax</a></li>
             </ul>
 
         </ul>

library/Solarium/Query/Helper.php

@@ -249,6 +249,8 @@ class Solarium_Query_Helper
      * The mode matching pattern can be customized by overriding the
      * value of $this->_placeHolderPattern
      *
+     * @since 2.1.0
+     * 
      * @param string $query
      * @param array $parts Array of strings
      * @return string
@@ -264,6 +266,13 @@ class Solarium_Query_Helper
         );
     }
 
+    /**
+     * Render placeholders in a querystring
+     *
+     * @throws Solarium_Exception
+     * @param array $matches
+     * @return string
+     */
     protected function _renderPlaceHolder($matches)
     {
         $partNumber = $matches[2];

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

@@ -290,6 +290,8 @@ class Solarium_Query_Select_Component_DisMax extends Solarium_Query_Select_Compo
      *
      * Can be used to enable edismax
      *
+     * @since 2.1.0
+     *
      * @param string $parser
      * @return Solarium_Query_Select_Component_DisMax Provides fluent interface
      */
@@ -301,6 +303,8 @@ class Solarium_Query_Select_Component_DisMax extends Solarium_Query_Select_Compo
     /**
      * Get QueryParser option
      *
+     * @since 2.1.0
+     * 
      * @return string
      */
     public function getQueryParser()

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

@@ -43,6 +43,8 @@
  * See the Solr wiki for more info about this functionality
  *
  * @link http://wiki.apache.org/solr/FieldCollapsing
+ *
+ * @since 2.1.0
  * 
  * @package Solarium
  * @subpackage Query

library/Solarium/Query/Update.php

@@ -392,6 +392,8 @@ class Solarium_Query_Update extends Solarium_Query
      * You can optionally directly supply the fields and boosts
      * to get a ready-made document instance for direct use in an add command
      *
+     * @since 2.1.0
+     *
      * @param array $fields
      * @param array $boosts
      * @return Solarium_Document_ReadWrite

library/Solarium/Result/Select/Grouping.php

@@ -39,6 +39,8 @@
 /**
  * Select component grouping result
  *
+ * @since 2.1.0
+ * 
  * @package Solarium
  * @subpackage Result
  */

library/Solarium/Result/Select/Grouping/FieldGroup.php

@@ -39,6 +39,8 @@
 /**
  * Select component grouping field group result
  *
+ * @since 2.1.0
+ * 
  * @package Solarium
  * @subpackage Result
  */

library/Solarium/Result/Select/Grouping/QueryGroup.php

@@ -39,6 +39,8 @@
 /**
  * Select component grouping query group result
  *
+ * @since 2.1.0
+ *
  * @package Solarium
  * @subpackage Result
  */

library/Solarium/Result/Select/Grouping/ValueGroup.php

@@ -39,6 +39,8 @@
 /**
  * Select component grouping field value group result
  *
+ * @since 2.1.0
+ *
  * @package Solarium
  * @subpackage Result
  */