OpenAdsPlugin Class Reference
[Plugins_generic_openAds]
Integrate OpenAds ad manager with OJS.
More...
Public Member Functions | |
| callbackLoadCategory ($hookName, $args) | |
| getDescription () | |
| getDisplayName () | |
| getEnabled () | |
| getInstallationPath () | |
| getManagementVerbs () | |
| getName () | |
| isConfigured () | |
| manage ($verb, $args) | |
| register ($category, $path) | |
| rtOutputFilter ($output, &$smarty) | |
| setEnabled ($enabled) | |
Detailed Description
Integrate OpenAds ad manager with OJS.Definition at line 23 of file OpenAdsPlugin.inc.php.
Member Function Documentation
| OpenAdsPlugin.callbackLoadCategory | ( | $ | hookName, | |
| $ | args | |||
| ) |
Register as a block plugin, even though this is a generic plugin. This will allow the plugin to behave as a block plugin, i.e. to have layout tasks performed on it.
- Parameters:
-
$hookName string $args array
Definition at line 54 of file OpenAdsPlugin.inc.php.
| OpenAdsPlugin.getDescription | ( | ) |
Get a description of this plugin.
Reimplemented from Plugin.
Definition at line 81 of file OpenAdsPlugin.inc.php.
References Plugin.addLocaleData(), isConfigured(), and Locale.translate().
| OpenAdsPlugin.getDisplayName | ( | ) |
Get the display name for this plugin.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 76 of file OpenAdsPlugin.inc.php.
References Plugin.addLocaleData(), and Locale.translate().
| OpenAdsPlugin.getEnabled | ( | ) |
Determine whether or not this plugin is enabled.
Definition at line 203 of file OpenAdsPlugin.inc.php.
References Request.getJournal().
Referenced by getManagementVerbs(), and register().
| OpenAdsPlugin.getInstallationPath | ( | ) |
Get the installation path to OpenAds
- Returns:
- string
Definition at line 265 of file OpenAdsPlugin.inc.php.
References Config.getVar().
Referenced by isConfigured(), manage(), and rtOutputFilter().
| OpenAdsPlugin.getManagementVerbs | ( | ) |
Display verbs for the management interface.
Reimplemented from Plugin.
Definition at line 180 of file OpenAdsPlugin.inc.php.
References getEnabled(), isConfigured(), and Locale.translate().
| OpenAdsPlugin.getName | ( | ) |
Get the name of this plugin. The name must be unique within its category.
- Returns:
- String name of plugin
Reimplemented from Plugin.
Definition at line 72 of file OpenAdsPlugin.inc.php.
| OpenAdsPlugin.isConfigured | ( | ) |
Get the configured state of this plugin
- Returns:
- boolean
Definition at line 255 of file OpenAdsPlugin.inc.php.
References getInstallationPath().
Referenced by getDescription(), and getManagementVerbs().
| OpenAdsPlugin.manage | ( | $ | verb, | |
| $ | args | |||
| ) |
Perform management functions
Reimplemented from Plugin.
Definition at line 224 of file OpenAdsPlugin.inc.php.
References getInstallationPath(), Request.getJournal(), TemplateManager.getManager(), Request.redirect(), and setEnabled().
| OpenAdsPlugin.register | ( | $ | category, | |
| $ | path | |||
| ) |
Called as a plugin is registered to the registry
- Parameters:
-
$category String Name of category plugin was registered to
- Returns:
- boolean True iff plugin initialized successfully; if false, the plugin will not be registered.
Reimplemented from Plugin.
Definition at line 33 of file OpenAdsPlugin.inc.php.
References Plugin.addLocaleData(), getEnabled(), and HookRegistry.register().
| OpenAdsPlugin.rtOutputFilter | ( | $ | output, | |
| &$ | smarty | |||
| ) |
Output filter to modify the RT sidebar
Definition at line 157 of file OpenAdsPlugin.inc.php.
References getInstallationPath(), Request.getJournal(), and Locale.translate().
| OpenAdsPlugin.setEnabled | ( | $ | enabled | ) |
Set the enabled/disabled state of this plugin
Definition at line 212 of file OpenAdsPlugin.inc.php.
References Request.getJournal(), and Plugin.updateSetting().
Referenced by manage().
The documentation for this class was generated from the following file:
- plugins/generic/openAds/OpenAdsPlugin.inc.php
