HypothesisPlugin Class Reference

Inheritance diagram for HypothesisPlugin:

Public Member Functions
	callback ($hookName, $args)
	callbackTemplateDisplay ($hookName, $args)
	changePdfjsPath ($output, $templateMgr)
	getDescription ()
	getDisplayName ()
	register ($category, $path, $mainContextId=null)
Public Member Functions inherited from LazyLoadPlugin
	getCanDisable ()
	getCanEnable ()
	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 ()
	getEnabled ()
	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

Hypothesis annotation/discussion integration.

Definition at line 17 of file HypothesisPlugin.inc.php.

Member Function Documentation

callback()

HypothesisPlugin::callback	(		$hookName,
			$args
	)

Hook callback function for TemplateManager::display

Parameters

$hookName	string
$args	array

Returns

boolean

Definition at line 36 of file HypothesisPlugin.inc.php.

callbackTemplateDisplay()

HypothesisPlugin::callbackTemplateDisplay	(		$hookName,
			$args
	)

Hook callback function for TemplateManager::display

Parameters

$hookName	string
$args	array

Returns

boolean

Definition at line 53 of file HypothesisPlugin.inc.php.

changePdfjsPath()

HypothesisPlugin::changePdfjsPath	(		$output,
			$templateMgr
	)

Output filter to create a new element in a registration form

Parameters

$output	string
$templateMgr	TemplateManager

Returns

$string

Definition at line 72 of file HypothesisPlugin.inc.php.

getDescription()

HypothesisPlugin::getDescription

(

)

Get the description of this plugin

Returns

string

Reimplemented from Plugin.

Definition at line 89 of file HypothesisPlugin.inc.php.

getDisplayName()

HypothesisPlugin::getDisplayName

(

)

Get the display name of this plugin

Returns

string

Reimplemented from Plugin.

Definition at line 81 of file HypothesisPlugin.inc.php.

register()

HypothesisPlugin::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 21 of file HypothesisPlugin.inc.php.

References HookRegistry\register().

---

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

• HypothesisPlugin.inc.php