Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
WebFeedPlugin Class Reference
Inheritance diagram for WebFeedPlugin:

Public Member Functions

 callbackAddLinks ($hookName, $args)
 callbackHandleShortURL ($hookName, $args)
 callbackLoadCategory ($hookName, $args)
 getContextSpecificPluginSettingsFile ()
 getDescription ()
 getDisplayName ()
 getManagementVerbs ()
 manage ($verb, $args, &$message, &$messageParams)
 sanitize ($string)
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 getManagementVerbs ($verbs=array())
 manage ($verb, $args, &$message, &$messageParams)
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 getName ()
 LazyLoadPlugin ()
 register ($category, $path)
 setEnabled ($enabled)
- Public Member Functions inherited from Plugin
 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

Web Feeds plugin class.

Definition at line 18 of file

Member Function Documentation

WebFeedPlugin::callbackAddLinks (   $hookName,

Add feed links to page <head> on select/all pages.

Definition at line 84 of file

References Registry\get(), DAORegistry\getDAO(), PKPRequest\getRequestedPage(), Plugin\getSetting(), and sanitize().

WebFeedPlugin::callbackHandleShortURL (   $hookName,

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 120 of file

References PKPRequest\redirect().

WebFeedPlugin::callbackLoadCategory (   $hookName,

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.


Definition at line 63 of file

References PKPPlugin\getName().

WebFeedPlugin::getContextSpecificPluginSettingsFile ( )

Get the name of the settings file to be installed on new journal creation.


Definition at line 52 of file

References PKPPlugin\getPluginPath().

WebFeedPlugin::getDescription ( )

Get the description of this plugin


Definition at line 31 of file

WebFeedPlugin::getDisplayName ( )

Get the display name of this plugin


Definition at line 23 of file

WebFeedPlugin::getManagementVerbs ( )

Display verbs for the management interface.

Definition at line 147 of file

WebFeedPlugin::manage (   $verb,

Execute a management verb on this plugin

$messagestring Result status message
$messageParamsarray Parameters for the message key

Definition at line 163 of file

References Request\getJournal(), PKPRequest\getUserVar(), SettingsForm\readInputData(), PKPRequest\redirect(), and AppLocale\requireComponents().

WebFeedPlugin::sanitize (   $string)

Clean up the Journal title.


Definition at line 203 of file

Referenced by callbackAddLinks().

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