SphinxClient::setGroupBy

(No version information available, might be only in CVS)

SphinxClient::setGroupBy — Set grouping attribute

Description

public bool SphinxClient::setGroupBy ( string $attribute , int $func [, string $groupsort ] )

Sets grouping attribute, function, and group sorting mode, and enables grouping.

Grouping feature is very similar to GROUP BY clause in SQL. Results produced by this function call are going to be the same as produced by the following pseudo code: SELECT ... GROUP BY $func($attribute) ORDER BY $groupsort.

Parameters

attribute: A string containing group-by attribute name.
func: Constant, which sets a function applied to the attribute value in order to compute group-by key.
groupsort: An optional clause controlling how the groups are sorted. Defaults to "@group desc".

Return Values

Returns TRUE on success or FALSE on failure.

SphinxClient::setGroupBy

Description

Parameters

Return Values

See Also