grade_export Class Reference

Inheritance diagram for grade_export:

Public Member Functions
	grade_export ($course, $groupid=0, $itemlist='', $export_feedback=false, $updatedgradesonly=false, $displaytype=GRADE_DISPLAY_TYPE_REAL, $decimalpoints=2)
	process_form ($formdata)
	track_exports ()
	format_grade ($grade)
	format_column_name ($grade_item, $feedback=false)
	format_feedback ($feedback)
	print_grades ()
	display_preview ($require_user_idnumber=false)
	get_export_params ()
	print_continue ()
Data Fields
	$plugin
	$grade_items
	$groupid
	$course
	$columns
	$previewrows
	$export_letters
	$export_feedback
	$userkey
	$updatedgradesonly
	$displaytype
	$decimalpoints

---

Detailed Description

Base export class

Definition at line 25 of file lib.php.

---

Member Function Documentation

display_preview

(

$

require_user_idnumber = false

)

Prints preview of exported grades on screen as a feedback mechanism

Parameters:

bool

$require_user_idnumber

true means skip users without idnumber

add a column_feedback column

Print all the lines of data.

Definition at line 200 of file lib.php.

Here is the call graph for this function:

format_column_name	(	$	grade_item,
		$	feedback = false
	)

Returns the name of column in export

Parameters:

object	$grade_item
boolena	$feedback	feedback colum &return string

Definition at line 168 of file lib.php.

Here is the caller graph for this function:

format_feedback

(

$

feedback

)

Returns formatted grade feedback

Parameters:

object

$feedback

object with properties feedback and feedbackformat

Returns:

string

Definition at line 187 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

format_grade

(

$

grade

)

Returns string representation of final grade

Parameters:

$object

$grade instance of grade_grade class

Returns:

string

Definition at line 158 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_export_params

(

)

Returns array of parameters used by dump.php and export.php.

Returns:

array

Reimplemented in grade_export_txt.

Definition at line 279 of file lib.php.

Here is the caller graph for this function:

grade_export	(	$	course,
		$	groupid = 0,
		$	itemlist = '',
		$	export_feedback = false,
		$	updatedgradesonly = false,
		$	displaytype = GRADE_DISPLAY_TYPE_REAL,
		$	decimalpoints = 2
	)

Constructor should set up all the private variables ready to be pulled public

Parameters:

object	$course
int	$groupid	id of selected group, 0 means all
string	$itemlist	comma separated list of item ids, empty means all
boolean	$export_feedback
boolean	$export_letters

Note:

Exporting as letters will lead to data loss if that exported set it re-imported.

Definition at line 52 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

print_continue

(

)

Either prints a "Export" box, which will redirect the user to the download page, or prints the URL for the published data.

Returns:

void

Definition at line 303 of file lib.php.

Here is the call graph for this function:

print_grades

(

)

[abstract]

Implemented by child class

Reimplemented in grade_export_txt, grade_export_ods, and grade_export_xls.

process_form

(

$

formdata

)

Init object based using data from form

Parameters:

object

$formdata

Definition at line 92 of file lib.php.

Here is the call graph for this function:

track_exports

(

)

Update exported field in grade_grades table

Returns:

boolean

Whether this plugin is entitled to update export time

Definition at line 138 of file lib.php.

Here is the caller graph for this function:

---

Field Documentation

$columns

Definition at line 32 of file lib.php.

$course

Definition at line 31 of file lib.php.

$decimalpoints

Definition at line 41 of file lib.php.

$displaytype

Definition at line 40 of file lib.php.

$export_feedback

Definition at line 36 of file lib.php.

$export_letters

Definition at line 35 of file lib.php.

$grade_items

Definition at line 29 of file lib.php.

$groupid

Definition at line 30 of file lib.php.

$plugin

Reimplemented in grade_export_xml, grade_export_ods, grade_export_txt, and grade_export_xls.

Definition at line 27 of file lib.php.

$previewrows

Definition at line 34 of file lib.php.

$updatedgradesonly

Reimplemented in grade_export_xml.

Definition at line 39 of file lib.php.

$userkey

Definition at line 37 of file lib.php.

---

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

• C:/xampp/htdocs/moodle/grade/export/lib.php