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

Public Member Functions

getAnnouncementFeedPlugin ()
 
 getContents (&$templateMgr)
 
 getDescription ()
 
 getDisplayName ()
 
 getHideManagement ()
 
 getName ()
 
 getPluginPath ()
 
 getTemplatePath ()
 
- 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 announcement feed plugin.

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

Member Function Documentation

& AnnouncementFeedBlockPlugin::getAnnouncementFeedPlugin ( )

Get the announcement feed plugin

Returns
object

Definition at line 59 of file AnnouncementFeedBlockPlugin.inc.php.

References PluginRegistry\getPlugin().

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

AnnouncementFeedBlockPlugin::getContents ( $templateMgr)

Get the HTML contents for this block.

Parameters
$templateMgrobject
Returns
$string

Definition at line 87 of file AnnouncementFeedBlockPlugin.inc.php.

References getAnnouncementFeedPlugin(), Request\getJournal(), and PKPRequest\getRequestedPage().

AnnouncementFeedBlockPlugin::getDescription ( )

Get a description of the plugin.

Definition at line 51 of file AnnouncementFeedBlockPlugin.inc.php.

AnnouncementFeedBlockPlugin::getDisplayName ( )

Get the display name of this plugin.

Returns
String

Definition at line 44 of file AnnouncementFeedBlockPlugin.inc.php.

AnnouncementFeedBlockPlugin::getHideManagement ( )

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

Definition at line 27 of file AnnouncementFeedBlockPlugin.inc.php.

AnnouncementFeedBlockPlugin::getName ( )

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

Returns
String name of plugin

Definition at line 36 of file AnnouncementFeedBlockPlugin.inc.php.

AnnouncementFeedBlockPlugin::getPluginPath ( )

Override the builtin to get the correct plugin path.

Returns
string

Definition at line 68 of file AnnouncementFeedBlockPlugin.inc.php.

References getAnnouncementFeedPlugin().

AnnouncementFeedBlockPlugin::getTemplatePath ( )

Override the builtin to get the correct template path.

Returns
string

Definition at line 77 of file AnnouncementFeedBlockPlugin.inc.php.

References getAnnouncementFeedPlugin().


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