\Elastica\AggregationIpRange

Class IpRange.

Summary

Methods

Properties

Constants

__construct()
setField()
addRange()
addMaskRange()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: Aggregation/IpRange.php
Package: Default
Class hierarchy: \Elastica\Aggregation\AbstractAggregation

\Elastica\Aggregation\IpRange
See also: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html

__construct(string  $name, string  $field)

string	$name	the name of this aggregation
string	$field	the field on which to perform this aggregation

setField(string  $field) : $this

Set the field for this aggregation.

string

$field

the name of the document field on which to perform this aggregation

$this

addRange(string  $fromValue = null, string  $toValue = null) : $this

Add an ip range to this aggregation.

string	$fromValue	a valid ipv4 address. Low end of this range, exclusive (greater than)
string	$toValue	a valid ipv4 address. High end of this range, exclusive (less than)

$this

addMaskRange(string  $mask) : $this

Add an ip range in the form of a CIDR mask.

string

$mask

a valid CIDR mask

$this