<?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 => 'ja',
  ),
  'this' => 
  array (
    0 => 'solrquery.setexpand.php',
    1 => 'SolrQuery::setExpand',
    2 => 'Enables/Disables the Expand Component',
  ),
  'up' => 
  array (
    0 => 'class.solrquery.php',
    1 => 'SolrQuery',
  ),
  'prev' => 
  array (
    0 => 'solrquery.setechoparams.php',
    1 => 'SolrQuery::setEchoParams',
  ),
  'next' => 
  array (
    0 => 'solrquery.setexpandquery.php',
    1 => 'SolrQuery::setExpandQuery',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/solr/solrquery/setexpand.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="solrquery.setexpand" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SolrQuery::setExpand</h1>
  <p class="verinfo">(PECL solr &gt;= 2.2.0)</p><p class="refpurpose"><span class="refname">SolrQuery::setExpand</span> &mdash; <span class="dc-title">Enables/Disables the Expand Component</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-solrquery.setexpand-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>SolrQuery::setExpand</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$value</code></span>): <span class="type"><a href="class.solrquery.php" class="type SolrQuery">SolrQuery</a></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">パラメータ</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">戻り値</h3>
  <p class="para">
   <span class="type"><a href="class.solrquery.php" class="type SolrQuery">SolrQuery</a></span>
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-solrquery.setexpand-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例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">&lt;?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">-&gt;</span><span style="color: #0000BB">setExpand</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">)<br />    -&gt;</span><span style="color: #0000BB">setExpandRows</span><span style="color: #007700">(</span><span style="color: #0000BB">50</span><span style="color: #007700">)<br />    -&gt;</span><span style="color: #0000BB">setExpandQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'text:product'</span><span style="color: #007700">)<br />    -&gt;</span><span style="color: #0000BB">addExpandFilterQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'manu:apple'</span><span style="color: #007700">)<br />    -&gt;</span><span style="color: #0000BB">addExpandFilterQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'inStock:true'</span><span style="color: #007700">)<br />    -&gt;</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 />    -&gt;</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">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>上の例の出力は、
たとえば以下のようになります。</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">q=lucene&amp;expand=true&amp;expand.rows=50&amp;expand.q=text:product&amp;expand.fq=manu:apple&amp;expand.fq=inStock:true&amp;expand.sort=score desc,title asc</pre>
</div>
   </div>
  </div>
 </div>



 <div class="refsect1 seealso" id="refsect1-solrquery.setexpand-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="solrquery.addexpandsortfield.php" class="methodname" rel="rdfs-seeAlso">SolrQuery::addExpandSortField()</a> - Orders the documents within the expanded groups (expand.sort parameter)</span></li>
   <li><span class="methodname"><a href="solrquery.removeexpandsortfield.php" class="methodname" rel="rdfs-seeAlso">SolrQuery::removeExpandSortField()</a> - Removes an expand sort field from the expand.sort parameter</span></li>
   <li><span class="methodname"><a href="solrquery.setexpandrows.php" 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><span class="methodname"><a href="solrquery.setexpandquery.php" class="methodname" rel="rdfs-seeAlso">SolrQuery::setExpandQuery()</a> - Sets the expand.q parameter</span></li>
   <li><span class="methodname"><a href="solrquery.addexpandfilterquery.php" class="methodname" rel="rdfs-seeAlso">SolrQuery::addExpandFilterQuery()</a> - Overrides main filter query, determines which documents to include in the main group</span></li>
   <li><span class="methodname"><a href="solrquery.removeexpandfilterquery.php" class="methodname" rel="rdfs-seeAlso">SolrQuery::removeExpandFilterQuery()</a> - Removes an expand filter query</span></li>
  </ul>
 </div>


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