tool_brickfield\sitedata Class Reference

Provides the Brickfield Accessibility toolkit site data API. More...

Public Member Functions
	get_checkgroup_by_course_data (filter $filter)
	Get records of check group per course summary data.
	get_checkgroup_data (filter $filter)
	Get records of check group per course summary data.
	get_checkgroup_with_failed_data (filter $filter)
	Get records of check group per course summary data.

Static Public Member Functions
static	get_component_data (filter $filter)
	Get records of component per course summary data.
static	get_total_courses_checked ()
	Return the total number of courses that have been checked.

Detailed Description

Provides the Brickfield Accessibility toolkit site data API.

Copyright

2020 onward Brickfield Education Labs Ltd, https://www.brickfield.ie

Author

Mike Churchward (mike@.nosp@m.bric.nosp@m.kfiel.nosp@m.dlab.nosp@m.s.ie)

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

get_checkgroup_by_course_data()

tool_brickfield\sitedata::get_checkgroup_by_course_data

(

filter

$filter

)

Get records of check group per course summary data.

Parameters

local\tool\filter

$filter

Return values

array

Exceptions

coding_exception
dml_exception

get_checkgroup_data()

tool_brickfield\sitedata::get_checkgroup_data

(

filter

$filter

)

Get records of check group per course summary data.

Parameters

local\tool\filter

$filter

Return values

array

Exceptions

coding_exception
dml_exception

get_checkgroup_with_failed_data()

tool_brickfield\sitedata::get_checkgroup_with_failed_data

(

filter

$filter

)

Get records of check group per course summary data.

Parameters

local\tool\filter

$filter

Return values

array

Exceptions

coding_exception
dml_exception

get_component_data()

static tool_brickfield\sitedata::get_component_data ( filter $filter )

static

Get records of component per course summary data.

Parameters

local\tool\filter

$filter

Return values

array

Exceptions

coding_exception
dml_exception

get_total_courses_checked()

static tool_brickfield\sitedata::get_total_courses_checked ( )

static

Return the total number of courses that have been checked.

Return values

int

Exceptions

dml_exception

---

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

• admin/tool/brickfield/classes/sitedata.php