SolrCollapseFunction

class SolrCollapseFunction (View source)

(PECL solr >= 2.2.0)
Class SolrCollapseFunction

Constants

NULLPOLICY_IGNORE

NULLPOLICY_EXPAND

NULLPOLICY_COLLAPSE

Methods

__construct(string $field)

(PECL solr >= 2.2.0)
SolrCollapseFunction constructor.

string
getField()

(PECL solr >= 2.2.0)
Returns the field that is being collapsed on.

string
getHint()

(PECL solr >= 2.2.0)
Returns collapse hint

string
getMax()

(PECL solr >= 2.2.0)
Returns max parameter

string
getMin()

(PECL solr >= 2.2.0)
Returns min parameter

string
getNullPolicy()

(PECL solr >= 2.2.0)
Returns null policy

int
getSize()

(PECL solr >= 2.2.0)
Returns size parameter

SolrCollapseFunction
setField(string $fieldName)

(PECL solr >= 2.2.0)
Sets the field to collapse on

SolrCollapseFunction
setHint(string $hint)

(PECL solr >= 2.2.0)
Sets collapse hint

SolrCollapseFunction
setMax(string $max)

(PECL solr >= 2.2.0)
Selects the group heads by the max value of a numeric field or function query.

SolrCollapseFunction
setMin(string $min)

(PECL solr >= 2.2.0)
Sets the initial size of the collapse data structures when collapsing on a numeric field only

SolrCollapseFunction
setNullPolicy(string $nullPolicy)

(PECL solr >= 2.2.0)
Sets the NULL Policy

SolrCollapseFunction
setSize(int $size)

(PECL solr >= 2.2.0)
Sets the initial size of the collapse data structures when collapsing on a numeric field only.

string
__toString()

(PECL solr >= 2.2.0)
Returns a string representing the constructed collapse function

Details

at line 34
__construct(string $field)

(PECL solr >= 2.2.0)
SolrCollapseFunction constructor.

Parameters

string $field

[optional]

The field name to collapse on.
In order to collapse a result. The field type must be a single valued String, Int or Float.

at line 42
string getField()

(PECL solr >= 2.2.0)
Returns the field that is being collapsed on.

Return Value

string

at line 50
string getHint()

(PECL solr >= 2.2.0)
Returns collapse hint

Return Value

string

at line 58
string getMax()

(PECL solr >= 2.2.0)
Returns max parameter

Return Value

string

at line 66
string getMin()

(PECL solr >= 2.2.0)
Returns min parameter

Return Value

string

at line 74
string getNullPolicy()

(PECL solr >= 2.2.0)
Returns null policy

Return Value

string

at line 82
int getSize()

(PECL solr >= 2.2.0)
Returns size parameter

Return Value

int

at line 94
SolrCollapseFunction setField(string $fieldName)

(PECL solr >= 2.2.0)
Sets the field to collapse on

Parameters

string $fieldName

The field name to collapse on. In order to collapse a result. The field type must be a single valued String, Int or Float.

Return Value

SolrCollapseFunction

at line 105
SolrCollapseFunction setHint(string $hint)

(PECL solr >= 2.2.0)
Sets collapse hint

Parameters

string $hint

Currently there is only one hint available "top_fc", which stands for top level FieldCache

Return Value

SolrCollapseFunction

at line 114
SolrCollapseFunction setMax(string $max)

(PECL solr >= 2.2.0)
Selects the group heads by the max value of a numeric field or function query.

Parameters

string $max

Return Value

SolrCollapseFunction

at line 123
SolrCollapseFunction setMin(string $min)

(PECL solr >= 2.2.0)
Sets the initial size of the collapse data structures when collapsing on a numeric field only

Parameters

string $min

Return Value

SolrCollapseFunction

at line 132
SolrCollapseFunction setNullPolicy(string $nullPolicy)

(PECL solr >= 2.2.0)
Sets the NULL Policy

Parameters

string $nullPolicy

Return Value

SolrCollapseFunction

at line 141
SolrCollapseFunction setSize(int $size)

(PECL solr >= 2.2.0)
Sets the initial size of the collapse data structures when collapsing on a numeric field only.

Parameters

int $size

Return Value

SolrCollapseFunction

at line 149
string __toString()

(PECL solr >= 2.2.0)
Returns a string representing the constructed collapse function

Return Value

string