Developer Documentation

/plagiarism/ -> lib.php (summary)

lib.php - Contains Plagiarism base class used by plugins.

Copyright: 2010 Dan Marsden
License: GNU GPL v3 or later
File Size: 100 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

plagiarism_plugin:: (8 methods):

Class: plagiarism_plugin  - X-Ref

get_configs()   X-Ref
Return the list of form element names.

return: array contains the form element names.

get_links($linkarray)   X-Ref
hook to allow plagiarism specific information to be displayed beside a submission

param: array  $linkarraycontains all relevant information for the plugin to generate a link
return: string

get_file_results($cmid, $userid, $file)   X-Ref
hook to allow plagiarism specific information to be returned unformatted

param: int $cmid
param: int $userid
param: $file file object
return: array containing at least:

get_form_elements_module($mform, $context, $modulename = "")   X-Ref
hook to add plagiarism specific settings to a module settings page

param: object $mform  - Moodle form
param: object $context - current context
param: string $modulename - Name of the module

save_form_elements($data)   X-Ref
No description

print_disclosure($cmid)   X-Ref
hook to allow a disclosure to be printed notifying users what will happen with their submission

param: int $cmid - course module id
return: string

update_status($course, $cm)   X-Ref
hook to allow status of submitted files to be updated - called on grading/report pages.

param: object $course - full Course object
param: object $cm - full cm object

plagiarism_cron()   X-Ref
hook for cron

Search This Site: