<!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>The SolrCollapseFunction class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrdismaxquery.useedismaxqueryparser.html">SolrDisMaxQuery::useEDisMaxQueryParser</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrcollapsefunction.construct.html">SolrCollapseFunction::__construct</a></div>
<div class="up"><a href="book.solr.html">Solr</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.solrcollapsefunction" class="reference">
<h1 class="title">The SolrCollapseFunction class</h1>
<div class="partintro"><p class="verinfo">(PECL solr >= 2.2.0)</p>
<div class="section" id="solrcollapsefunction.intro">
<h2 class="title">Introduction</h2>
<p class="para">
</p>
</div>
<div class="section" id="solrcollapsefunction.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">SolrCollapseFunction</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">string</span>
<var class="fieldsynopsis_varname"><a href="class.solrcollapsefunction.html#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">string</span>
<var class="fieldsynopsis_varname"><a href="class.solrcollapsefunction.html#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">string</span>
<var class="fieldsynopsis_varname"><a href="class.solrcollapsefunction.html#solrcollapsefunction.constants.nullpolicy-collapse"><var class="varname">NULLPOLICY_COLLAPSE</var></a></var>
<span class="initializer"> = collapse</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="constructorsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="solrcollapsefunction.construct.html" class="methodname">__construct</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$field</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrcollapsefunction.getfield.html" class="methodname">getField</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrcollapsefunction.gethint.html" class="methodname">getHint</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrcollapsefunction.getmax.html" class="methodname">getMax</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrcollapsefunction.getmin.html" class="methodname">getMin</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrcollapsefunction.getnullpolicy.html" class="methodname">getNullPolicy</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="solrcollapsefunction.getsize.html" class="methodname">getSize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">SolrCollapseFunction</span> <span class="methodname"><a href="solrcollapsefunction.setfield.html" class="methodname">setField</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$fieldName</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">SolrCollapseFunction</span> <span class="methodname"><a href="solrcollapsefunction.sethint.html" class="methodname">setHint</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$hint</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">SolrCollapseFunction</span> <span class="methodname"><a href="solrcollapsefunction.setmax.html" class="methodname">setMax</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$max</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">SolrCollapseFunction</span> <span class="methodname"><a href="solrcollapsefunction.setmin.html" class="methodname">setMin</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$min</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">SolrCollapseFunction</span> <span class="methodname"><a href="solrcollapsefunction.setnullpolicy.html" class="methodname">setNullPolicy</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$nullPolicy</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">SolrCollapseFunction</span> <span class="methodname"><a href="solrcollapsefunction.setsize.html" class="methodname">setSize</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrcollapsefunction.tostring.html" class="methodname">__toString</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
<div class="section" id="solrcollapsefunction.constants">
<h2 class="title">Predefined Constants</h2>
<dl>
<dt id="solrcollapsefunction.constants.nullpolicy-ignore"><strong><code>SolrCollapseFunction::NULLPOLICY_IGNORE</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="solrcollapsefunction.constants.nullpolicy-expand"><strong><code>SolrCollapseFunction::NULLPOLICY_EXPAND</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="solrcollapsefunction.constants.nullpolicy-collapse"><strong><code>SolrCollapseFunction::NULLPOLICY_COLLAPSE</code></strong></dt>
<dd>
<p class="para"/>
</dd>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="solrcollapsefunction.construct.html">SolrCollapseFunction::__construct</a> — Constructor</li><li><a href="solrcollapsefunction.getfield.html">SolrCollapseFunction::getField</a> — Returns the field that is being collapsed on</li><li><a href="solrcollapsefunction.gethint.html">SolrCollapseFunction::getHint</a> — Returns collapse hint</li><li><a href="solrcollapsefunction.getmax.html">SolrCollapseFunction::getMax</a> — Returns max parameter</li><li><a href="solrcollapsefunction.getmin.html">SolrCollapseFunction::getMin</a> — Returns min parameter</li><li><a href="solrcollapsefunction.getnullpolicy.html">SolrCollapseFunction::getNullPolicy</a> — Returns null policy</li><li><a href="solrcollapsefunction.getsize.html">SolrCollapseFunction::getSize</a> — Returns size parameter</li><li><a href="solrcollapsefunction.setfield.html">SolrCollapseFunction::setField</a> — Sets the field to collapse on</li><li><a href="solrcollapsefunction.sethint.html">SolrCollapseFunction::setHint</a> — Sets collapse hint</li><li><a href="solrcollapsefunction.setmax.html">SolrCollapseFunction::setMax</a> — Selects the group heads by the max value of a numeric field or function query</li><li><a href="solrcollapsefunction.setmin.html">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.html">SolrCollapseFunction::setNullPolicy</a> — Sets the NULL Policy</li><li><a href="solrcollapsefunction.setsize.html">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.html">SolrCollapseFunction::__toString</a> — Returns a string representing the constructed collapse function</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrdismaxquery.useedismaxqueryparser.html">SolrDisMaxQuery::useEDisMaxQueryParser</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrcollapsefunction.construct.html">SolrCollapseFunction::__construct</a></div>
<div class="up"><a href="book.solr.html">Solr</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
