MDL-65835 plagiarism: Initial deprecation of old functions.
[moodle.git] / plagiarism / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * lib.php - Contains Plagiarism base class used by plugins.
20  *
21  * @since Moodle 2.0
22  * @package    core_plagiarism
23  * @copyright  2010 Dan Marsden http://danmarsden.com
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 if (!defined('MOODLE_INTERNAL')) {
28     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
29 }
32 /**
33  * Plagiarism base class used by plugins.
34  *
35  * @since Moodle 2.0
36  * @package    core_plagiarism
37  * @copyright  2010 Dan Marsden http://danmarsden.com
38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 abstract class plagiarism_plugin {
42     /**
43      * Return the list of form element names.
44      *
45      * @return array contains the form element names.
46      */
47     public function get_configs() {
48         return array();
49     }
51     /**
52      * hook to allow plagiarism specific information to be displayed beside a submission
53      * @param array  $linkarraycontains all relevant information for the plugin to generate a link
54      * @return string
55      */
56     public function get_links($linkarray) {
57         return '';
58     }
59     /**
60      * hook to allow plagiarism specific information to be returned unformatted
61      * @param int $cmid
62      * @param int $userid
63      * @param $file file object
64      * @return array containing at least:
65      *   - 'analyzed' - whether the file has been successfully analyzed
66      *   - 'score' - similarity score - ('' if not known)
67      *   - 'reporturl' - url of originality report - '' if unavailable
68      */
69     public function get_file_results($cmid, $userid, $file) {
70         return array('analyzed' => '', 'score' => '', 'reporturl' => '');
71     }
72     /**
73      * hook to add plagiarism specific settings to a module settings page
74      * @deprecated Since Moodle 3.9. MDL-65835 Please use {plugin name}_coursemodule_edit_post_actions() instead.
75      * @todo MDL-67526 Remove this method.
76      * @param object $mform  - Moodle form
77      * @param object $context - current context
78      * @param string $modulename - Name of the module
79      */
80     public function get_form_elements_module($mform, $context, $modulename = "") {
81     }
82     /**
83      * hook to save plagiarism specific settings on a module settings page
84      * @deprecated Since Moodle 3.9. MDL-65835 Please use {plugin name}_coursemodule_standard_elements() instead.
85      * @todo MDL-67526 Remove this method.
86      * @param object $data - data from an mform submission.
87      */
88     public function save_form_elements($data) {
89     }
90     /**
91      * hook to allow a disclosure to be printed notifying users what will happen with their submission
92      * @param int $cmid - course module id
93      * @return string
94      */
95     public function print_disclosure($cmid) {
96     }
97     /**
98      * hook to allow status of submitted files to be updated - called on grading/report pages.
99      *
100      * @param object $course - full Course object
101      * @param object $cm - full cm object
102      */
103     public function update_status($course, $cm) {
104     }