[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/grade/export/ -> lib.php (summary)

Base export class

File Size: 520 lines (19 kb)
Included or required:0 times
Referenced: 4 times
Includes or requires: 0 files

Defines 1 class

grade_export_update_buffer:: (5 methods):
  grade_export_update_buffer()
  flush()
  track()
  close()
  export_verify_grades()

Defines 5 functions

  __construct()
  deprecated_constructor()
  process_form()
  track_exports()
  format_grade()
  format_column_name()
  format_feedback()
  display_preview()
  get_export_params()
  print_continue()

Class: grade_export_update_buffer  - X-Ref

This class is used to update the exported field in grade_grades.
It does internal buffering to speedup the db operations.

grade_export_update_buffer()   X-Ref
Constructor - creates the buffer and initialises the time stamp


flush($buffersize)   X-Ref
No description

track($grade_grade)   X-Ref
Track grade export status

param: object $grade_grade
return: string $status (unknow, new, regrade, nochange)

close()   X-Ref
Flush and close the buffer.


export_verify_grades($courseid)   X-Ref
Verify that there is a valid set of grades to export.

param: $courseid int The course being exported

Functions
Functions that are not part of a class:

__construct($course, $groupid, $formdata)   X-Ref
Constructor should set up all the private variables ready to be pulled.

This constructor used to accept the individual parameters as separate arguments, in
2.8 this was simplified to just accept the data from the moodle form.

param: object $course
param: int $groupid
param: stdClass|null $formdata

deprecated_constructor($course,$groupid=0,$itemlist='',$export_feedback=false,$updatedgradesonly = false,$displaytype = GRADE_DISPLAY_TYPE_REAL,$decimalpoints = 2,$onlyactive = false,$usercustomfields = false)   X-Ref
Old deprecated constructor.

This deprecated constructor accepts the individual parameters as separate arguments, in
2.8 this was simplified to just accept the data from the moodle form.


process_form($formdata)   X-Ref
Init object based using data from form

param: object $formdata

track_exports()   X-Ref
Update exported field in grade_grades table

return: boolean

format_grade($grade, $gradedisplayconst = null)   X-Ref
Returns string representation of final grade

param: object $grade instance of grade_grade class
param: integer $gradedisplayconst grade display type constant.
return: string

format_column_name($grade_item, $feedback=false, $gradedisplayname = null)   X-Ref
Returns the name of column in export

param: object $grade_item
param: boolean $feedback feedback colum
param: string $gradedisplayname grade display name.
return: string

format_feedback($feedback)   X-Ref
Returns formatted grade feedback

param: object $feedback object with properties feedback and feedbackformat
return: string

display_preview($require_user_idnumber=false)   X-Ref
Prints preview of exported grades on screen as a feedback mechanism

param: bool $require_user_idnumber true means skip users without idnumber

get_export_params()   X-Ref
Returns array of parameters used by dump.php and export.php.

return: array

print_continue()   X-Ref
Either prints a "Export" box, which will redirect the user to the download page,
or prints the URL for the published data.

return: void



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1