WebFeedPlugin Class Reference
Web Feeds plugin class. More...
Public Member Functions | |
| callbackAddLinks ($hookName, $args) | |
| callbackHandleShortURL ($hookName, $args) | |
| callbackLoadCategory ($hookName, $args) | |
| getDescription () | |
| getDisplayName () | |
| getEnabled () | |
| getManagementVerbs () | |
| getName () | |
| manage ($verb, $args) | |
| register ($category, $path) | |
Detailed Description
Web Feeds plugin class.Definition at line 20 of file WebFeedPlugin.inc.php.
Member Function Documentation
| WebFeedPlugin.callbackAddLinks | ( | $ | hookName, | |
| $ | args | |||
| ) |
Add feed links to page <head> on select/all pages.
Definition at line 96 of file WebFeedPlugin.inc.php.
References DAORegistry.getDAO(), getEnabled(), and Request.getRequestedPage().
| WebFeedPlugin.callbackHandleShortURL | ( | $ | hookName, | |
| $ | args | |||
| ) |
Handle requests for feed via short URLs (e.g., journalPath/feed/atom). This is for backwards compatibility with older versions of this plugin.
Definition at line 126 of file WebFeedPlugin.inc.php.
References getEnabled(), and Request.redirect().
| WebFeedPlugin.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 75 of file WebFeedPlugin.inc.php.
| WebFeedPlugin.getDescription | ( | ) |
Get the description of this plugin
- Returns:
- string
Reimplemented from Plugin.
Definition at line 41 of file WebFeedPlugin.inc.php.
References Locale.translate().
| WebFeedPlugin.getDisplayName | ( | ) |
Get the display name of this plugin
- Returns:
- string
Reimplemented from Plugin.
Definition at line 33 of file WebFeedPlugin.inc.php.
References Locale.translate().
| WebFeedPlugin.getEnabled | ( | ) |
Check whether or not this plugin is enabled
- Returns:
- boolean
Definition at line 62 of file WebFeedPlugin.inc.php.
References Request.getJournal().
Referenced by callbackAddLinks(), callbackHandleShortURL(), getManagementVerbs(), and register().
| WebFeedPlugin.getManagementVerbs | ( | ) |
Display verbs for the management interface.
Reimplemented from Plugin.
Definition at line 153 of file WebFeedPlugin.inc.php.
References getEnabled(), and Locale.translate().
| WebFeedPlugin.getName | ( | ) |
Get the symbolic name of this plugin
- Returns:
- string
Reimplemented from Plugin.
Definition at line 25 of file WebFeedPlugin.inc.php.
| WebFeedPlugin.manage | ( | $ | verb, | |
| $ | args | |||
| ) |
Perform management functions
Reimplemented from Plugin.
Definition at line 176 of file WebFeedPlugin.inc.php.
References Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), and Plugin.updateSetting().
| WebFeedPlugin.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 from Plugin.
Definition at line 45 of file WebFeedPlugin.inc.php.
References Plugin.addLocaleData(), getEnabled(), and HookRegistry.register().
The documentation for this class was generated from the following file:
- plugins/generic/webFeed/WebFeedPlugin.inc.php
