Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

(no description)

File Size: 89 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

aggregation:: (4 methods):
  get_full_classpath()
  valid()
  get_aggregations()
  get_column_aggregations()


Class: aggregation  - X-Ref

Helper class for column aggregation related methods

get_full_classpath(string $aggregation)   X-Ref
Helper method to convert aggregation class name into fully qualified namespaced class

param: string $aggregation
return: string

valid(string $aggregationclass)   X-Ref
Validate whether given class is a valid aggregation type

param: string $aggregationclass Fully qualified namespaced class, see {@see get_full_classpath} for converting value
return: bool

get_aggregations()   X-Ref
Return list of all available/valid aggregation types

return: base[]

get_column_aggregations(int $columntype, array $exclude = [])   X-Ref
Get available aggregation types for given column type

param: int $columntype
param: array $exclude List of types to exclude, e.g. ['min', 'sum']
return: string[] Aggregation types indexed by [shortname => name]