addAggregateColumn() function - Documentation for SproutCMS

function addAggregateColumn()

Add an aggregate which operates on the values of a column

File: /sprout/Helpers/Itemlist.php, line 345
Namespace: Sprout\Helpers
Class: Itemlist

Usage

void $Itemlist->addAggregateColumn ( string $title , string $operation [, ColModifier $modifier ] );

Arguments

string $title
```
Column to aggregate values of
```

string $operation

Aggregation operation, 'sum', 'count', 'avg'

ColModifier $modifier = NULL

Column modifier applied after aggregation to format the result

Exceptions thrown

InvalidArgumentException
```
Unknown operation
```

Return value

void