<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Escapes a lucene query string</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="solrutils.digestxmlresponse.html">SolrUtils::digestXmlResponse</a></div> <div class="next" style="text-align: right; float: right;"><a href="solrutils.getsolrversion.html">SolrUtils::getSolrVersion</a></div> <div class="up"><a href="class.solrutils.html">SolrUtils</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="solrutils.escapequerychars" class="refentry"> <div class="refnamediv"> <h1 class="refname">SolrUtils::escapeQueryChars</h1> <p class="verinfo">(PECL solr >= 0.9.2)</p><p class="refpurpose"><span class="refname">SolrUtils::escapeQueryChars</span> — <span class="dc-title">Escapes a lucene query string</span></p> </div> <div class="refsect1 description" id="refsect1-solrutils.escapequerychars-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">string</span> <span class="methodname"><strong>SolrUtils::escapeQueryChars</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span> )</div> <p class="para rdfs-comment"> Lucene supports escaping special characters that are part of the query syntax. </p> <p class="para">The current list special characters are:</p> <p class="para"> <div class="descriptioncode"><pre class="descriptioncode">+ - && || ! ( ) { } [ ] ^ " ~ * ? : \</pre> </div></p> <p class="para">These characters are part of the query syntax and must be escaped</p> </div> <div class="refsect1 parameters" id="refsect1-solrutils.escapequerychars-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">str</code></em></span> <dd> <p class="para"> This is the query string to be escaped. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-solrutils.escapequerychars-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the escaped string or <strong><code>FALSE</code></strong> on failure. </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="solrutils.digestxmlresponse.html">SolrUtils::digestXmlResponse</a></div> <div class="next" style="text-align: right; float: right;"><a href="solrutils.getsolrversion.html">SolrUtils::getSolrVersion</a></div> <div class="up"><a href="class.solrutils.html">SolrUtils</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>