<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.solrquery.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'solrquery.sethighlightquery.php',
    1 => 'SolrQuery::setHighlightQuery',
    2 => 'A query designated for highlighting',
  ),
  'up' => 
  array (
    0 => 'class.solrquery.php',
    1 => 'SolrQuery',
  ),
  'prev' => 
  array (
    0 => 'solrquery.sethighlightmergecontiguous.php',
    1 => 'SolrQuery::setHighlightMergeContiguous',
  ),
  'next' => 
  array (
    0 => 'solrquery.sethighlightregexmaxanalyzedchars.php',
    1 => 'SolrQuery::setHighlightRegexMaxAnalyzedChars',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/solr/solrquery/sethighlightquery.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="solrquery.sethighlightquery" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SolrQuery::setHighlightQuery</h1>
  <p class="verinfo">(PECL solr &gt;= 2.7.0)</p><p class="refpurpose"><span class="refname">SolrQuery::setHighlightQuery</span> &mdash; <span class="dc-title">A query designated for highlighting</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-solrquery.sethighlightquery-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>SolrQuery::setHighlightQuery</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$q</code></span>): <span class="type"><a href="class.solrquery.php" class="type SolrQuery">SolrQuery</a></span></div>

  <p class="simpara">
   A query to use for highlighting and which will be set as the value of the Solr <code class="literal">hl.q</code> parameter.
   This parameter allows one to highlight different terms or fields than those being used to retrieve documents.
  </p>

  <p class="simpara">
   Default value when not set: the value of the request&#039;s <code class="literal">q</code> parameter.
  </p>

  <p class="simpara">
   See the <a href="https://solr.apache.org/guide/solr/latest/query-guide/highlighting.html" class="link external">&raquo;&nbsp;Highlighting</a>
   section for more details about the Solr <code class="literal">hl.q</code> parameter.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-solrquery.sethighlightquery-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">q</code></dt>
     <dd>
      <p class="simpara">
       Highlight Query.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-solrquery.sethighlightquery-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns the current <span class="classname"><a href="class.solrquery.php" class="classname">SolrQuery</a></span> object.
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-solrquery.sethighlightquery-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="solrquery.gethighlightquery.php" class="methodname" rel="rdfs-seeAlso">SolrQuery::getHighlightQuery()</a> - Return the highlight query</span></li>
   <li><span class="methodname"><strong>SolrQuery::setHighlightFields()</strong></span></li>
   <li><span class="methodname"><a href="solrquery.gethighlightfields.php" class="methodname" rel="rdfs-seeAlso">SolrQuery::getHighlightFields()</a> - Returns all the fields that Solr should generate highlighted snippets for</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>