Abstract class for plugins. More...
Public Member Functions | |
| getCurrentVersion () | |
| getNewConferencePluginSettingsFile () | |
| installConferenceSettings ($hookName, $args) | |
| installSiteSettings ($hookName, $args) | |
| Plugin () | |
| register ($category, $path) | |
| updateSetting ($conferenceId, $schedConfId, $name, $value, $type=null) | |
Detailed Description
Abstract class for plugins.
Definition at line 20 of file Plugin.inc.php.
Member Function Documentation
| Plugin.getCurrentVersion | ( | ) |
Get the current version of this plugin
- Returns:
- object Version
Definition at line 113 of file Plugin.inc.php.
| Plugin.getNewConferencePluginSettingsFile | ( | ) |
Get the filename of the settings data for this plugin to install when a conference is created (i.e. conference-level plugin settings). Subclasses using default settings should override this.
- Returns:
- string
Reimplemented in DevelopedByBlockPlugin, FontSizeBlockPlugin, InformationBlockPlugin, NavigationBlockPlugin, NotificationBlockPlugin, RoleBlockPlugin, UserBlockPlugin, and TinyMCEPlugin.
Definition at line 74 of file Plugin.inc.php.
Referenced by installConferenceSettings(), and register().
| Plugin.installConferenceSettings | ( | $ | hookName, | |
| $ | args | |||
| ) |
Callback used to install settings on conference creation.
- Parameters:
-
$hookName string $args array
- Returns:
- boolean
Definition at line 84 of file Plugin.inc.php.
References getNewConferencePluginSettingsFile().
| Plugin.installSiteSettings | ( | $ | hookName, | |
| $ | args | |||
| ) |
Callback used to install settings on system install.
- Parameters:
-
$hookName string $args array
- Returns:
- boolean
Definition at line 99 of file Plugin.inc.php.
| Plugin.Plugin | ( | ) |
Constructor
Definition at line 24 of file Plugin.inc.php.
Referenced by AuthPlugin.AuthPlugin(), and PaymethodPlugin.PaymethodPlugin().
| 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, OAIMetadataFormatPlugin, PaymethodPlugin, LDAPAuthPlugin, DevelopedByBlockPlugin, FontSizeBlockPlugin, InformationBlockPlugin, NavigationBlockPlugin, NotificationBlockPlugin, RoleBlockPlugin, UserBlockPlugin, AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, TurabianCitationPlugin, AcronPlugin, AnnouncementFeedPlugin, CustomBlockManagerPlugin, CustomLocalePlugin, GoogleAnalyticsPlugin, JQueryPlugin, PhpMyVisitesPlugin, StaticPagesPlugin, TinyMCEPlugin, TranslatorPlugin, NativeImportExportPlugin, NLMExportPlugin, UserImportExportPlugin, ManualPaymentPlugin, PayPalPlugin, PaperReportPlugin, RegistrantReportPlugin, and ReviewReportPlugin.
Definition at line 41 of file Plugin.inc.php.
References getNewConferencePluginSettingsFile().
Referenced by CitationPlugin.displayCitation().
| Plugin.updateSetting | ( | $ | conferenceId, | |
| $ | schedConfId, | |||
| $ | name, | |||
| $ | value, | |||
| $ | type = null | |||
| ) |
Update a plugin setting.
- Parameters:
-
$conferenceId int $schedConfId int $name string The name of the setting $value mixed $type string optional
Definition at line 63 of file Plugin.inc.php.
Referenced by BlockPlugin.setBlockContext(), StaticPagesPlugin.setEnabled(), PhpMyVisitesPlugin.setEnabled(), GoogleAnalyticsPlugin.setEnabled(), CustomBlockManagerPlugin.setEnabled(), GatewayPlugin.setEnabled(), BlockPlugin.setEnabled(), and BlockPlugin.setSeq().
The documentation for this class was generated from the following file:
- classes/plugins/Plugin.inc.php
Generated on Thu Sep 20 2012 17:26:07 for Open Conference Systems by
1.7.1