core_reportbuilder\local\helpers\aggregation Class Reference

Static Public Member Functions
static	get_aggregations ()
	Return list of all available/valid aggregation types.
static	get_column_aggregations (int $columntype, array $exclude=[])
	Get available aggregation types for given column type.
static	get_full_classpath (string $aggregation)
	Helper method to convert aggregation class name into fully qualified namespaced class.
static	valid (string $aggregationclass)
	Validate whether given class is a valid aggregation type.

Member Function Documentation

get_aggregations()

static core_reportbuilder\local\helpers\aggregation::get_aggregations ( )

static

Return list of all available/valid aggregation types.

Return values

base[]

get_column_aggregations()

static core_reportbuilder\local\helpers\aggregation::get_column_aggregations ( int $columntype, array $exclude = [] )

static

Get available aggregation types for given column type.

Parameters

int	$columntype
array	$exclude	List of types to exclude, e.g. ['min', 'sum']

Return values

string[]

Aggregation types indexed by [shortname => name]

get_full_classpath()

static core_reportbuilder\local\helpers\aggregation::get_full_classpath ( string $aggregation )

static

Helper method to convert aggregation class name into fully qualified namespaced class.

Parameters

string

$aggregation

Return values

string

valid()

static core_reportbuilder\local\helpers\aggregation::valid ( string $aggregationclass )

static

Validate whether given class is a valid aggregation type.

Parameters

string

$aggregationclass

Fully qualified namespaced class, see {

See also

get_full_classpath} for converting value stored in column persistent to full path

Return values

bool

---

The documentation for this class was generated from the following file:

• reportbuilder/classes/local/helpers/aggregation.php