grade_report Class Reference

An abstract class containing variables and methods used by all or most reports. More...

Inheritance diagram for grade_report:

Public Member Functions
	__construct ($courseid, $gpr, $context, $page=null)
	Constructor. 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_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...
	process_action ($target, $action)
	Processes a single action against a category, grade_item or grade. More...
	process_data ($data)
	Handles form data sent by this report for this report. 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	supports_mygrades ()
	Shows support for being used as a 'Grades' report.

Public Attributes
string	$baseurl
	base url for sorting by first/last name. More...
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...
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...

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_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.

Protected Attributes
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.
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

An abstract class containing variables and methods used by all or most reports.

Copyright

2007 Moodle Pty Ltd (http://moodle.com)

License

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

Constructor & Destructor Documentation

__construct()

grade_report::__construct	(		$courseid,
			$gpr,
			$context,
			$page = 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)

Member Function Documentation

blank_hidden_total()

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

protected

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  )

protected

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'

get_lang_string()

grade_report::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.

Parameters

string	$strcode
string	$section	Optional language section

Return values

string

get_numusers()

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

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
	)

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_sort_arrow()

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

protected

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

Parameters

string	$direction
moodle_url	$sortlink

process_action()

grade_report::process_action (   $target,   $action  )

abstract

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

Parameters

string	$target	Sortorder
string	$action	Which action to take (edit, delete etc...)

Return values

Reimplemented in grade_report_user, gradereport_singleview, grade_report_overview, and grade_report_grader.

process_data()

grade_report::process_data (   $data )

abstract

Handles form data sent by this report for this report.

Abstract method to implement in all children. @abstract

Parameters

array

$data

Return values

mixed

True or array of errors

Reimplemented in grade_report_user, gradereport_singleview, grade_report_overview, and grade_report_grader.

set_pref()

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

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

base url for sorting by first/last name.

$baseurl

$context

context grade_report::$context

The context.

$context

$course

object grade_report::$course

The course.

$course

$courseid

int grade_report::$courseid

The courseid.

$courseid

$currentgroup

int grade_report::$currentgroup

The current group being displayed.

$currentgroup

$currentgroupname

string grade_report::$currentgroupname

The current groupname being displayed.

$currentgroupname

$gpr

object grade_report::$gpr

Grade plugin return tracking object.

$gpr

$gradebookroles

string grade_report::$gradebookroles

The roles for this report.

$gradebookroles

$group_selector

string grade_report::$group_selector

A HTML select element used to select the current group.

$group_selector

$groupsql

string grade_report::$groupsql

protected

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

$groupsql

$groupwheresql

string grade_report::$groupwheresql

protected

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

$groupwheresql

$gtree

grade_tree grade_report::$gtree

The grade_tree object.

$gtree

$lang_strings

array grade_report::$lang_strings = array()

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

$lang_strings

$page

int grade_report::$page

Current page (for paging).

$page

$pbarurl

string grade_report::$pbarurl

base url for paging.

$pbarurl

$prefs

array grade_report::$prefs = array()

User preferences related to this report.

$prefs

$userwheresql

string grade_report::$userwheresql

protected

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/lib.php