Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
plagiarism_plugin Class Reference

Plagiarism base class used by plugins. More...

Public Member Functions

 get_configs ()
 Return the list of form element names.
 
 get_file_results ($cmid, $userid, $file)
 hook to allow plagiarism specific information to be returned unformatted
 
 get_links ($linkarray)
 hook to allow plagiarism specific information to be displayed beside a submission
 
 print_disclosure ($cmid)
 hook to allow a disclosure to be printed notifying users what will happen with their submission
 
 update_status ($course, $cm)
 hook to allow status of submitted files to be updated - called on grading/report pages.
 

Detailed Description

Plagiarism base class used by plugins.

Since
Moodle 2.0
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.

Deprecated
Since Moodle 4.0 - this function was a placeholder and not used in core.
Todo
MDL-71326 Remove this method.
Return values
arraycontains 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

Deprecated
Since Moodle 4.0 - this function was a placeholder and not used in core Moodle code.
Todo
MDL-71326 Remove this method.
Parameters
int$cmid
int$userid
$filefile object
Return values
arraycontaining at least:
  • 'analyzed' - whether the file has been successfully analyzed
  • 'score' - similarity score - ('' if not known)
  • 'reporturl' - url of originality report - '' if unavailable

◆ get_links()

plagiarism_plugin::get_links ( $linkarray)

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

Parameters
array$linkarraycontainsall 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

◆ update_status()

plagiarism_plugin::update_status ( $course,
$cm )

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

Deprecated
Since Moodle 4.0 - Please use {plugin name}_before_standard_top_of_body_html instead.
Todo
MDL-71326 Remove this method.
Parameters
object$course- full Course object
object$cm- full cm object

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