Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]

(no description)

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

Defines 1 class

system_report_table:: (8 methods):
  __construct()
  load_report_instance()
  create()
  set_filterset()
  get_row_class()
  format_row()
  format_row_actions()
  download_buttons()


Class: system_report_table  - X-Ref

System report dynamic table class

__construct(string $uniqueid, array $parameters = [])   X-Ref
Table constructor. Note that the passed unique ID value must match the pattern "system-report-table-(\d+)" so that
dynamic updates continue to load the same report

param: string $uniqueid
param: array $parameters

load_report_instance(int $reportid, array $parameters)   X-Ref
Load the report persistent, and accompanying system report instance.

param: int $reportid
param: array $parameters

create(int $reportid, array $parameters)   X-Ref
Return a new instance of the class for given report ID. We include report parameters here so they are present during
initialisation

param: int $reportid
param: array $parameters
return: static

set_filterset(filterset $filterset)   X-Ref
Set the filterset in the table class. We set the report parameters here so that they are persisted while paging

param: filterset $filterset

get_row_class($row)   X-Ref
Override parent method for retrieving row class with that defined by the system report

param: array|stdClass $row
return: string

format_row($row)   X-Ref
Format each row of returned data, executing defined callbacks for the row and each column

param: array|stdClass $row
return: array

format_row_actions(stdClass $row)   X-Ref
Return formatted actions column for the row

param: stdClass $row
return: string

download_buttons()   X-Ref
Get the html for the download buttons

return: string