Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
GenericPlugin Class Reference
Inheritance diagram for GenericPlugin:
AddThisPlugin PKPAcronPlugin PKPUsageEventPlugin PKPUsageStatsPlugin TinyMCEPlugin TranslatorPlugin ViewableFilePlugin AcronPlugin UsageEventPlugin PdfSubmissionFilePlugin

Public Member Functions

 GenericPlugin ()
 getManagementVerbs ()
 manage ($verb, $args, &$message, &$messageParams, &$pluginModalContent=null)
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 getName ()
 LazyLoadPlugin ()
 register ($category, $path)
 setEnabled ($enabled)
- Public Member Functions inherited from Plugin
 _getContextSpecificInstallationHook ()
 addLocaleData ($locale=null)
 getCategory ()
 getContextSpecificPluginSettingsFile ()
 getContextSpecificSetting ($context, $name)
 getCurrentVersion ()
 getDescription ()
 getDisplayName ()
 getHideManagement ()
 getInstallDataFile ()
 getInstallEmailTemplateDataFile ()
 getInstallEmailTemplatesFile ()
 getInstallFilterConfigFiles ()
 getInstallSchemaFile ()
 getInstallSitePluginSettingsFile ()
 getLocaleFilename ($locale)
 getManagementVerbLinkAction ($request, $verb)
 getManagementVerbs ()
 getName ()
 getPluginPath ()
getRequest ()
 getSeq ()
 getSetting ($contextId, $name)
 getSettingMainContext ()
 getTemplatePath ($inCore=false)
 import ($class)
 installContextSpecificSettings ($hookName, $args)
 installData ($hookName, $args)
 installEmailTemplateData ($hookName, $args)
 installEmailTemplates ($hookName, $args)
 installFilters ($hookName, $args)
 installLocale ($hookName, $args)
 installSiteSettings ($hookName, $args)
 isSitePlugin ()
 manage ($verb, $args, &$message, &$messageParams, &$pluginModalContent=null)
 Plugin ()
 register ($category, $path)
 smartyPluginUrl ($params, &$smarty)
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 updateSchema ($hookName, $args)
 updateSetting ($contextId, $name, $value, $type=null)

Additional Inherited Members

- Public Attributes inherited from Plugin

Detailed Description

Abstract class for generic plugins.

Definition at line 19 of file

Member Function Documentation

GenericPlugin::GenericPlugin ( )


Definition at line 23 of file

GenericPlugin::getManagementVerbs ( )

Generic plug-ins implement the enabled/disabled logic by default. This is necessary so that we can make sure that disabled plug-ins will not have to be instantiated.

Call this method with a list of management verbs (if any) generated by the custom plug-in.

See Also

Definition at line 41 of file

References PKPValidation\isSiteAdmin(), and Plugin\isSitePlugin().

GenericPlugin::manage (   $verb,
$pluginModalContent = null 
See Also

Definition at line 58 of file

References Plugin\getDisplayName().

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