setBackgroundFilter() public method

The default source of statistical information for background term frequencies is the entire index and this scope can be narrowed through the use of a background_filter to focus in on significant terms within a narrower context.
See also: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html#_custom_background_context
public setBackgroundFilter ( Elastica\Query\AbstractQuery $filter )
$filter Elastica\Query\AbstractQuery
SignificantTerms Class Documentation
Example #1
0
 /**
  * @group functional
  */
 public function testSignificantTermsAggregationWithBackgroundFilter()
 {
     $agg = new SignificantTerms('significantTerms');
     $agg->setField('temperature');
     $agg->setSize(1);
     $termsFilter = new TermsFilter();
     $termsFilter->setTerms('color', array('blue', 'red', 'green', 'yellow'));
     $agg->setBackgroundFilter($termsFilter);
     $termsQuery = new Terms();
     $termsQuery->setTerms('color', array('blue', 'red', 'green', 'yellow', 'white'));
     $query = new Query($termsQuery);
     $query->addAggregation($agg);
     $results = $this->_getIndexForTest()->search($query)->getAggregation('significantTerms');
     $this->assertEquals(15, $results['buckets'][0]['doc_count']);
     $this->assertEquals(12, $results['buckets'][0]['bg_count']);
     $this->assertEquals('4500', $results['buckets'][0]['key_as_string']);
 }