Automatically generated installer lang files
[moodle.git] / plagiarism / lib.php
CommitLineData
bce59524
DM
1<?php
2
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/>.
17
18/**
19 * lib.php - Contains Plagiarism base class used by plugins.
20 *
21 * @since 2.0
22 * @package moodlecore
23 * @subpackage plagiarism
24 * @copyright 2010 Dan Marsden http://danmarsden.com
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 */
27
28if (!defined('MOODLE_INTERNAL')) {
29 die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
30}
31
32//dummy class - all plugins should be based off this.
33class plagiarism_plugin {
34 /**
35 * hook to allow plagiarism specific information to be displayed beside a submission
36 * @param array $linkarraycontains all relevant information for the plugin to generate a link
37 * @return string
38 *
39 */
40 public function get_links($linkarray) {
41 return '';
42 }
bfad2f2f
PB
43 /**
44 * hook to allow plagiarism specific information to be returned unformatted
45 * @param int $cmid
46 * @param int $userid
4447223b 47 * @param stored_file $file moodle file object
bfad2f2f
PB
48 * @return array containing at least:
49 * - 'analyzed' - whether the file has been successfully analyzed
50 * - 'score' - similarity score - ('' if not known)
51 * - 'reporturl' - url of originality report - '' if unavailable
52 */
4447223b 53 public function get_file_results($cmid, $userid, stored_file $file) {
bfad2f2f
PB
54 return array('analyzed' => '', 'score' => '', 'reporturl' => '');
55 }
bce59524
DM
56 /**
57 * hook to add plagiarism specific settings to a module settings page
58 * @param object $mform - Moodle form
59 * @param object $context - current context
60 */
61 public function get_form_elements_module($mform, $context) {
62 }
63 /* hook to save plagiarism specific settings on a module settings page
64 * @param object $data - data from an mform submission.
65 */
66 public function save_form_elements($data) {
67 }
68 /**
69 * hook to allow a disclosure to be printed notifying users what will happen with their submission
70 * @param int $cmid - course module id
71 * @return string
72 */
73 public function print_disclosure($cmid) {
74 }
75 /**
76 * hook to allow status of submitted files to be updated - called on grading/report pages.
77 *
78 * @param object $course - full Course object
79 * @param object $cm - full cm object
80 */
81 public function update_status($course, $cm) {
82 }
83 /**
84 * hook for cron
85 *
86 */
87 public function plagiarism_cron() {
88 }
4447223b 89}