Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
GenericPlugin Class Reference
Inheritance diagram for GenericPlugin:
AcronPlugin AnnouncementFeedPlugin BackupPlugin BrowsePlugin CoinsPlugin CustomBlockManagerPlugin CustomLocalePlugin DRIVERPlugin ExternalFeedPlugin GoogleAnalyticsPlugin GoogleViewerPlugin LucenePlugin OpenAdsPlugin OpenAIREPlugin PhpMyVisitesPlugin PiwikPlugin ReferralPlugin RoundedCornersPlugin SehlPlugin StaticPagesPlugin StopForumSpamPlugin SwordPlugin ThesisFeedPlugin ThesisPlugin TinyMCEPlugin TranslatorPlugin UsageEventPlugin UsageStatsPlugin WebFeedPlugin XMLGalleyPlugin

Public Member Functions

 GenericPlugin ()
 
 getManagementVerbs ($verbs=array())
 
 manage ($verb, $args, &$message, &$messageParams)
 
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 
 getName ()
 
 LazyLoadPlugin ()
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 
 getNewJournalPluginSettingsFile ()
 
 getSetting ($journalId, $name)
 
 Plugin ()
 
 updateSetting ($journalId, $name, $value, $type=null)
 
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 
 addHelpData ($locale=null)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHelpMappingFilename ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getSettingMainContext ()
 
 getTemplatePath ()
 
 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, $request=null)
 
 PKPPlugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 

Detailed Description

Abstract class for generic plugins.

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

Member Function Documentation

GenericPlugin::GenericPlugin ( )

Constructor

Definition at line 23 of file GenericPlugin.inc.php.

GenericPlugin::getManagementVerbs (   $verbs = array())

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
PKPPlugin::getManagementVerbs()

Definition at line 41 of file GenericPlugin.inc.php.

References Validation\isSiteAdmin(), and PKPPlugin\isSitePlugin().

GenericPlugin::manage (   $verb,
  $args,
$message,
$messageParams 
)
See Also
PKPPlugin::manage()

Definition at line 58 of file GenericPlugin.inc.php.

References PKPPlugin\getDisplayName().


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