Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Plugin Class Reference
Inheritance diagram for Plugin:
PKPPlugin AuthPlugin CitationPlugin GatewayPlugin ImplicitAuthPlugin ImportExportPlugin MetadataPlugin OAIMetadataFormatPlugin PaymethodPlugin PKPAbntCitationOutputPlugin PKPApaCitationOutputPlugin PKPCrossrefCitationLookupPlugin PKPFreeciteCitationParserPlugin PKPIsbndbCitationLookupPlugin PKPMlaCitationOutputPlugin PKPParaciteCitationParserPlugin PKPParscitCitationParserPlugin PKPPubmedCitationLookupPlugin PKPRegexCitationParserPlugin PKPVancouverCitationOutputPlugin PKPWorldcatCitationLookupPlugin PubIdPlugin ReportPlugin ThemePlugin

Public Member Functions

 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 plugins.

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

Member Function Documentation

Plugin::getContextSpecificPluginSettingsFile ( )

Get the filename of the settings data for this plugin to install when a journal is created (i.e. journal-level plugin settings). Subclasses using default settings should override this.

Returns
string

Definition at line 69 of file Plugin.inc.php.

References getNewJournalPluginSettingsFile().

Plugin::getNewJournalPluginSettingsFile ( )

For backwards compatibility only.

New plug-ins should override getContextSpecificPluginSettingsFile()

See Also
PKPPlugin::getContextSpecificPluginSettingsFile()
Returns
string

Definition at line 84 of file Plugin.inc.php.

Referenced by getContextSpecificPluginSettingsFile().

Plugin::getSetting (   $journalId,
  $name 
)

Backwards compatible convenience version of the generic getContextSpecificSetting() method.

See Also
PKPPlugin::getContextSpecificSetting()
Parameters
$journalId
$name

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

References PKPPlugin\getContextSpecificSetting(), and DAORegistry\getDAO().

Referenced by DOIExportPlugin\_displayPluginHomePage(), LucenePlugin\_getEnabledFacetCategories(), LucenePlugin\_spamCheck(), BrowsePlugin\addNavigationItem(), WebFeedPlugin\callbackAddLinks(), LucenePlugin\callbackArticleChangesFinished(), SwordPlugin\callbackAuthorDeposits(), CustomBlockManagerPlugin\callbackLoadCategory(), AcronPlugin\callbackLoadHandler(), LucenePlugin\callbackRebuildIndex(), LucenePlugin\callbackRetrieveResults(), LucenePlugin\callbackTemplateAdditionalArticleInfo(), LucenePlugin\callbackTemplateAdditionalArticleLinks(), DOIExportPlugin\display(), ManualPaymentPlugin\displayPaymentForm(), PayPalPlugin\displayPaymentForm(), MedraExportPlugin\generateExportFiles(), CustomBlockPlugin\getContents(), SwordPlugin\getEnabled(), GatewayPlugin\getEnabled(), PiwikPlugin\getEnabled(), BackupPlugin\getEnabled(), PubIdPlugin\getEnabled(), MetadataPlugin\getInstallDataFile(), AbntCitationPlugin\getLocalizedLocation(), AcronPlugin\getManagementVerbs(), URNPubIdPlugin\getPubId(), DOIPubIdPlugin\getPubId(), URNPubIdPlugin\getResolvingURL(), ExternalFeedPlugin\getStyleSheetFile(), UsageEventPlugin\getUniqueSiteId(), PayPalPlugin\handle(), PhpMyVisitesPlugin\insertFooter(), PiwikPlugin\insertFooter(), GoogleAnalyticsPlugin\insertFooter(), ManualPaymentPlugin\isConfigured(), PayPalPlugin\isConfigured(), ReferralPlugin\logArticleRequest(), UsageStatsPlugin\register(), LucenePlugin\register(), MedraExportPlugin\registerDoi(), DataciteExportPlugin\registerDoi(), OpenAdsPlugin\rtOutputFilter(), XMLGalleyPlugin\setEnabled(), StopForumSpamPlugin\validateExecute(), URNPubIdPlugin\verifyData(), DOIPubIdPlugin\verifyData(), and XMLGalleyPlugin\viewXMLGalleyFile().

Plugin::Plugin ( )

Constructor

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

Plugin::updateSetting (   $journalId,
  $name,
  $value,
  $type = null 
)

Backwards compatible convenience version of the generic updateContextSpecificSetting() method.

See Also
PKPPlugin::updateContextSpecificSetting()
Parameters
$journalIdint
$namestring The name of the setting
$valuemixed
$typestring optional

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

References PKPPlugin\updateContextSpecificSetting().

Referenced by UsageEventPlugin\_buildUsageEvent(), AcronPlugin\_parseCrontab(), LucenePlugin\_spamCheck(), AcronPlugin\manage(), BackupPlugin\manage(), GatewayPlugin\setEnabled(), PiwikPlugin\setEnabled(), XMLGalleyPlugin\setEnabled(), and PubIdPlugin\setEnabled().


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