core_reportbuilder\local\helpers\report Class Reference

Static Public Member Functions
static	add_report_column (int $reportid, string $uniqueidentifier)
	Add given column to report.
static	add_report_condition (int $reportid, string $uniqueidentifier)
	Add given condition to report.
static	add_report_filter (int $reportid, string $uniqueidentifier)
	Add given filter to report.
static	create_report (stdClass $data, bool $default=true)
	Create custom report.
static	delete_report (int $reportid)
	Delete custom report.
static	delete_report_column (int $reportid, int $columnid)
	Delete given column from report.
static	delete_report_condition (int $reportid, int $conditionid)
	Delete given condition from report.
static	delete_report_filter (int $reportid, int $filterid)
	Delete given filter from report.
static	get_available_columns ()
static	reorder_report_column (int $reportid, int $columnid, int $position)
	Re-order given column within a report.
static	reorder_report_column_sorting (int $reportid, int $columnid, int $position)
	Re-order given column sorting within a report.
static	reorder_report_condition (int $reportid, int $conditionid, int $position)
	Re-order given condition within a report.
static	reorder_report_filter (int $reportid, int $filterid, int $position)
	Re-order given filter within a report.
static	toggle_report_column_sorting (int $reportid, int $columnid, bool $enabled, int $direction=SORT_ASC)
	Toggle sorting options for given column within a report.
static	update_report (stdClass $data)
	Update custom report.

Member Function Documentation

add_report_column()

static core_reportbuilder\local\helpers\report::add_report_column ( int $reportid, string $uniqueidentifier )

static

Add given column to report.

Parameters

int	$reportid
string	$uniqueidentifier

Return values

column

Exceptions

invalid_parameter_exception

add_report_condition()

static core_reportbuilder\local\helpers\report::add_report_condition ( int $reportid, string $uniqueidentifier )

static

Add given condition to report.

Parameters

int	$reportid
string	$uniqueidentifier

Return values

filter

Exceptions

invalid_parameter_exception

add_report_filter()

static core_reportbuilder\local\helpers\report::add_report_filter ( int $reportid, string $uniqueidentifier )

static

Add given filter to report.

Parameters

int	$reportid
string	$uniqueidentifier

Return values

filter

Exceptions

invalid_parameter_exception

create_report()

static core_reportbuilder\local\helpers\report::create_report ( stdClass $data, bool $default = true )

static

Create custom report.

Parameters

stdClass	$data
bool	$default	If $default is set to true it will populate report with default layout as defined by the selected source. These include pre-defined columns, filters and conditions.

Return values

report_model

delete_report()

static core_reportbuilder\local\helpers\report::delete_report ( int $reportid )

static

Delete custom report.

Parameters

int

$reportid

Return values

bool

Exceptions

invalid_parameter_exception

delete_report_column()

static core_reportbuilder\local\helpers\report::delete_report_column ( int $reportid, int $columnid )

static

Delete given column from report.

Parameters

int	$reportid
int	$columnid

Return values

bool

Exceptions

invalid_parameter_exception

delete_report_condition()

static core_reportbuilder\local\helpers\report::delete_report_condition ( int $reportid, int $conditionid )

static

Delete given condition from report.

Parameters

int	$reportid
int	$conditionid

Return values

bool

Exceptions

invalid_parameter_exception

delete_report_filter()

static core_reportbuilder\local\helpers\report::delete_report_filter ( int $reportid, int $filterid )

static

Delete given filter from report.

Parameters

int	$reportid
int	$filterid

Return values

bool

Exceptions

invalid_parameter_exception

get_available_columns()

static core_reportbuilder\local\helpers\report::get_available_columns ( )

static

Deprecated

since Moodle 4.1 - please do not use this function any more, {

See also

custom_report_column_cards_exporter}

reorder_report_column()

static core_reportbuilder\local\helpers\report::reorder_report_column ( int $reportid, int $columnid, int $position )

static

Re-order given column within a report.

Parameters

int	$reportid
int	$columnid
int	$position

Return values

bool

Exceptions

invalid_parameter_exception

reorder_report_column_sorting()

static core_reportbuilder\local\helpers\report::reorder_report_column_sorting ( int $reportid, int $columnid, int $position )

static

Re-order given column sorting within a report.

Parameters

int	$reportid
int	$columnid
int	$position

Return values

bool

Exceptions

invalid_parameter_exception

reorder_report_condition()

static core_reportbuilder\local\helpers\report::reorder_report_condition ( int $reportid, int $conditionid, int $position )

static

Re-order given condition within a report.

Parameters

int	$reportid
int	$conditionid
int	$position

Return values

bool

Exceptions

invalid_parameter_exception

reorder_report_filter()

static core_reportbuilder\local\helpers\report::reorder_report_filter ( int $reportid, int $filterid, int $position )

static

Re-order given filter within a report.

Parameters

int	$reportid
int	$filterid
int	$position

Return values

bool

Exceptions

invalid_parameter_exception

toggle_report_column_sorting()

static core_reportbuilder\local\helpers\report::toggle_report_column_sorting ( int $reportid, int $columnid, bool $enabled, int $direction = SORT_ASC )

static

Toggle sorting options for given column within a report.

Parameters

int	$reportid
int	$columnid
bool	$enabled
int	$direction

Return values

bool

Exceptions

invalid_parameter_exception

update_report()

static core_reportbuilder\local\helpers\report::update_report ( stdClass $data )

static

Update custom report.

Parameters

stdClass

$data

Return values

report_model

---

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

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