plagiarism_plugin Class Reference

Plagiarism base class used by plugins. More...

Public Member Functions
	get_configs ()
	Return the list of form element names. More...
	get_file_results ($cmid, $userid, $file)
	hook to allow plagiarism specific information to be returned unformatted More...
	get_form_elements_module ($mform, $context, $modulename="")
	hook to add plagiarism specific settings to a module settings page More...
	get_links ($linkarray)
	hook to allow plagiarism specific information to be displayed beside a submission More...
	print_disclosure ($cmid)
	hook to allow a disclosure to be printed notifying users what will happen with their submission More...
	save_form_elements ($data)
	hook to save plagiarism specific settings on a module settings page More...
	update_status ($course, $cm)
	hook to allow status of submitted files to be updated - called on grading/report pages. More...

Detailed Description

Plagiarism base class used by plugins.

Since

Moodle 2.0

Copyright

2010 Dan Marsden http://danmarsden.com

License

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

Member Function Documentation

get_configs()

plagiarism_plugin::get_configs

(

)

Return the list of form element names.

Return values

array

contains the form element names.

get_file_results()

plagiarism_plugin::get_file_results	(		$cmid,
			$userid,
			$file
	)

hook to allow plagiarism specific information to be returned unformatted

Parameters

int	$cmid
int	$userid
	$file	file object

Return values

array

containing at least: 'analyzed' - whether the file has been successfully analyzed 'score' - similarity score - ('' if not known) 'reporturl' - url of originality report - '' if unavailable

get_form_elements_module()

plagiarism_plugin::get_form_elements_module	(		$mform,
			$context,
			$modulename = ""
	)

hook to add plagiarism specific settings to a module settings page

Deprecated:

Since Moodle 3.9. MDL-65835 Please use {plugin name}_coursemodule_edit_post_actions() instead.

Todo:

MDL-67526 Remove this method.

Parameters

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

get_links()

plagiarism_plugin::get_links

(

$linkarray

)

hook to allow plagiarism specific information to be displayed beside a submission

Parameters

array

$linkarraycontains

all relevant information for the plugin to generate a link

Return values

string

print_disclosure()

plagiarism_plugin::print_disclosure

(

$cmid

)

hook to allow a disclosure to be printed notifying users what will happen with their submission

Parameters

int

$cmid

- course module id

Return values

string

save_form_elements()

plagiarism_plugin::save_form_elements

(

$data

)

hook to save plagiarism specific settings on a module settings page

Deprecated:

Since Moodle 3.9. MDL-65835 Please use {plugin name}_coursemodule_standard_elements() instead.

Todo:

MDL-67526 Remove this method.

Parameters

object

$data

- data from an mform submission.

update_status()

plagiarism_plugin::update_status	(		$course,
			$cm
	)

hook to allow status of submitted files to be updated - called on grading/report pages.

Parameters

object	$course	- full Course object
object	$cm	- full cm object

---

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

• plagiarism/lib.php