Php/docs/class.solrcollapsefunction

• PHP Manual
• Solr
• The SolrCollapseFunction class

(PECL solr >= 2.2.0)

Class synopsis

SolrCollapseFunction {

/* Constants */

const string NULLPOLICY_IGNORE = ignore

const string NULLPOLICY_EXPAND = expand

const string NULLPOLICY_COLLAPSE = collapse

/* Methods */

public __construct ([ string $field ] )

public getField ( ) : string

public getHint ( ) : string

public getMax ( ) : string

public getMin ( ) : string

public getNullPolicy ( ) : string

public getSize ( ) : int

public setField ( string $fieldName ) : SolrCollapseFunction

public setHint ( string $hint ) : SolrCollapseFunction

public setMax ( string $max ) : SolrCollapseFunction

public setMin ( string $min ) : SolrCollapseFunction

public setNullPolicy ( string $nullPolicy ) : SolrCollapseFunction

public setSize ( int $size ) : SolrCollapseFunction

public __toString ( ) : string

}

Predefined Constants

SolrCollapseFunction::NULLPOLICY_IGNORE

SolrCollapseFunction::NULLPOLICY_EXPAND

SolrCollapseFunction::NULLPOLICY_COLLAPSE

Table of Contents

• SolrCollapseFunction::__construct — Constructor
• SolrCollapseFunction::getField — Returns the field that is being collapsed on
• SolrCollapseFunction::getHint — Returns collapse hint
• SolrCollapseFunction::getMax — Returns max parameter
• SolrCollapseFunction::getMin — Returns min parameter
• SolrCollapseFunction::getNullPolicy — Returns null policy
• SolrCollapseFunction::getSize — Returns size parameter
• SolrCollapseFunction::setField — Sets the field to collapse on
• SolrCollapseFunction::setHint — Sets collapse hint
• SolrCollapseFunction::setMax — Selects the group heads by the max value of a numeric field or function query
• SolrCollapseFunction::setMin — Sets the initial size of the collapse data structures when collapsing on a numeric field only
• SolrCollapseFunction::setNullPolicy — Sets the NULL Policy
• SolrCollapseFunction::setSize — Sets the initial size of the collapse data structures when collapsing on a numeric field only
• SolrCollapseFunction::__toString — Returns a string representing the constructed collapse function