<!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>Enables/Disables the Expand Component</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="solrquery.setechoparams.html">SolrQuery::setEchoParams</a></div> <div class="next" style="text-align: right; float: right;"><a href="solrquery.setexpandquery.html">SolrQuery::setExpandQuery</a></div> <div class="up"><a href="class.solrquery.html">SolrQuery</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="solrquery.setexpand" class="refentry"> <div class="refnamediv"> <h1 class="refname">SolrQuery::setExpand</h1> <p class="verinfo">(PECL solr >= 2.2.0)</p><p class="refpurpose"><span class="refname">SolrQuery::setExpand</span> — <span class="dc-title">Enables/Disables the Expand Component</span></p> </div> <div class="refsect1 description" id="refsect1-solrquery.setexpand-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><a href="class.solrquery.html" class="type SolrQuery">SolrQuery</a></span> <span class="methodname"><strong>SolrQuery::setExpand</strong></span> ( <span class="methodparam"><span class="type">bool</span> <code class="parameter">$value</code></span> )</div> <p class="para rdfs-comment"> Enables/Disables the Expand Component. </p> </div> <div class="refsect1 parameters" id="refsect1-solrquery.setexpand-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">value</code></dt> <dd> <p class="para"> Bool flag </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-solrquery.setexpand-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> <span class="type"><a href="class.solrquery.html" class="type SolrQuery">SolrQuery</a></span> </p> </div> <div class="refsect1 examples" id="refsect1-solrquery.setexpand-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-5891"> <p><strong>Example #1 <span class="function"><strong>SolrQuery::setExpand()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$query </span><span style="color: #007700">= new </span><span style="color: #0000BB">SolrQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'lucene'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$query<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">setExpand</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">setExpandRows</span><span style="color: #007700">(</span><span style="color: #0000BB">50</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">setExpandQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'text:product'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">addExpandFilterQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'manu:apple'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">addExpandFilterQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'inStock:true'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">addExpandSortField</span><span style="color: #007700">(</span><span style="color: #DD0000">'score'</span><span style="color: #007700">, </span><span style="color: #0000BB">SolrQuery</span><span style="color: #007700">::</span><span style="color: #0000BB">ORDER_DESC</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">addExpandSortField</span><span style="color: #007700">(</span><span style="color: #DD0000">'title'</span><span style="color: #007700">, </span><span style="color: #0000BB">SolrQuery</span><span style="color: #007700">::</span><span style="color: #0000BB">ORDER_ASC</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">$query</span><span style="color: #007700">.</span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> q=lucene&expand=true&expand.rows=50&expand.q=text:product&expand.fq=manu:apple&expand.fq=inStock:true&expand.sort=score desc,title asc </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-solrquery.setexpand-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><span class="methodname"><a href="solrquery.addexpandsortfield.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::addExpandSortField()</a> - Orders the documents within the expanded groups (expand.sort parameter)</span></li> <li class="member"><span class="methodname"><a href="solrquery.removeexpandsortfield.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::removeExpandSortField()</a> - Removes an expand sort field from the expand.sort parameter</span></li> <li class="member"><span class="methodname"><a href="solrquery.setexpandrows.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setExpandRows()</a> - Sets the number of rows to display in each group (expand.rows). Server Default 5</span></li> <li class="member"><span class="methodname"><a href="solrquery.setexpandquery.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setExpandQuery()</a> - Sets the expand.q parameter</span></li> <li class="member"><span class="methodname"><a href="solrquery.addexpandfilterquery.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::addExpandFilterQuery()</a> - Overrides main filter query, determines which documents to include in the main group</span></li> <li class="member"><span class="methodname"><a href="solrquery.removeexpandfilterquery.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::removeExpandFilterQuery()</a> - Removes an expand filter query</span></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="solrquery.setechoparams.html">SolrQuery::setEchoParams</a></div> <div class="next" style="text-align: right; float: right;"><a href="solrquery.setexpandquery.html">SolrQuery::setExpandQuery</a></div> <div class="up"><a href="class.solrquery.html">SolrQuery</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>