lib.php File Reference

Functions
	get_new_importcode ()
	Returns new improtcode for current user.
	get_unenrolled_users_in_import ($importcode, $courseid)
	This function returns an array of grades that were included in the import, but where the user does not currently have a graded role on the course.
	grade_import_commit ($courseid, $importcode, $importfeedback=true, $verbose=true)
	given an import code, commits all entries in buffer tables (grade_import_value and grade_import_newitem) If this function is called, we assume that all data collected up to this point is fine and we can go ahead and commit
	import_cleanup ($importcode)
	removes entries from grade import buffer tables grade_import_value and grade_import_newitem after a successful import, or during an import abort

Function Documentation

get_new_importcode()

get_new_importcode

(

)

Returns new improtcode for current user.

Return values

int	importcode

get_unenrolled_users_in_import()

get_unenrolled_users_in_import	(		$importcode,
			$courseid )

This function returns an array of grades that were included in the import, but where the user does not currently have a graded role on the course.

These grades are still stored in the database, but will not be visible in the gradebook unless this user subsequently enrols on the course in a graded roles.

The returned objects have fields useridnumber and gradeidnumber, plus enough user name fields to pass to {

See also

fullname}

Parameters

integer	$importcode	import batch identifier
integer	$courseid	the course we are importing to.

Return values

mixed

and array of user objects, or false if none.

grade_import_commit()

grade_import_commit	(		$courseid,
			$importcode,
			$importfeedback = true,
			$verbose = true )

given an import code, commits all entries in buffer tables (grade_import_value and grade_import_newitem) If this function is called, we assume that all data collected up to this point is fine and we can go ahead and commit

Parameters

int	$courseid	- ID of the course.
int	$importcode	- Import batch identifier.
bool	$importfeedback	- Whether to import feedback as well.
bool	$verbose	- Print feedback and continue button.

Return values

bool

success

import_cleanup()

import_cleanup

(

$importcode

)

removes entries from grade import buffer tables grade_import_value and grade_import_newitem after a successful import, or during an import abort

Parameters

string

importcode - import batch identifier