core_plagiarism\privacy\provider Class Reference

Provider for the plagiarism API. More...

Inheritance diagram for core_plagiarism\privacy\provider:

Static Public Member Functions
static	delete_plagiarism_for_context (\context $context)
	Deletes all user content for a context in all plagiarism plugins.
static	delete_plagiarism_for_user (int $userid, context $context)
	Deletes all user content for a user in a context in all plagiarism plugins.
static	delete_plagiarism_for_users (array $userids, context $context)
	Deletes all user content for a user in a context in all plagiarism plugins.
static	export_plagiarism_user_data (int $userid, context $context, array $subcontext, array $linkarray)
	Export all plagiarism data from each plagiarism plugin for the specified userid and context.
static	get_metadata (collection $collection)
	Returns meta data about this system.

Static Protected Member Functions
static	call_plugin_method ($methodname, $params)
	Internal method for looping through all of the plagiarism plugins and calling a method.

Detailed Description

Provider for the plagiarism API.

Copyright

2018 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

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

Member Function Documentation

call_plugin_method()

static core_plagiarism\privacy\provider::call_plugin_method ( $methodname, $params )

staticprotected

Internal method for looping through all of the plagiarism plugins and calling a method.

Parameters

string	$methodname	Name of the method to call on the plugins.
array	$params	The parameters that go with the method being called.

delete_plagiarism_for_context()

static core_plagiarism\privacy\provider::delete_plagiarism_for_context ( \context $context )

static

Deletes all user content for a context in all plagiarism plugins.

Parameters

context

$context

The context to delete user data for.

delete_plagiarism_for_user()

static core_plagiarism\privacy\provider::delete_plagiarism_for_user ( int $userid, context $context )

static

Deletes all user content for a user in a context in all plagiarism plugins.

Parameters

int	$userid	The user to delete
context	$context	The context to refine the deletion.

delete_plagiarism_for_users()

static core_plagiarism\privacy\provider::delete_plagiarism_for_users ( array $userids, context $context )

static

Deletes all user content for a user in a context in all plagiarism plugins.

Parameters

array	$userids	The users to delete
context	$context	The context to refine the deletion.

export_plagiarism_user_data()

static core_plagiarism\privacy\provider::export_plagiarism_user_data ( int $userid, context $context, array $subcontext, array $linkarray )

static

Export all plagiarism data from each plagiarism plugin for the specified userid and context.

Parameters

int	$userid	The user to export.
context	$context	The context to export.
array	$subcontext	The subcontext within the context to export this information to.
array	$linkarray	The weird and wonderful link array used to display information for a specific item

get_metadata()

static core_plagiarism\privacy\provider::get_metadata ( collection $collection )

static

Returns meta data about this system.

Parameters

collection

$collection

The initialised collection to add items to.

Return values

collection

A listing of user data stored through this system.

Implements core_privacy\local\metadata\provider.

---

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

• plagiarism/classes/privacy/provider.php