Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
WebFeedGatewayPlugin Class Reference
Inheritance diagram for WebFeedGatewayPlugin:
GatewayPlugin Plugin PKPPlugin

Public Member Functions

 fetch ($args)
 
 getEnabled ()
 
 getHideManagement ()
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getTemplatePath ()
 
getWebFeedPlugin ()
 
- Public Member Functions inherited from GatewayPlugin
 fetch ($args, $request)
 
 getDescription ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getManagementVerbs ()
 
 getName ()
 
 manage ($verb, $args)
 
 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

Gateway component of web feed plugin.

Definition at line 19 of file WebFeedGatewayPlugin.inc.php.

Member Function Documentation

WebFeedGatewayPlugin::fetch (   $args)

Handle fetch requests for this plugin.

Definition at line 100 of file WebFeedGatewayPlugin.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), getTemplatePath(), and getWebFeedPlugin().

WebFeedGatewayPlugin::getEnabled ( )

Get whether or not this plugin is enabled. (Should always return true, as the parent plugin will take care of loading this one when needed)

Returns
boolean

Definition at line 83 of file WebFeedGatewayPlugin.inc.php.

References getWebFeedPlugin().

WebFeedGatewayPlugin::getHideManagement ( )

Hide this plugin from the management interface (it's subsidiary)

Definition at line 31 of file WebFeedGatewayPlugin.inc.php.

WebFeedGatewayPlugin::getManagementVerbs ( )

Get the management verbs for this plugin (override to none so that the parent plugin can handle this)

Returns
array

Definition at line 93 of file WebFeedGatewayPlugin.inc.php.

WebFeedGatewayPlugin::getName ( )

Get the name of this plugin. The name must be unique within its category.

Returns
String name of plugin

Definition at line 40 of file WebFeedGatewayPlugin.inc.php.

WebFeedGatewayPlugin::getPluginPath ( )

Override the builtin to get the correct plugin path.

Definition at line 64 of file WebFeedGatewayPlugin.inc.php.

References getWebFeedPlugin().

WebFeedGatewayPlugin::getTemplatePath ( )

Override the builtin to get the correct template path.

Returns
string

Definition at line 73 of file WebFeedGatewayPlugin.inc.php.

References getWebFeedPlugin().

Referenced by fetch().

& WebFeedGatewayPlugin::getWebFeedPlugin ( )

Get the web feed plugin

Returns
object

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

References PluginRegistry\getPlugin().

Referenced by fetch(), getEnabled(), getPluginPath(), and getTemplatePath().


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