PHP Class Sleimanx2\Plastic\DSL\AggregationBuilder

Show file Open project: sleimanx2/plastic

Public Properties

Property Type Description
$query ONGR\ElasticsearchDSL\Search An instance of DSL query.

Public Methods

Method Description
__construct ( ONGR\ElasticsearchDSL\Search $query = null ) Builder constructor.
append ( ONGR\ElasticsearchDSL\Aggregation\AbstractAggregation $aggregation ) Append an aggregation to the aggregation query builder.
average ( $alias, string | null $field = null, string | null $script = null ) Add an average aggregate.
cardinality ( $alias, string | null $field = null, string | null $script = null, integer $precision = null, boolean $rehash = null ) Add an cardinality aggregate.
dateRange ( $alias, $field, $format, array $ranges ) Add a date range aggregate.
geoBounds ( string $alias, null | string $field, boolean $wrap_longitude = true ) Add a geo bounds aggregate.
geoDistance ( string $alias, null | string $field, string $origin, array $ranges ) Add a geo bounds aggregate.
geoHashGrid ( string $alias, null | string $field, float $precision, null $size = null, null $shardSize = null ) Add a geo hash grid aggregate.
histogram ( $alias, string $field, integer $interval, integer $minDocCount = null, string $orderMode = null, string $orderDirection = 'asc', integer $extendedBoundsMin = null, integer $extendedBoundsMax = null, boolean $keyed = null ) Add a histogram aggregate.
ipv4Range ( $alias, null $field, array $ranges ) Add an ipv4 range aggregate.
max ( $alias, string | null $field = null, string | null $script = null ) Add an max aggregate.
min ( $alias, string | null $field = null, string | null $script = null ) Add an min aggregate.
missing ( string $alias, string $field ) Add an missing aggregate.
percentile ( $alias, string $field, $percents, null $script = null, null $compression = null ) Add an percentile aggregate.
percentileRanks ( $alias, string $field, array $values, null $script = null, null $compression = null ) Add an percentileRanks aggregate.
range ( string $alias, string $field, array $ranges, boolean $keyed = false ) Add a range aggregate.
stats ( $alias, string $field = null, string | null $script = null ) Add an stats aggregate.
sum ( $alias, string $field = null, string | null $script = null ) Add an sum aggregate.
terms ( string $alias, string | null $field = null, string | null $script = null ) Add a terms aggregate.
toDSL ( ) : array Return the DSL query.
valueCount ( $alias, string $field = null, string | null $script = null ) Add a value count aggregate.

Method Details

__construct() public method

Builder constructor.
public __construct ( ONGR\ElasticsearchDSL\Search $query = null )
$query ONGR\ElasticsearchDSL\Search

append() public method

Append an aggregation to the aggregation query builder.
public append ( ONGR\ElasticsearchDSL\Aggregation\AbstractAggregation $aggregation )
$aggregation ONGR\ElasticsearchDSL\Aggregation\AbstractAggregation

average() public method

Add an average aggregate.
public average ( $alias, string | null $field = null, string | null $script = null )
$alias
$field string | null
$script string | null

cardinality() public method

Add an cardinality aggregate.
public cardinality ( $alias, string | null $field = null, string | null $script = null, integer $precision = null, boolean $rehash = null )
$alias
$field string | null
$script string | null
$precision integer
$rehash boolean

dateRange() public method

Add a date range aggregate.
public dateRange ( $alias, $field, $format, array $ranges )
$alias
$field
$format
$ranges array

geoBounds() public method

Add a geo bounds aggregate.
public geoBounds ( string $alias, null | string $field, boolean $wrap_longitude = true )
$alias string
$field null | string
$wrap_longitude boolean

geoDistance() public method

Add a geo bounds aggregate.
public geoDistance ( string $alias, null | string $field, string $origin, array $ranges )
$alias string
$field null | string
$origin string
$ranges array

geoHashGrid() public method

Add a geo hash grid aggregate.
public geoHashGrid ( string $alias, null | string $field, float $precision, null $size = null, null $shardSize = null )
$alias string
$field null | string
$precision float
$size null
$shardSize null

histogram() public method

Add a histogram aggregate.
public histogram ( $alias, string $field, integer $interval, integer $minDocCount = null, string $orderMode = null, string $orderDirection = 'asc', integer $extendedBoundsMin = null, integer $extendedBoundsMax = null, boolean $keyed = null )
$alias
$field string
$interval integer
$minDocCount integer
$orderMode string
$orderDirection string
$extendedBoundsMin integer
$extendedBoundsMax integer
$keyed boolean

ipv4Range() public method

Add an ipv4 range aggregate.
public ipv4Range ( $alias, null $field, array $ranges )
$alias
$field null
$ranges array

max() public method

Add an max aggregate.
public max ( $alias, string | null $field = null, string | null $script = null )
$alias
$field string | null
$script string | null

min() public method

Add an min aggregate.
public min ( $alias, string | null $field = null, string | null $script = null )
$alias
$field string | null
$script string | null

missing() public method

Add an missing aggregate.
public missing ( string $alias, string $field )
$alias string
$field string

percentile() public method

Add an percentile aggregate.
public percentile ( $alias, string $field, $percents, null $script = null, null $compression = null )
$alias
$field string
$percents
$script null
$compression null

percentileRanks() public method

Add an percentileRanks aggregate.
public percentileRanks ( $alias, string $field, array $values, null $script = null, null $compression = null )
$alias
$field string
$values array
$script null
$compression null

range() public method

Add a range aggregate.
public range ( string $alias, string $field, array $ranges, boolean $keyed = false )
$alias string
$field string
$ranges array
$keyed boolean

stats() public method

Add an stats aggregate.
public stats ( $alias, string $field = null, string | null $script = null )
$alias
$field string
$script string | null

sum() public method

Add an sum aggregate.
public sum ( $alias, string $field = null, string | null $script = null )
$alias
$field string
$script string | null

terms() public method

Add a terms aggregate.
public terms ( string $alias, string | null $field = null, string | null $script = null )
$alias string
$field string | null
$script string | null

toDSL() public method

Return the DSL query.
public toDSL ( ) : array
return array

valueCount() public method

Add a value count aggregate.
public valueCount ( $alias, string $field = null, string | null $script = null )
$alias
$field string
$script string | null

Property Details

$query public property

An instance of DSL query.
public Search,ONGR\ElasticsearchDSL $query
return ONGR\ElasticsearchDSL\Search