SubscriptionSSOPlugin Class Reference

Inheritance diagram for SubscriptionSSOPlugin:

Public Member Functions
	getActions ($request, $actionArgs)
	getDescription ()
	getDisplayName ()
	loadHandlerCallback ($hookName, $args)
	manage ($args, $request)
	register ($category, $path, $mainContextId=null)
	subscribedUserCallback ($hookName, $args)
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)
	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 ()
	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 SubscriptionSSOPlugin.inc.php.

Member Function Documentation

getActions()

SubscriptionSSOPlugin::getActions	(		$request,
			$actionArgs
	)

Get a list of link actions for plugin management.

Parameters

request	PKPRequest
$actionArgs	array The list of action args to be included in request URLs.

Returns

array List of LinkActions

Reimplemented from Plugin.

Definition at line 101 of file SubscriptionSSOPlugin.inc.php.

References Plugin\$request, getDisplayName(), and Plugin\getEnabled().

getDescription()

SubscriptionSSOPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 155 of file SubscriptionSSOPlugin.inc.php.

getDisplayName()

SubscriptionSSOPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 148 of file SubscriptionSSOPlugin.inc.php.

Referenced by getActions().

loadHandlerCallback()

SubscriptionSSOPlugin::loadHandlerCallback	(		$hookName,
			$args
	)

Callback when a handler is loaded. Used to check for the presence of an incoming authentication, which needs to be verified.

Parameters

$hookName	string Hook name
$args	array Hook arguments

Returns

boolean Hook return status

Definition at line 38 of file SubscriptionSSOPlugin.inc.php.

References Plugin\$request, PKPApplication\get(), and Plugin\getSetting().

manage()

SubscriptionSSOPlugin::manage	(		$args,
			$request
	)

Reimplemented from Plugin.

Definition at line 123 of file SubscriptionSSOPlugin.inc.php.

References Plugin\$request, and PKPTemplateManager\getManager().

register()

SubscriptionSSOPlugin::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 SubscriptionSSOPlugin.inc.php.

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

subscribedUserCallback()

SubscriptionSSOPlugin::subscribedUserCallback	(		$hookName,
			$args
	)

Callback when a handler is loaded. Used to check for the presence of an incoming authentication, which needs to be verified.

Parameters

$hookName	string Hook name
$args	array Hook arguments

Returns

boolean Hook return status

Definition at line 79 of file SubscriptionSSOPlugin.inc.php.

References Plugin\$request, PKPApplication\get(), and Plugin\getSetting().

---

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

• SubscriptionSSOPlugin.inc.php