Plugin Class Reference
[Plugins]

Abstract class for plugins. More...

Inheritance diagram for Plugin:

AuthPlugin BlockPlugin CitationPlugin GatewayPlugin GenericPlugin ImplicitAuthPlugin ImportExportPlugin PaymethodPlugin ReportPlugin ThemePlugin

List of all members.

Public Member Functions

 addHelpData ($locale=null)
 addLocaleData ($locale=null)
 getCategory ()
 getDescription ()
 getDisplayName ()
 getHelpMappingFilename ()
 getInstallDataFile ()
 getInstallSchemaFile ()
 getInstallSitePluginSettingsFile ()
 getLocaleFilename ($locale)
 getManagementVerbs ()
 getName ()
 getNewJournalPluginSettingsFile ()
 getPluginPath ()
 getSeq ()
 import ($class)
 installData ($hookName, $args)
 installJournalSettings ($hookName, $args)
 installSiteSettings ($hookName, $args)
 isSitePlugin ()
 manage ($verb, $args)
 Plugin ()
 register ($category, $path)
 smartyPluginUrl ($params, &$smarty)
 updateSchema ($hookName, $args)
 updateSetting ($journalId, $name, $value, $type=null)

Detailed Description

Abstract class for plugins.

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

Member Function Documentation

Plugin.addHelpData ( $  locale = null  ) 

Add help data for this plugin.

Parameters:
$locale string
Returns:
boolean

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

References Help.getHelp(), and Locale.getLocale().

Referenced by TranslatorPlugin.register().

Plugin.addLocaleData ( $  locale = null  ) 

Load locale data for this plugin.

Parameters:
$locale string
Returns:
boolean

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

References Locale.getLocale(), getLocaleFilename(), and Locale.registerLocaleFile().

Referenced by OpenAdsPlugin.getDescription(), CounterPlugin.getDescription(), OpenAdsPlugin.getDisplayName(), CounterPlugin.getDisplayName(), CounterPlugin.getManagementVerbs(), CounterPlugin.manage(), CustomThemePlugin.register(), ArticleReportPlugin.register(), PayPalPlugin.register(), ManualPaymentPlugin.register(), UserImportExportPlugin.register(), SampleImportExportPlugin.register(), PubMedExportPlugin.register(), NativeImportExportPlugin.register(), EruditExportPlugin.register(), DOAJPlugin.register(), CrossRefExportPlugin.register(), XMLGalleyPlugin.register(), WebFeedPlugin.register(), TranslatorPlugin.register(), TinyMCEPlugin.register(), ThesisFeedPlugin.register(), ThesisPlugin.register(), SehlPlugin.register(), RoundedCornersPlugin.register(), PhpMyVisitesPlugin.register(), OpenAdsPlugin.register(), GoogleAnalyticsPlugin.register(), CustomLocalePlugin.register(), CoinsPlugin.register(), CmsRssPlugin.register(), CmsPlugin.register(), AnnouncementFeedPlugin.register(), ResolverPlugin.register(), METSGatewayPlugin.register(), TurabianCitationPlugin.register(), RefWorksCitationPlugin.register(), RefManCitationPlugin.register(), ProCiteCitationPlugin.register(), MlaCitationPlugin.register(), EndNoteCitationPlugin.register(), CbeCitationPlugin.register(), BibtexCitationPlugin.register(), ApaCitationPlugin.register(), AbntCitationPlugin.register(), UserBlockPlugin.register(), SubscriptionBlockPlugin.register(), RoleBlockPlugin.register(), NavigationBlockPlugin.register(), LanguageToggleBlockPlugin.register(), InformationBlockPlugin.register(), HelpBlockPlugin.register(), FontSizeBlockPlugin.register(), DonationBlockPlugin.register(), DevelopedByBlockPlugin.register(), and LDAPAuthPlugin.register().

Plugin.getCategory (  ) 

Get the name of the category this plugin is registered to.

Returns:
String category

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

Referenced by CustomThemePlugin.smartyPluginUrl(), ThesisPlugin.smartyPluginUrl(), PhpMyVisitesPlugin.smartyPluginUrl(), GoogleAnalyticsPlugin.smartyPluginUrl(), CustomLocalePlugin.smartyPluginUrl(), and smartyPluginUrl().

Plugin.getDescription (  ) 

Get a description of this plugin.

Reimplemented in AuthPlugin, BlockPlugin, CitationPlugin, GatewayPlugin, ImportExportPlugin, PaymethodPlugin, ReportPlugin, ThemePlugin, LDAPAuthPlugin, DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, RoleBlockPlugin, SubscriptionBlockPlugin, UserBlockPlugin, AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, TurabianCitationPlugin, METSGatewayPlugin, ResolverPlugin, AnnouncementFeedBlockPlugin, AnnouncementFeedGatewayPlugin, AnnouncementFeedPlugin, CmsBlockPlugin, CmsPlugin, CmsRssPlugin, CoinsPlugin, CounterPlugin, CustomLocalePlugin, GoogleAnalyticsPlugin, OpenAdsBlockPlugin, OpenAdsPlugin, PhpMyVisitesPlugin, RoundedCornersPlugin, SehlPlugin, ThesisPlugin, ThesisFeedBlockPlugin, ThesisFeedGatewayPlugin, ThesisFeedPlugin, TinyMCEPlugin, TranslatorPlugin, WebFeedBlockPlugin, WebFeedGatewayPlugin, WebFeedPlugin, XMLGalleyPlugin, CrossRefExportPlugin, DOAJPlugin, EruditExportPlugin, NativeImportExportPlugin, PubMedExportPlugin, SampleImportExportPlugin, UserImportExportPlugin, ManualPaymentPlugin, PayPalPlugin, ArticleReportPlugin, ClassicBlueThemePlugin, ClassicBrownThemePlugin, ClassicGreenThemePlugin, ClassicNavyThemePlugin, ClassicRedThemePlugin, CustomThemePlugin, DesertThemePlugin, LilacThemePlugin, NightThemePlugin, RedbarThemePlugin, SteelThemePlugin, UncommonThemePlugin, and VanillaThemePlugin.

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

Plugin.getDisplayName (  ) 

Get the display name for this plugin.

Returns:
string

Reimplemented in AuthPlugin, BlockPlugin, CitationPlugin, GatewayPlugin, ImportExportPlugin, ReportPlugin, ThemePlugin, LDAPAuthPlugin, DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, RoleBlockPlugin, SubscriptionBlockPlugin, UserBlockPlugin, AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, TurabianCitationPlugin, METSGatewayPlugin, ResolverPlugin, AnnouncementFeedBlockPlugin, AnnouncementFeedGatewayPlugin, AnnouncementFeedPlugin, CmsBlockPlugin, CmsPlugin, CmsRssPlugin, CoinsPlugin, CounterPlugin, CustomLocalePlugin, GoogleAnalyticsPlugin, OpenAdsBlockPlugin, OpenAdsPlugin, PhpMyVisitesPlugin, RoundedCornersPlugin, SehlPlugin, ThesisPlugin, ThesisFeedBlockPlugin, ThesisFeedGatewayPlugin, ThesisFeedPlugin, TinyMCEPlugin, TranslatorPlugin, WebFeedBlockPlugin, WebFeedGatewayPlugin, WebFeedPlugin, XMLGalleyPlugin, CrossRefExportPlugin, DOAJPlugin, EruditExportPlugin, NativeImportExportPlugin, PubMedExportPlugin, SampleImportExportPlugin, UserImportExportPlugin, ManualPaymentPlugin, PayPalPlugin, ArticleReportPlugin, ClassicBlueThemePlugin, ClassicBrownThemePlugin, ClassicGreenThemePlugin, ClassicNavyThemePlugin, ClassicRedThemePlugin, CustomThemePlugin, DesertThemePlugin, LilacThemePlugin, NightThemePlugin, RedbarThemePlugin, SteelThemePlugin, UncommonThemePlugin, and VanillaThemePlugin.

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

References getName().

Plugin.getHelpMappingFilename (  ) 

Get the path and filename of the help mapping file, if this plugin includes help files.

Returns:
string

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

References getPluginPath().

Plugin.getInstallDataFile (  ) 

Get the filename of the install data for this plugin. Subclasses using SQL tables should override this.

Returns:
string

Reimplemented in ThesisPlugin, DOAJPlugin, ManualPaymentPlugin, and PayPalPlugin.

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

Referenced by installData(), and register().

Plugin.getInstallSchemaFile (  ) 

Get the filename of the ADODB schema for this plugin. Subclasses using SQL tables should override this.

Returns:
string

Reimplemented in ThesisPlugin, XMLGalleyPlugin, and PayPalPlugin.

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

Referenced by register(), and updateSchema().

Plugin.getInstallSitePluginSettingsFile (  ) 

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

Returns:
string

Reimplemented in DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, UserBlockPlugin, CoinsPlugin, and TinyMCEPlugin.

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

Referenced by installSiteSettings(), and register().

Plugin.getLocaleFilename ( $  locale  ) 

Get the filename for the locale data for this plugin.

Parameters:
$locale string
Returns:
string

Reimplemented in ClassicBlueThemePlugin, ClassicBrownThemePlugin, ClassicGreenThemePlugin, ClassicNavyThemePlugin, ClassicRedThemePlugin, DesertThemePlugin, LilacThemePlugin, NightThemePlugin, RedbarThemePlugin, SteelThemePlugin, UncommonThemePlugin, and VanillaThemePlugin.

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

References getPluginPath().

Referenced by addLocaleData().

Plugin.getManagementVerbs (  ) 

Get a list of management actions in the form of a page => value pair. The management actions from this list are passed to the manage() function when called.

Reimplemented in AuthPlugin, GatewayPlugin, ImportExportPlugin, ReportPlugin, METSGatewayPlugin, ResolverPlugin, AnnouncementFeedGatewayPlugin, AnnouncementFeedPlugin, CmsPlugin, CmsRssPlugin, CoinsPlugin, CounterPlugin, CustomLocalePlugin, GoogleAnalyticsPlugin, OpenAdsPlugin, PhpMyVisitesPlugin, RoundedCornersPlugin, SehlPlugin, ThesisPlugin, ThesisFeedPlugin, TinyMCEPlugin, TranslatorPlugin, WebFeedPlugin, XMLGalleyPlugin, and CustomThemePlugin.

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

Plugin.getName (  ) 

Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns:
String name of plugin

Reimplemented in AuthPlugin, BlockPlugin, CitationPlugin, GatewayPlugin, ImportExportPlugin, PaymethodPlugin, ReportPlugin, ThemePlugin, LDAPAuthPlugin, DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, RoleBlockPlugin, SubscriptionBlockPlugin, UserBlockPlugin, AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, TurabianCitationPlugin, METSGatewayPlugin, ResolverPlugin, AnnouncementFeedBlockPlugin, AnnouncementFeedGatewayPlugin, AnnouncementFeedPlugin, CmsBlockPlugin, CmsPlugin, CmsRssPlugin, CoinsPlugin, CounterPlugin, CustomLocalePlugin, GoogleAnalyticsPlugin, OpenAdsBlockPlugin, OpenAdsPlugin, PhpMyVisitesPlugin, RoundedCornersPlugin, SehlPlugin, ThesisPlugin, ThesisFeedBlockPlugin, ThesisFeedGatewayPlugin, ThesisFeedPlugin, TinyMCEPlugin, TranslatorPlugin, WebFeedBlockPlugin, WebFeedGatewayPlugin, WebFeedPlugin, XMLGalleyPlugin, CrossRefExportPlugin, DOAJPlugin, EruditExportPlugin, NativeImportExportPlugin, PubMedExportPlugin, SampleImportExportPlugin, UserImportExportPlugin, ManualPaymentPlugin, PayPalPlugin, ArticleReportPlugin, ClassicBlueThemePlugin, ClassicBrownThemePlugin, ClassicGreenThemePlugin, ClassicNavyThemePlugin, ClassicRedThemePlugin, CustomThemePlugin, DesertThemePlugin, LilacThemePlugin, NightThemePlugin, RedbarThemePlugin, SteelThemePlugin, UncommonThemePlugin, and VanillaThemePlugin.

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

Referenced by getDisplayName(), installJournalSettings(), installSiteSettings(), smartyPluginUrl(), and updateSetting().

Plugin.getNewJournalPluginSettingsFile (  ) 

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

Reimplemented in DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, RoleBlockPlugin, SubscriptionBlockPlugin, UserBlockPlugin, ResolverPlugin, and TinyMCEPlugin.

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

Referenced by installJournalSettings(), and register().

Plugin.getPluginPath (  ) 

Get the path this plugin's files are located in.

Returns:
String pathname

Reimplemented in AnnouncementFeedBlockPlugin, AnnouncementFeedGatewayPlugin, CmsBlockPlugin, OpenAdsBlockPlugin, ThesisFeedBlockPlugin, ThesisFeedGatewayPlugin, WebFeedBlockPlugin, and WebFeedGatewayPlugin.

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

Referenced by ThemePlugin.activate(), getHelpMappingFilename(), PayPalPlugin.getInstallDataFile(), ManualPaymentPlugin.getInstallDataFile(), DOAJPlugin.getInstallDataFile(), ThesisPlugin.getInstallDataFile(), PayPalPlugin.getInstallSchemaFile(), XMLGalleyPlugin.getInstallSchemaFile(), ThesisPlugin.getInstallSchemaFile(), TinyMCEPlugin.getInstallSitePluginSettingsFile(), CoinsPlugin.getInstallSitePluginSettingsFile(), UserBlockPlugin.getInstallSitePluginSettingsFile(), NavigationBlockPlugin.getInstallSitePluginSettingsFile(), LanguageToggleBlockPlugin.getInstallSitePluginSettingsFile(), HelpBlockPlugin.getInstallSitePluginSettingsFile(), FontSizeBlockPlugin.getInstallSitePluginSettingsFile(), DonationBlockPlugin.getInstallSitePluginSettingsFile(), DevelopedByBlockPlugin.getInstallSitePluginSettingsFile(), getLocaleFilename(), TinyMCEPlugin.getNewJournalPluginSettingsFile(), ResolverPlugin.getNewJournalPluginSettingsFile(), UserBlockPlugin.getNewJournalPluginSettingsFile(), SubscriptionBlockPlugin.getNewJournalPluginSettingsFile(), RoleBlockPlugin.getNewJournalPluginSettingsFile(), NavigationBlockPlugin.getNewJournalPluginSettingsFile(), LanguageToggleBlockPlugin.getNewJournalPluginSettingsFile(), InformationBlockPlugin.getNewJournalPluginSettingsFile(), HelpBlockPlugin.getNewJournalPluginSettingsFile(), FontSizeBlockPlugin.getNewJournalPluginSettingsFile(), DonationBlockPlugin.getNewJournalPluginSettingsFile(), DevelopedByBlockPlugin.getNewJournalPluginSettingsFile(), import(), and XMLGalleyPlugin.manage().

Plugin.getSeq (  ) 

Return a number indicating the sequence in which this plugin should be registered compared to others of its category. Higher = later.

Reimplemented in BlockPlugin, DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, and LanguageToggleBlockPlugin.

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

Plugin.import ( $  class  ) 

Load a PHP file from this plugin's installation directory.

Parameters:
$class string

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

References getPluginPath().

Plugin.installData ( $  hookName,
$  args 
)

Callback used to install data files.

Parameters:
$hookName string
$args array
Returns:
boolean

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

References getInstallDataFile(), and Locale.translate().

Plugin.installJournalSettings ( $  hookName,
$  args 
)

Callback used to install settings on journal creation.

Parameters:
$hookName string
$args array
Returns:
boolean

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

References DAORegistry.getDAO(), getName(), and getNewJournalPluginSettingsFile().

Plugin.installSiteSettings ( $  hookName,
$  args 
)

Callback used to install settings on system install.

Parameters:
$hookName string
$args array
Returns:
boolean

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

References DAORegistry.getDAO(), getInstallSitePluginSettingsFile(), and getName().

Plugin.isSitePlugin (  ) 

Site-wide plugins should override this function to return true.

Reimplemented in AuthPlugin, CounterPlugin, and TranslatorPlugin.

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

Plugin.manage ( $  verb,
$  args 
)

Perform a management function.

Reimplemented in AuthPlugin, GatewayPlugin, ImportExportPlugin, ReportPlugin, METSGatewayPlugin, ResolverPlugin, AnnouncementFeedPlugin, CmsPlugin, CmsRssPlugin, CoinsPlugin, CounterPlugin, CustomLocalePlugin, GoogleAnalyticsPlugin, OpenAdsPlugin, PhpMyVisitesPlugin, RoundedCornersPlugin, SehlPlugin, ThesisPlugin, ThesisFeedPlugin, TinyMCEPlugin, TranslatorPlugin, WebFeedPlugin, and XMLGalleyPlugin.

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

Plugin.Plugin (  ) 

Constructor

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

Plugin.register ( $  category,
$  path 
)

Called as a plugin is registered to the registry. Subclasses over- riding this method should call the parent method first.

Parameters:
$category String Name of category plugin was registered to
$path String The path the plugin was found in
Returns:
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Reimplemented in BlockPlugin, PaymethodPlugin, LDAPAuthPlugin, DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, RoleBlockPlugin, SubscriptionBlockPlugin, UserBlockPlugin, AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, TurabianCitationPlugin, METSGatewayPlugin, ResolverPlugin, AnnouncementFeedPlugin, CmsPlugin, CmsRssPlugin, CoinsPlugin, CounterPlugin, CustomLocalePlugin, GoogleAnalyticsPlugin, OpenAdsPlugin, PhpMyVisitesPlugin, RoundedCornersPlugin, SehlPlugin, ThesisPlugin, ThesisFeedPlugin, TinyMCEPlugin, TranslatorPlugin, WebFeedPlugin, XMLGalleyPlugin, CrossRefExportPlugin, DOAJPlugin, EruditExportPlugin, NativeImportExportPlugin, PubMedExportPlugin, SampleImportExportPlugin, UserImportExportPlugin, ManualPaymentPlugin, PayPalPlugin, ArticleReportPlugin, and CustomThemePlugin.

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

References getInstallDataFile(), getInstallSchemaFile(), getInstallSitePluginSettingsFile(), getNewJournalPluginSettingsFile(), and HookRegistry.register().

Plugin.smartyPluginUrl ( $  params,
&$  smarty 
)

Extend the {url ...} smarty to support plugins.

Reimplemented in ImportExportPlugin, ReportPlugin, CustomLocalePlugin, GoogleAnalyticsPlugin, PhpMyVisitesPlugin, ThesisPlugin, and CustomThemePlugin.

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

References getCategory(), and getName().

Plugin.updateSchema ( $  hookName,
$  args 
)

Called during the install process to install the plugin schema, if applicable.

Parameters:
$hookName string
$args array
Returns:
boolean

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

References getInstallSchemaFile(), and Locale.translate().

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

Update a plugin setting.

Parameters:
$journalId int
$name string The name of the setting
$value mixed
$type string optional

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

References DAORegistry.getDAO(), and getName().

Referenced by XMLGalleyPlugin.manage(), WebFeedPlugin.manage(), TranslatorPlugin.manage(), TinyMCEPlugin.manage(), ThesisFeedPlugin.manage(), SehlPlugin.manage(), CounterPlugin.manage(), AnnouncementFeedPlugin.manage(), BlockPlugin.setBlockContext(), XMLGalleyPlugin.setEnabled(), ThesisPlugin.setEnabled(), RoundedCornersPlugin.setEnabled(), PhpMyVisitesPlugin.setEnabled(), OpenAdsPlugin.setEnabled(), GoogleAnalyticsPlugin.setEnabled(), CoinsPlugin.setEnabled(), CmsRssPlugin.setEnabled(), CmsPlugin.setEnabled(), GatewayPlugin.setEnabled(), BlockPlugin.setEnabled(), and BlockPlugin.setSeq().

The documentation for this class was generated from the following file:
Generated on Mon Jul 14 10:55:45 2008 for Open Journal Systems by  doxygen 1.5.6