SolrQuery::setExpand

Enables/Disables the Expand Component

Description

public SolrQuery SolrQuery::setExpand(bool $value)

Enables/Disables the Expand Component.

Parameters

value

Bool flag

Return Values

SolrQuery

Examples

Example #1 SolrQuery::setExpand example

<?php

$query = new SolrQuery('lucene');

$query
    ->setExpand(true)
    ->setExpandRows(50)
    ->setExpandQuery('text:product')
    ->addExpandFilterQuery('manu:apple')
    ->addExpandFilterQuery('inStock:true')
    ->addExpandSortField('score', SolrQuery::ORDER_DESC)
    ->addExpandSortField('title', SolrQuery::ORDER_ASC);

echo $query.PHP_EOL;

?>

The above example will output something similar to:

q=lucene&expand=true&expand.rows=50&expand.q=text:product&expand.fq=manu:apple&expand.fq=inStock:true&expand.sort=score desc,title asc

See Also

  • SolrQuery::addExpandSortField
  • SolrQuery::removeExpandSortField
  • SolrQuery::setExpandRows
  • SolrQuery::setExpandQuery
  • SolrQuery::addExpandFilterQuery
  • SolrQuery::removeExpandFilterQuery