<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.solr.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'class.solrcollapsefunction.php',
    1 => 'SolrCollapseFunction',
    2 => 'The SolrCollapseFunction class',
  ),
  'up' => 
  array (
    0 => 'book.solr.php',
    1 => 'Solr',
  ),
  'prev' => 
  array (
    0 => 'solrdismaxquery.useedismaxqueryparser.php',
    1 => 'SolrDisMaxQuery::useEDisMaxQueryParser',
  ),
  'next' => 
  array (
    0 => 'solrcollapsefunction.construct.php',
    1 => 'SolrCollapseFunction::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/solr/solrcollapsefunction.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.solrcollapsefunction.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.solrcollapsefunction" class="reference">

 <h1 class="title">The SolrCollapseFunction class</h1>
 

 <div class="partintro"><p class="verinfo">(PECL solr &gt;= 2.2.0)</p>


  <div class="section" id="solrcollapsefunction.intro">
   <h2 class="title">简介</h2>
   <p class="para">

   </p>
  </div>


  <div class="section" id="solrcollapsefunction.synopsis">
   <h2 class="title">类摘要</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">SolrCollapseFunction</strong>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 常量 */</div>
    <div class="fieldsynopsis">
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.solrcollapsefunction.php#solrcollapsefunction.constants.nullpolicy-ignore"><var class="varname">NULLPOLICY_IGNORE</var></a></var><span class="initializer"> = ignore</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.solrcollapsefunction.php#solrcollapsefunction.constants.nullpolicy-expand"><var class="varname">NULLPOLICY_EXPAND</var></a></var><span class="initializer"> = expand</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.solrcollapsefunction.php#solrcollapsefunction.constants.nullpolicy-collapse"><var class="varname">NULLPOLICY_COLLAPSE</var></a></var><span class="initializer"> = collapse</span>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.construct.php" class="methodname">__construct</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$field</code><span class="initializer"> = ?</span></span>)</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.getfield.php" class="methodname">getField</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.gethint.php" class="methodname">getHint</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.getmax.php" class="methodname">getMax</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.getmin.php" class="methodname">getMin</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.getnullpolicy.php" class="methodname">getNullPolicy</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.getsize.php" class="methodname">getSize</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.setfield.php" class="methodname">setField</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>): <span class="type"><a href="class.solrcollapsefunction.php" class="type SolrCollapseFunction">SolrCollapseFunction</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.sethint.php" class="methodname">setHint</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$hint</code></span>): <span class="type"><a href="class.solrcollapsefunction.php" class="type SolrCollapseFunction">SolrCollapseFunction</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.setmax.php" class="methodname">setMax</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$max</code></span>): <span class="type"><a href="class.solrcollapsefunction.php" class="type SolrCollapseFunction">SolrCollapseFunction</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.setmin.php" class="methodname">setMin</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$min</code></span>): <span class="type"><a href="class.solrcollapsefunction.php" class="type SolrCollapseFunction">SolrCollapseFunction</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.setnullpolicy.php" class="methodname">setNullPolicy</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$nullPolicy</code></span>): <span class="type"><a href="class.solrcollapsefunction.php" class="type SolrCollapseFunction">SolrCollapseFunction</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.setsize.php" class="methodname">setSize</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$size</code></span>): <span class="type"><a href="class.solrcollapsefunction.php" class="type SolrCollapseFunction">SolrCollapseFunction</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.tostring.php" class="methodname">__toString</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

   }</div>


  </div>


  <div class="section" id="solrcollapsefunction.constants">
   <h2 class="title">预定义常量</h2>
   <dl>

    
     <dt id="solrcollapsefunction.constants.nullpolicy-ignore"><strong><code><a href="class.solrcollapsefunction.php#solrcollapsefunction.constants.nullpolicy-ignore">SolrCollapseFunction::NULLPOLICY_IGNORE</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="solrcollapsefunction.constants.nullpolicy-expand"><strong><code><a href="class.solrcollapsefunction.php#solrcollapsefunction.constants.nullpolicy-expand">SolrCollapseFunction::NULLPOLICY_EXPAND</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="solrcollapsefunction.constants.nullpolicy-collapse"><strong><code><a href="class.solrcollapsefunction.php#solrcollapsefunction.constants.nullpolicy-collapse">SolrCollapseFunction::NULLPOLICY_COLLAPSE</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

   </dl>
  </div>



 </div>

 


































































































<h2>目录</h2><ul class="chunklist chunklist_reference"><li><a href="solrcollapsefunction.construct.php">SolrCollapseFunction::__construct</a> — Constructor</li><li><a href="solrcollapsefunction.getfield.php">SolrCollapseFunction::getField</a> — Returns the field that is being collapsed on</li><li><a href="solrcollapsefunction.gethint.php">SolrCollapseFunction::getHint</a> — Returns collapse hint</li><li><a href="solrcollapsefunction.getmax.php">SolrCollapseFunction::getMax</a> — Returns max parameter</li><li><a href="solrcollapsefunction.getmin.php">SolrCollapseFunction::getMin</a> — Returns min parameter</li><li><a href="solrcollapsefunction.getnullpolicy.php">SolrCollapseFunction::getNullPolicy</a> — Returns null policy</li><li><a href="solrcollapsefunction.getsize.php">SolrCollapseFunction::getSize</a> — Returns size parameter</li><li><a href="solrcollapsefunction.setfield.php">SolrCollapseFunction::setField</a> — Sets the field to collapse on</li><li><a href="solrcollapsefunction.sethint.php">SolrCollapseFunction::setHint</a> — Sets collapse hint</li><li><a href="solrcollapsefunction.setmax.php">SolrCollapseFunction::setMax</a> — Selects the group heads by the max value of a numeric field or function query</li><li><a href="solrcollapsefunction.setmin.php">SolrCollapseFunction::setMin</a> — Sets the initial size of the collapse data structures when collapsing on a numeric field only</li><li><a href="solrcollapsefunction.setnullpolicy.php">SolrCollapseFunction::setNullPolicy</a> — Sets the NULL Policy</li><li><a href="solrcollapsefunction.setsize.php">SolrCollapseFunction::setSize</a> — Sets the initial size of the collapse data structures when collapsing on a numeric field only</li><li><a href="solrcollapsefunction.tostring.php">SolrCollapseFunction::__toString</a> — Returns a string representing the constructed collapse function</li></ul>
</div>
<?php manual_footer($setup); ?>