Development:Plagiarism API: Difference between revisions
Dan Marsden (talk | contribs) (New page: {{Moodle_2.0}} ==Overview== The Plagiarism API is a core set of functions that all Moodle code can use to send user submitted content to Plagiarism Prevention systems A typical user story...) |
Dan Marsden (talk | contribs) No edit summary |
||
Line 7: | Line 7: | ||
# A user enters some content/submits a file inside a module that a teacher/Admin has configured the tool to be used. | # A user enters some content/submits a file inside a module that a teacher/Admin has configured the tool to be used. | ||
# An Event is triggered which contains details about the user, module and submission they have made | # An Event is triggered which contains details about the user, module and submission they have made | ||
# Event handlers in the Plagiarism | # Event handlers in the Plagiarism plugin are triggered and process anything required. | ||
# Hooks for displaying information returned from the Plagiarism tools to both the user and teacher (controlled by the plugin) | # Hooks for displaying information returned from the Plagiarism tools to both the user and teacher (controlled by the plugin) | ||
Line 15: | Line 15: | ||
== Architecture == | == Architecture == | ||
all the global functions are contained within /plagiarism/lib.php and each plagiarism tool has it's own plugin directory with db folder for capabilities/database tables required. | all the global functions are contained within /plagiarism/lib.php and each plagiarism tool has it's own plugin directory with db folder for capabilities/event handlers/database tables required. | ||
===Plugins and libraries=== | ===Plugins and libraries=== | ||
Line 25: | Line 25: | ||
=====Class methods===== | =====Class methods===== | ||
Here are the methods that each Plagiarism Plugin can override. | Here are the methods that each Plagiarism Plugin can override. | ||
======cron====== | ======cron====== | ||
Line 47: | Line 45: | ||
===Event Triggers=== | ===Event Triggers=== | ||
Modules that support the Plagiarism API should have appropriate event triggers | Modules that support the Plagiarism API should have appropriate event triggers when a user has updated text that requires processing by the Plagiarism API |
Latest revision as of 00:41, 13 July 2010
Overview
The Plagiarism API is a core set of functions that all Moodle code can use to send user submitted content to Plagiarism Prevention systems
A typical user story:
- When Plagiarism tools are enabled, every module that allows it will have a group of settings added to allow management of sending the user content to a plagiarism service.
- A user enters some content/submits a file inside a module that a teacher/Admin has configured the tool to be used.
- An Event is triggered which contains details about the user, module and submission they have made
- Event handlers in the Plagiarism plugin are triggered and process anything required.
- Hooks for displaying information returned from the Plagiarism tools to both the user and teacher (controlled by the plugin)
Supported Modules
- Single Upload Assignment
- Advanced Assignment
Architecture
all the global functions are contained within /plagiarism/lib.php and each plagiarism tool has it's own plugin directory with db folder for capabilities/event handlers/database tables required.
Plugins and libraries
Each Plagiarism Tool will have it's own plugin directory - eg /plagiarism/turnitin/
Abstract Baseclass : plagiarism_plugin
Each Plagiarism plugin must subclass this in a file called plagiarism/pluginname/lib.php - the subclass must be named using the plugin directory as a suffix - eg: class plagiarism_plugin_turnitin extends plagiarism_plugin {
Class methods
Here are the methods that each Plagiarism Plugin can override.
cron
This function is triggered by Cron to allow any scheduled tasks to be processed.
get_form_elements
This function allows the addition of any Plagiarism specific settings to an mform inside a module settings page.
save_form_elements
This function is triggered when a teacher saves the settings on a module page to allows storing of any Plagiarism specific settings.
get_links
This function provides a hook to allow information to be displayed beside a users submission - for example the grading page for teachers to display an originality score/link to more information or to allow a student to see the same information.
print_disclosure
This function allows the plugin to display a message to users inside the submission page to let them know that the submission will be passed to a plagiarism prevention system.
update_status
This function is called on pages that display a full list of users eg grading pages to allow the status of any submissions to be checked. This function is called every time the report page is loaded so it should perform appropriate caching.
Event Triggers
Modules that support the Plagiarism API should have appropriate event triggers when a user has updated text that requires processing by the Plagiarism API