Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
WebFeedBlockPlugin Class Reference
Inheritance diagram for WebFeedBlockPlugin:
BlockPlugin

Public Member Functions

 getContents (&$templateMgr)
 
 getDescription ()
 
 getDisplayName ()
 
 getHideManagement ()
 
 getName ()
 
 getPluginPath ()
 
 getSupportedContexts ()
 
 getTemplatePath ()
 
getWebFeedPlugin ()
 
- Public Member Functions inherited from BlockPlugin
 _getContextSpecificHomepageHook ()
 
 BlockPlugin ()
 
 callback ($hookName, $args)
 
 getBlockContext ()
 
 getBlockTemplateFilename ()
 
 getContents (&$templateMgr, $request=null)
 
getContextMap ()
 
 getSeq ()
 
 getSupportedContexts ()
 
 register ($category, $path)
 
 setBlockContext ($context)
 
 setSeq ($seq)
 
- 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

Class for block component of web feed plugin.

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

Member Function Documentation

WebFeedBlockPlugin::getContents ( $templateMgr)

Get the HTML contents for this block.

Parameters
$templateMgrobject
Returns
$string

Definition at line 98 of file WebFeedBlockPlugin.inc.php.

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

WebFeedBlockPlugin::getDescription ( )

Get a description of the plugin.

Definition at line 54 of file WebFeedBlockPlugin.inc.php.

WebFeedBlockPlugin::getDisplayName ( )

Get the display name of this plugin.

Returns
String

Definition at line 47 of file WebFeedBlockPlugin.inc.php.

WebFeedBlockPlugin::getHideManagement ( )

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

Definition at line 39 of file WebFeedBlockPlugin.inc.php.

WebFeedBlockPlugin::getName ( )

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

Returns
String name of plugin

Definition at line 32 of file WebFeedBlockPlugin.inc.php.

WebFeedBlockPlugin::getPluginPath ( )

Override the builtin to get the correct plugin path.

Returns
string

Definition at line 79 of file WebFeedBlockPlugin.inc.php.

References getWebFeedPlugin().

WebFeedBlockPlugin::getSupportedContexts ( )

Get the supported contexts (e.g. BLOCK_CONTEXT_...) for this block.

Returns
array

Definition at line 62 of file WebFeedBlockPlugin.inc.php.

WebFeedBlockPlugin::getTemplatePath ( )

Override the builtin to get the correct template path.

Returns
string

Definition at line 88 of file WebFeedBlockPlugin.inc.php.

References getWebFeedPlugin().

& WebFeedBlockPlugin::getWebFeedPlugin ( )

Get the web feed plugin

Returns
object

Definition at line 70 of file WebFeedBlockPlugin.inc.php.

References PluginRegistry\getPlugin().

Referenced by getContents(), getPluginPath(), and getTemplatePath().


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