PlagiarismPlugin Class Reference

Inheritance diagram for PlagiarismPlugin:

Public Member Functions
	callback ($hookName, $args)
	getCanEnable ()
	getDescription ()
	getDisplayName ()
	getEnabled ()
	register ($category, $path, $mainContextId=null)
Public Member Functions inherited from LazyLoadPlugin
	getCanDisable ()
	getCurrentContextId ()
	getEnabled ($contextId=null)
	getName ()
	setEnabled ($enabled)
Public Member Functions inherited from Plugin
	__construct ()
	_overridePluginTemplates ($hookName, $args)
	addLocaleData ($locale=null)
	getActions ($request, $actionArgs)
	getCategory ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDirName ()
	getHideManagement ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	getLocaleFilename ($locale)
	getPluginPath ()
&	getRequest ()
	getSeq ()
	getSetting ($contextId, $name)
	getTemplatePath ($inCore=false)
	getTemplateResource ($template=null, $inCore=false)
	import ($class)
	installContextSpecificSettings ($hookName, $args)
	installControlledVocabs ($hookName, $args)
	installData ($hookName, $args)
	installEmailTemplateData ($hookName, $args)
	installEmailTemplates ($hookName, $args)
	installFilters ($hookName, $args)
	installLocale ($hookName, $args)
	installSiteSettings ($hookName, $args)
	isSitePlugin ()
	manage ($args, $request)
	smartyPluginUrl ($params, $smarty)
	updateSchema ($hookName, $args)
	updateSetting ($contextId, $name, $value, $type=null)

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory
	$pluginPath
	$request
Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

Definition at line 15 of file PlagiarismPlugin.inc.php.

Member Function Documentation

callback()

PlagiarismPlugin::callback	(		$hookName,
			$args
	)

Send submission files to iThenticate.

Parameters

$hookName	string
$args	array

Definition at line 64 of file PlagiarismPlugin.inc.php.

References Plugin\$request, PKPApplication\get(), DAORegistry\getDAO(), and Config\getVar().

getCanEnable()

PlagiarismPlugin::getCanEnable

(

)

Determine whether the plugin can be enabled.

Returns

boolean

Reimplemented from LazyLoadPlugin.

Definition at line 46 of file PlagiarismPlugin.inc.php.

References Config\getVar().

getDescription()

PlagiarismPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 39 of file PlagiarismPlugin.inc.php.

References Config\getVar().

getDisplayName()

PlagiarismPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 32 of file PlagiarismPlugin.inc.php.

getEnabled()

PlagiarismPlugin::getEnabled

(

)

Determine whether the plugin is enabled.

Returns

boolean

Reimplemented from Plugin.

Definition at line 54 of file PlagiarismPlugin.inc.php.

References Config\getVar().

Referenced by register().

register()

PlagiarismPlugin::register	(		$category,
			$path,
			$mainContextId = null
	)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters

$category	String Name of category plugin was registered to
$path	String The path the plugin was found in
$mainContextId	integer To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.

Returns

boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from LazyLoadPlugin.

Definition at line 19 of file PlagiarismPlugin.inc.php.

References Plugin\addLocaleData(), getEnabled(), Config\getVar(), and HookRegistry\register().

---

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

• PlagiarismPlugin.inc.php