PHP Класс Elastica\Aggregation\AbstractAggregation

Наследование: extends Elastica\Param
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_aggs Subaggregations belonging to this aggregation
$_name The name of this aggregation

Открытые методы

Метод Описание
__construct ( string $name )
addAggregation ( AbstractAggregation $aggregation ) Add a sub-aggregation.
getAggs ( ) : array Retrieve all subaggregations belonging to this aggregation.
getName ( ) : string Retrieve the name of this aggregation.
setName ( string $name ) Set the name of this aggregation.
toArray ( ) : array

Описание методов

__construct() публичный Метод

public __construct ( string $name )
$name string the name of this aggregation

addAggregation() публичный Метод

Add a sub-aggregation.
public addAggregation ( AbstractAggregation $aggregation )
$aggregation AbstractAggregation

getAggs() публичный Метод

Retrieve all subaggregations belonging to this aggregation.
public getAggs ( ) : array
Результат array

getName() публичный Метод

Retrieve the name of this aggregation.
public getName ( ) : string
Результат string

setName() публичный Метод

Set the name of this aggregation.
public setName ( string $name )
$name string

toArray() публичный Метод

public toArray ( ) : array
Результат array

Описание свойств

$_aggs защищенное свойство

Subaggregations belonging to this aggregation
protected $_aggs

$_name защищенное свойство

The name of this aggregation
protected $_name