gradereport_history\helper Class Reference

Helper class for gradehistory report. More...

Static Public Member Functions
static	get_graders ($courseid)
	Get a list of graders. More...
static	get_users ($context, $search='', $page=0, $perpage=25)
	Retrieve a list of users. More...
static	get_users_count ($context, $search='')
	Get total number of users present for the given search criteria. More...
static	init_js ($courseid, array $currentusers=null)
	Initialise the js to handle the user selection gradereport_history_user_button. More...

Static Protected Member Functions
static	get_users_sql_and_params ($context, $search='', $count=false)
	Get sql and params to use to get list of users. More...

Detailed Description

Helper class for gradehistory report.

Since

Moodle 2.8

Copyright

2014 onwards Ankit Agarwal ankit.nosp@m..agr.nosp@m.r@gma.nosp@m.il.c.nosp@m.om

License

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

Member Function Documentation

get_graders()

static gradereport_history\helper::get_graders (   $courseid )

static

Get a list of graders.

Parameters

int

$courseid

Id of course for which we need to fetch graders.

Return values

array

list of graders.

get_users()

static gradereport_history\helper::get_users (   $context,   $search = '',   $page = 0,   $perpage = 25  )

static

Retrieve a list of users.

We're interested in anyone that had a grade history in this course. This api returns a list of such users based on various criteria passed.

Parameters

context	$context	Context of the page where the results would be shown.
string	$search	the text to search for (empty string = find all).
int	$page	page number, defaults to 0.
int	$perpage	Number of entries to display per page, defaults to 0.

Return values

array

list of users.

get_users_count()

static gradereport_history\helper::get_users_count (   $context,   $search = ''  )

static

Get total number of users present for the given search criteria.

Parameters

context	$context	Context of the page where the results would be shown.
string	$search	the text to search for (empty string = find all).

Return values

int	number of users found.

get_users_sql_and_params()

static gradereport_history\helper::get_users_sql_and_params (   $context,   $search = '',   $count = false  )

staticprotected

Get sql and params to use to get list of users.

Parameters

context	$context	Context of the page where the results would be shown.
string	$search	the text to search for (empty string = find all).
bool	$count	setting this to true, returns an sql to get count only instead of the complete data records.

Return values

array

sql and params list

init_js()

static gradereport_history\helper::init_js (   $courseid, array  $currentusers = null  )

static

Initialise the js to handle the user selection gradereport_history_user_button.

Parameters

int	$courseid	course id.
array	$currentusers	List of currently selected users.

Return values

output::user_button

the user select button.

---

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

• grade/report/history/classes/helper.php