PHP: SolrQuery::addGroupSortField

Description

public SolrQuery::addGroupSortField(string $field, int $order = ?): SolrQuery

Allow sorting group documents, using group sort field (group.sort parameter).

Parameters

field: Field name
order: Order ASC/DESC, utilizes SolrQuery::ORDER_* constants

Return Values

Examples

Example #1 SolrQuery::addGroupSortField() example

<?php

$solrQuery = new SolrQuery('*:*');
$solrQuery
    ->setGroup(true)
    ->addGroupSortField('price', SolrQuery::ORDER_ASC);
    
echo $solrQuery; 
?>

The above example will output something similar to:

q=*:*&group=true&group.sort=price asc

SolrQuery::setGroup() - Enable/Disable result grouping (group parameter)
SolrQuery::addGroupField() - Add a field to be used to group results
SolrQuery::addGroupFunction() - Allows grouping results based on the unique values of a function query (group.func parameter)
SolrQuery::addGroupQuery() - Allows grouping of documents that match the given query
SolrQuery::setGroupFacet() - Sets group.facet parameter
SolrQuery::setGroupOffset() - Sets the group.offset parameter
SolrQuery::setGroupLimit() - Specifies the number of results to return for each group. The server default value is 1
SolrQuery::setGroupMain() - If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple
SolrQuery::setGroupNGroups() - If true, Solr includes the number of groups that have matched the query in the results
SolrQuery::setGroupTruncate() - If true, facet counts are based on the most relevant document of each group matching the query
SolrQuery::setGroupFormat() - Sets the group format, result structure (group.format parameter)
SolrQuery::setGroupCachePercent() - Enables caching for result grouping

SolrQuery::addGroupSortField

Description

Parameters

Return Values

Examples

See Also

Found A Problem?

User Contributed Notes