Class providing an API for the grader report building and displaying. More...

Inheritance diagram for grade_report_grader:

Public Member Functions
	__construct ($courseid, $gpr, $context, $page=null, $sortitemid=null)
	Constructor. More...

	get_grade_table ($displayaverages=false)
	Depending on the style of report (fixedstudents vs traditional one-table), arranges the rows of data in one or two tables, and returns the output of these tables in HTML. More...

	get_lang_string ($strcode, $section=null)
	First checks the cached language strings, then returns match if found, or uses get_string() to get it from the DB, caches it then returns it. More...

	get_left_avg_row ($rows=array(), $colspan=1, $groupavg=false)
	Builds and return the headers for the rows of averages, for the left part of the grader report. More...

	get_left_icons_row ($rows=array(), $colspan=1)
	Builds and return the row of icons for the left side of the report. More...

	get_left_range_row ($rows=array(), $colspan=1)
	Builds and return the header for the row of ranges, for the left part of the grader report. More...

	get_left_rows ($displayaverages)
	Builds and returns the rows that will make up the left part of the grader report This consists of student names and icons, links to user reports and id numbers, as well as header cells for these columns. More...

	get_numusers ($groups=true, $users=false)
	Fetches and returns a count of all the users that will be shown on this page. More...

	get_pref ($pref, $objectid=null)
	Given the name of a user preference (without grade_report_ prefix), locally saves then returns the value of that preference. More...

	get_right_avg_row ($rows=array(), $grouponly=false)
	Builds and return the row of averages for the right part of the grader report. More...

	get_right_icons_row ($rows=array())
	Builds and return the row of icons when editing is on, for the right part of the grader report. More...

	get_right_range_row ($rows=array())
	Builds and return the row of ranges for the right part of the grader report. More...

	get_right_rows ($displayaverages)
	Builds and returns the rows that will make up the right part of the grader report. More...

	get_sort_arrows (array $extrafields=array())
	Refactored function for generating HTML of sorting links with matching arrows. More...

	get_students_per_page ()
	Returns the maximum number of students to be displayed on each page. More...

	get_toggles_html ()
	Gets html toggle. More...

	load_final_grades ()
	we supply the userids in this query, and get all the grades pulls out all the grades, this does not need to worry about paging

	load_users ()
	pulls out the userids of the users to be display, and sorts them

	print_toggle ($type)
	Prints html toggle. More...

	process_action ($target, $action)
	Processes a single action against a category, grade_item or grade. More...

	process_data ($data)
	Processes the data sent by the form (grades and feedbacks). More...

	set_pref ($pref, $pref_value='default', $itemid=null)
	Uses set_user_preferences() to update the value of a user preference. More...

	setup_users ()
	Sets up this report's user criteria to restrict the selection of users to display.

Static Public Member Functions
static	do_process_action ($target, $action, $courseid=null)
	Processes a single action against a category, grade_item or grade. More...

static	supports_mygrades ()
	Shows support for being used as a 'Grades' report.

Public Attributes
string	$baseurl
	base url for sorting by first/last name. More...

boolean	$canviewhidden
	Capability check caching $canviewhidden.

array	$collapsed
	List of collapsed categories from user preference $collapsed.

context	$context
	The context. More...

object	$course
	The course. More...

int	$courseid
	The courseid. More...

int	$currentgroup
	The current group being displayed. More...

string	$currentgroupname
	The current groupname being displayed. More...

object	$gpr
	Grade plugin return tracking object. More...

string	$gradebookroles
	The roles for this report. More...

array	$grades
	The final grades. More...

array	$gradeserror = array()
	Array of errors for bulk grades updating. More...

string	$group_selector
	A HTML select element used to select the current group. More...

int	$groupmode
	Current course group mode $groupmode.

grade_tree	$gtree
	The grade_tree object. More...

array	$lang_strings = array()
	Array of cached language strings (using get_string() all the time takes a long time!). More...

int	$page
	Current page (for paging). More...

string	$pbarurl
	base url for paging. More...

array	$prefs = array()
	User preferences related to this report. More...

int	$rowcount = 0
	A count of the rows, used for css classes. More...

int	$sortitemid
	The id of the grade_item by which this report will be sorted. More...

int	$sortorder
	Sortorder used in the SQL selections. More...

string	$userselect
	An SQL fragment affecting the search for users. More...

array	$userselectparams = array()
	The bound params for $userselect $userselectparams.

Protected Member Functions
	blank_hidden_total ($courseid, $course_item, $finalgrade)
	Optionally blank out course/category totals if they contain any hidden items. More...

	blank_hidden_total_and_adjust_bounds ($courseid, $course_item, $finalgrade)
	Optionally blank out course/category totals if they contain any hidden items. More...

	get_allgradeitems ()
	Load all grade items.

	get_collapsing_icon ($element)
	Given a category element returns collapsing +/- icon if available. More...

	get_course_header ($element)
	Given element category, create a collapsible icon and course header. More...

	get_icons ($element)
	Given a grade_category, grade_item or grade_grade, this function figures out the state of the object and builds then returns a div with the icons needed for the grader report. More...

	get_sort_arrow ($direction='move', $sortlink=null)
	Returns an arrow icon inside an tag, for the purpose of sorting a column. More...

	setup_groups ()
	Sets up this object's group variables, mainly to restrict the selection of users to display.

Static Protected Member Functions
static	filter_collapsed_categories ($courseid, $collapsed)
	From the list of categories that this user prefers to collapse choose ones that belong to the current course. More...

static	get_collapsed_preferences ($courseid)
	Returns the list of categories that this user wants to collapse or display aggregatesonly. More...

static	set_collapsed_preferences ($courseid, $collapsed)
	Sets the list of categories that user wants to see collapsed in user preferences. More...

Protected Attributes
int	$feedback_trunc_length = 50
	Length at which feedback will be truncated (to the nearest word) and an ellipsis be added. More...

string	$groupsql
	An SQL fragment used to add linking information to the group tables. More...

string	$groupwheresql
	An SQL constraint to append to the queries used by this object to build the report. More...

array	$groupwheresql_params = array()
	The ordered params for $groupwheresql $groupwheresql_params.

bool	$overridecat
	Allow category grade overriding $overridecat.

string	$userwheresql
	An SQL constraint to append to the queries used by this object to build the report. More...

array	$userwheresql_params = array()
	The ordered params for $userwheresql $userwheresql_params.

Detailed Description

Class providing an API for the grader report building and displaying.

@uses grade_report

Copyright: 2007 Nicolas Connault

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

Constructor & Destructor Documentation

◆ __construct()

grade_report_grader::__construct	(	$courseid,
		$gpr,
		$context,
		$page = `null`,
		$sortitemid = `null`
	)

Constructor.

Sets local copies of user preferences and initialises grade_tree.

Parameters

int	$courseid
object	$gpr	grade plugin return tracking object
string	$context
int	$page	The current page being viewed (when report is paged)
int	$sortitemid	The id of the grade_item by which to sort the table

Member Function Documentation

◆ blank_hidden_total()

grade_report::blank_hidden_total	(	$courseid,
		$course_item,
		$finalgrade
	)

protectedinherited

Optionally blank out course/category totals if they contain any hidden items.

Deprecated:: since Moodle 2.8 - Call blank_hidden_total_and_adjust_bounds instead.

Parameters

string	$courseid	the course id
string	$course_item	an instance of grade_item
string	$finalgrade	the grade for the course_item

Return values

string The new final grade

◆ blank_hidden_total_and_adjust_bounds()

grade_report::blank_hidden_total_and_adjust_bounds	(	$courseid,
		$course_item,
		$finalgrade
	)

protectedinherited

Optionally blank out course/category totals if they contain any hidden items.

Parameters

string	$courseid	the course id
string	$course_item	an instance of grade_item
string	$finalgrade	the grade for the course_item

Return values

array[] containing values for 'grade', 'grademax', 'grademin', 'aggregationstatus' and 'aggregationweight'

◆ do_process_action()

static grade_report_grader::do_process_action	(	$target,
		$action,
		$courseid = `null`
	)

static

Processes a single action against a category, grade_item or grade.

Parameters

string	$target	eid ({type}{id}, e.g. c4 for category4)
string	$action	Which action to take (edit, delete etc...)
int	$courseid	affected course.

Return values

◆ filter_collapsed_categories()

static grade_report_grader::filter_collapsed_categories	(	$courseid,
		$collapsed
	)

staticprotected

From the list of categories that this user prefers to collapse choose ones that belong to the current course.

This function serves two purposes. Mainly it helps migrating from user preference style when all courses were stored in one preference. Also it helps to remove the settings for categories that were removed if the array for one course grows too big.

Parameters

int	$courseid
array	$collapsed

Return values

array

◆ get_collapsed_preferences()

static grade_report_grader::get_collapsed_preferences ( $courseid )

staticprotected

Returns the list of categories that this user wants to collapse or display aggregatesonly.

This method also migrates on request from the old format of storing user preferences when they were stored in one preference for all courses causing DB error when trying to insert very big value.

Parameters

int $courseid

Return values

array

◆ get_collapsing_icon()

grade_report_grader::get_collapsing_icon ( $element )

protected

Given a category element returns collapsing +/- icon if available.

Deprecated:: since Moodle 2.9 MDL-46662 - please do not use this function any more.

◆ get_course_header()

grade_report_grader::get_course_header ( $element )

protected

Given element category, create a collapsible icon and course header.

Parameters

array $element

Return values

string HTML

◆ get_grade_table()

grade_report_grader::get_grade_table ( $displayaverages = false )

Depending on the style of report (fixedstudents vs traditional one-table), arranges the rows of data in one or two tables, and returns the output of these tables in HTML.

Parameters

boolean $displayaverages whether to display average rows in the table

Return values

string HTML

◆ get_icons()

grade_report_grader::get_icons ( $element )

protected

Given a grade_category, grade_item or grade_grade, this function figures out the state of the object and builds then returns a div with the icons needed for the grader report.

Parameters

array $element

Return values

string HTML

◆ get_lang_string()

grade_report::get_lang_string	(	$strcode,
		$section = `null`
	)

inherited

First checks the cached language strings, then returns match if found, or uses get_string() to get it from the DB, caches it then returns it.

Parameters

string	$strcode
string	$section	Optional language section

Return values

string

◆ get_left_avg_row()

grade_report_grader::get_left_avg_row	(	$rows = `array()`,
		$colspan = `1`,
		$groupavg = `false`
	)

Builds and return the headers for the rows of averages, for the left part of the grader report.

Parameters

array	$rows	The Array of rows for the left part of the report
int	$colspan	The number of columns this cell has to span
bool	$groupavg	If true, returns the row for group averages, otherwise for overall averages

Return values

array Array of rows for the left part of the report

◆ get_left_icons_row()

grade_report_grader::get_left_icons_row	(	$rows = `array()`,
		$colspan = `1`
	)

Builds and return the row of icons for the left side of the report.

It only has one cell that says "Controls"

Parameters

array	$rows	The Array of rows for the left part of the report
int	$colspan	The number of columns this cell has to span

Return values

array Array of rows for the left part of the report

◆ get_left_range_row()

grade_report_grader::get_left_range_row	(	$rows = `array()`,
		$colspan = `1`
	)

Builds and return the header for the row of ranges, for the left part of the grader report.

Parameters

array	$rows	The Array of rows for the left part of the report
int	$colspan	The number of columns this cell has to span

Return values

array Array of rows for the left part of the report

◆ get_left_rows()

grade_report_grader::get_left_rows ( $displayaverages )

Builds and returns the rows that will make up the left part of the grader report This consists of student names and icons, links to user reports and id numbers, as well as header cells for these columns.

It also includes the fillers required for the categories displayed on the right side of the report.

Parameters

boolean $displayaverages whether to display average rows in the table

Return values

array Array of html_table_row objects

◆ get_numusers()

grade_report::get_numusers	(	$groups = `true`,
		$users = `false`
	)

inherited

Fetches and returns a count of all the users that will be shown on this page.

Parameters

boolean	$groups	include groups limit
boolean	$users	include users limit - default false, used for searching purposes

Return values

int	Count of users

◆ get_pref()

grade_report::get_pref	(	$pref,
		$objectid = `null`
	)

inherited

Given the name of a user preference (without grade_report_ prefix), locally saves then returns the value of that preference.

If the preference has already been fetched before, the saved value is returned. If the preference is not set at the User level, the $CFG equivalent is given (site default). Can be called statically, but then doesn't benefit from caching

Parameters

string	$pref	The name of the preference (do not include the grade_report_ prefix)
int	$objectid	An optional itemid or categoryid to check for a more fine-grained preference

Return values

mixed The value of the preference

◆ get_right_avg_row()

grade_report_grader::get_right_avg_row	(	$rows = `array()`,
		$grouponly = `false`
	)

Builds and return the row of averages for the right part of the grader report.

Parameters

array	$rows	Whether to return only group averages or all averages.
bool	$grouponly	Whether to return only group averages or all averages.

Return values

array Array of rows for the right part of the report

◆ get_right_icons_row()

grade_report_grader::get_right_icons_row ( $rows = array() )

Builds and return the row of icons when editing is on, for the right part of the grader report.

Parameters

array $rows The Array of rows for the right part of the report

Return values

array Array of rows for the right part of the report

◆ get_right_range_row()

grade_report_grader::get_right_range_row ( $rows = array() )

Builds and return the row of ranges for the right part of the grader report.

Parameters

array $rows The Array of rows for the right part of the report

Return values

array Array of rows for the right part of the report

◆ get_right_rows()

grade_report_grader::get_right_rows ( $displayaverages )

Builds and returns the rows that will make up the right part of the grader report.

Parameters

boolean $displayaverages whether to display average rows in the table

Return values

array Array of html_table_row objects

◆ get_sort_arrow()

grade_report::get_sort_arrow	(	$direction = `'move'`,
		$sortlink = `null`
	)

protectedinherited

Returns an arrow icon inside an tag, for the purpose of sorting a column.

Parameters

string	$direction
moodle_url	$sortlink

◆ get_sort_arrows()

grade_report_grader::get_sort_arrows ( array $extrafields = array() )

Refactored function for generating HTML of sorting links with matching arrows.

Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready to inject into a table header cell.

Parameters

array $extrafields Array of extra fields being displayed, such as user idnumber

Return values

array An associative array of HTML sorting links+arrows

◆ get_students_per_page()

grade_report_grader::get_students_per_page ( )

Returns the maximum number of students to be displayed on each page.

Return values

int	The maximum number of students to display per page

◆ get_toggles_html()

grade_report_grader::get_toggles_html ( )

Gets html toggle.

Deprecated:: since Moodle 2.4 as it appears not to be used any more.

◆ print_toggle()

grade_report_grader::print_toggle ( $type )

Prints html toggle.

Deprecated:: since 2.4 as it appears not to be used any more.

Parameters

unknown $type

◆ process_action()

grade_report_grader::process_action	(	$target,
		$action
	)

Processes a single action against a category, grade_item or grade.

Parameters

string	$target	eid ({type}{id}, e.g. c4 for category4)
string	$action	Which action to take (edit, delete etc...)

Return values

Reimplemented from grade_report.

◆ process_data()

grade_report_grader::process_data ( $data )

Processes the data sent by the form (grades and feedbacks).

Caller is responsible for all access control checks

Parameters

array $data form submission (with magic quotes)

Return values

array empty array if success, array of warnings if something fails.

Reimplemented from grade_report.

◆ set_collapsed_preferences()

static grade_report_grader::set_collapsed_preferences	(	$courseid,
		$collapsed
	)

staticprotected

Sets the list of categories that user wants to see collapsed in user preferences.

This method may filter or even trim the list if it does not fit in DB field.

Parameters

int	$courseid
array	$collapsed

◆ set_pref()

grade_report::set_pref	(	$pref,
		$pref_value = `'default'`,
		$itemid = `null`
	)

inherited

Uses set_user_preferences() to update the value of a user preference.

If 'default' is given as the value, the preference will be removed in favour of a higher-level preference.

Parameters

string	$pref	The name of the preference.
mixed	$pref_value	The value of the preference.
int	$itemid	An optional itemid to which the preference will be assigned

Return values

bool	Success or failure.

Member Data Documentation

◆ $baseurl

string grade_report::$baseurl

inherited

base url for sorting by first/last name.

$baseurl

◆ $context

context grade_report::$context

inherited

The context.

$context

◆ $course

object grade_report::$course

inherited

The course.

$course

◆ $courseid

int grade_report::$courseid

inherited

The courseid.

$courseid

◆ $currentgroup

int grade_report::$currentgroup

inherited

The current group being displayed.

$currentgroup

◆ $currentgroupname

string grade_report::$currentgroupname

inherited

The current groupname being displayed.

$currentgroupname

◆ $feedback_trunc_length

int grade_report_grader::$feedback_trunc_length = 50

protected

Length at which feedback will be truncated (to the nearest word) and an ellipsis be added.

TODO replace this by a report preference $feedback_trunc_length

◆ $gpr

object grade_report::$gpr

inherited

Grade plugin return tracking object.

$gpr

◆ $gradebookroles

string grade_report::$gradebookroles

inherited

The roles for this report.

$gradebookroles

◆ $grades

array grade_report_grader::$grades

The final grades.

$grades

◆ $gradeserror

array grade_report_grader::$gradeserror = array()

Array of errors for bulk grades updating.

$gradeserror

◆ $group_selector

string grade_report::$group_selector

inherited

A HTML select element used to select the current group.

$group_selector

◆ $groupsql

string grade_report::$groupsql

protectedinherited

An SQL fragment used to add linking information to the group tables.

$groupsql

◆ $groupwheresql

string grade_report::$groupwheresql

protectedinherited

An SQL constraint to append to the queries used by this object to build the report.

$groupwheresql

◆ $gtree

grade_tree grade_report::$gtree

inherited

The grade_tree object.

$gtree

◆ $lang_strings

array grade_report::$lang_strings = array()

inherited

Array of cached language strings (using get_string() all the time takes a long time!).

$lang_strings

◆ $page

int grade_report::$page

inherited

Current page (for paging).

$page

◆ $pbarurl

string grade_report::$pbarurl

inherited

base url for paging.

$pbarurl

◆ $prefs

array grade_report::$prefs = array()

inherited

User preferences related to this report.

$prefs

◆ $rowcount

int grade_report_grader::$rowcount = 0

A count of the rows, used for css classes.

$rowcount

◆ $sortitemid

int grade_report_grader::$sortitemid

The id of the grade_item by which this report will be sorted.

$sortitemid

◆ $sortorder

int grade_report_grader::$sortorder

Sortorder used in the SQL selections.

$sortorder

◆ $userselect

string grade_report_grader::$userselect

An SQL fragment affecting the search for users.

$userselect

◆ $userwheresql

string grade_report::$userwheresql

protectedinherited

An SQL constraint to append to the queries used by this object to build the report.

$userwheresql

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

grade/report/grader/lib.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ blank_hidden_total()

◆ blank_hidden_total_and_adjust_bounds()

◆ do_process_action()

◆ filter_collapsed_categories()

◆ get_collapsed_preferences()

◆ get_collapsing_icon()

◆ get_course_header()

◆ get_grade_table()

◆ get_icons()

◆ get_lang_string()

◆ get_left_avg_row()

◆ get_left_icons_row()

◆ get_left_range_row()

◆ get_left_rows()

◆ get_numusers()

◆ get_pref()

◆ get_right_avg_row()

◆ get_right_icons_row()

◆ get_right_range_row()

◆ get_right_rows()

◆ get_sort_arrow()

◆ get_sort_arrows()

◆ get_students_per_page()

◆ get_toggles_html()

◆ print_toggle()

◆ process_action()

◆ process_data()

◆ set_collapsed_preferences()

◆ set_pref()

Member Data Documentation

◆ $baseurl

◆ $context

◆ $course

◆ $courseid

◆ $currentgroup

◆ $currentgroupname

◆ $feedback_trunc_length

◆ $gpr

◆ $gradebookroles

◆ $grades

◆ $gradeserror

◆ $group_selector

◆ $groupsql

◆ $groupwheresql

◆ $gtree

◆ $lang_strings

◆ $page

◆ $pbarurl

◆ $prefs

◆ $rowcount

◆ $sortitemid

◆ $sortorder

◆ $userselect

◆ $userwheresql