Open Journal Systems  3.3.0
WebFeedPlugin Class Reference
Inheritance diagram for WebFeedPlugin:
GenericPlugin LazyLoadPlugin Plugin

Public Member Functions

 callbackAddLinks ($hookName, $args)
 
 getActions ($request, $verb)
 
 getContextSpecificPluginSettingsFile ()
 
 getDescription ()
 
 getDisplayName ()
 
 manage ($args, $request)
 
 register ($category, $path, $mainContextId=null)
 
- Public Member Functions inherited from LazyLoadPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 getEnabled ($contextId=null)
 
 getName ()
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getCurrentVersion ()
 
 getDirName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getTemplatePath ($inCore=false)
 
 getTemplateResource ($template=null, $inCore=false)
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installControlledVocabs ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 smartyPluginUrl ($params, $smarty)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 
- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 

Detailed Description

Web Feeds plugin class.

Definition at line 18 of file WebFeedPlugin.inc.php.

Member Function Documentation

◆ callbackAddLinks()

WebFeedPlugin::callbackAddLinks (   $hookName,
  $args 
)

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

Definition at line 63 of file WebFeedPlugin.inc.php.

References Plugin\$request, PKPApplication\get(), DAORegistry\getDAO(), and Plugin\getSetting().

◆ getActions()

WebFeedPlugin::getActions (   $request,
  $verb 
)

Get a list of link actions for plugin management.

Parameters
requestPKPRequest
$actionArgsarray The list of action args to be included in request URLs.
Returns
array List of LinkActions

Reimplemented from Plugin.

Definition at line 118 of file WebFeedPlugin.inc.php.

References Plugin\$request, getDisplayName(), Plugin\getEnabled(), and LazyLoadPlugin\getName().

◆ getContextSpecificPluginSettingsFile()

WebFeedPlugin::getContextSpecificPluginSettingsFile ( )

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

Returns
string

Reimplemented from Plugin.

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

References Plugin\getPluginPath().

◆ getDescription()

WebFeedPlugin::getDescription ( )

Get the description of this plugin

Returns
string

Reimplemented from Plugin.

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

◆ getDisplayName()

WebFeedPlugin::getDisplayName ( )

Get the display name of this plugin

Returns
string

Reimplemented from Plugin.

Definition at line 23 of file WebFeedPlugin.inc.php.

Referenced by getActions().

◆ manage()

WebFeedPlugin::manage (   $args,
  $request 
)

Perform a management function.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage A JSON-encoded response

Reimplemented from Plugin.

Definition at line 140 of file WebFeedPlugin.inc.php.

References Plugin\$request, and AppLocale\requireComponents().

◆ register()

WebFeedPlugin::register (   $category,
  $path,
  $mainContextId = null 
)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters
$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
$mainContextIdinteger To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.
Returns
boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from LazyLoadPlugin.

Definition at line 38 of file WebFeedPlugin.inc.php.

References Plugin\getEnabled(), Plugin\getPluginPath(), PluginRegistry\register(), and HookRegistry\register().


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