Open Journal Systems  3.3.0
AnnouncementFeedBlockPlugin Class Reference
Inheritance diagram for AnnouncementFeedBlockPlugin:
BlockPlugin LazyLoadPlugin Plugin

Public Member Functions

 __construct ($parentPlugin)
 
 getContents ($templateMgr, $request=null)
 
 getDescription ()
 
 getDisplayName ()
 
 getHideManagement ()
 
 getName ()
 
 getPluginPath ()
 
- Public Member Functions inherited from BlockPlugin
 getBlockTemplateFilename ()
 
 getEnabled ($contextId=null)
 
 setEnabled ($enabled, $contextId=null)
 
- Public Member Functions inherited from LazyLoadPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 register ($category, $path, $mainContextId=null)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getActions ($request, $actionArgs)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDirName ()
 
 getEnabled ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
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 ()
 
 manage ($args, $request)
 
 smartyPluginUrl ($params, $smarty)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Protected Attributes

 $_parentPlugin
 

Additional Inherited Members

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

Detailed Description

Class for block component of announcement feed plugin.

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

Constructor & Destructor Documentation

◆ __construct()

AnnouncementFeedBlockPlugin::__construct (   $parentPlugin)

Constructor

Parameters
$parentPluginAnnouncementFeedPlugin

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

Member Function Documentation

◆ getContents()

AnnouncementFeedBlockPlugin::getContents (   $templateMgr,
  $request = null 
)
See also
BlockPlugin::getContents

Reimplemented from BlockPlugin.

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

References Plugin\$request.

◆ getDescription()

AnnouncementFeedBlockPlugin::getDescription ( )

Get a description of the plugin.

Reimplemented from Plugin.

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

◆ getDisplayName()

AnnouncementFeedBlockPlugin::getDisplayName ( )

Get the display name of this plugin.

Returns
String

Reimplemented from Plugin.

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

◆ getHideManagement()

AnnouncementFeedBlockPlugin::getHideManagement ( )

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

Reimplemented from Plugin.

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

◆ getName()

AnnouncementFeedBlockPlugin::getName ( )

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

Returns
String name of plugin

Reimplemented from LazyLoadPlugin.

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

◆ getPluginPath()

AnnouncementFeedBlockPlugin::getPluginPath ( )

Override the builtin to get the correct plugin path.

Returns
string

Reimplemented from Plugin.

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

Field Documentation

◆ $_parentPlugin

AnnouncementFeedBlockPlugin::$_parentPlugin
protected

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


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