AnnouncementFeedBlockPlugin Class Reference

Inheritance diagram for AnnouncementFeedBlockPlugin:

BlockPlugin Plugin List of all members.

Public Member Functions

getAnnouncementFeedPlugin ()
 getContents (&$templateMgr)
 getDescription ()
 getDisplayName ()
 getHideManagement ()
 getInstallSitePluginSettingsFile ()
 getName ()
 getPluginPath ()
 getSupportedContexts ()
 getTemplatePath ()

Detailed Description

Class for block component of announcement feed plugin

$Id$

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


Member Function Documentation

& AnnouncementFeedBlockPlugin.getAnnouncementFeedPlugin (  ) 

Get the announcement feed plugin

Returns:
object

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

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

AnnouncementFeedBlockPlugin.getContents ( &$  templateMgr  ) 

Get the HTML contents for this block.

Parameters:
$templateMgr object
Returns:
$string

Reimplemented from BlockPlugin.

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

References getAnnouncementFeedPlugin(), Request.getConference(), and Plugin.getSetting().

AnnouncementFeedBlockPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented from BlockPlugin.

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

AnnouncementFeedBlockPlugin.getDisplayName (  ) 

Get the display name of this plugin.

Returns:
String

Reimplemented from BlockPlugin.

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

AnnouncementFeedBlockPlugin.getHideManagement (  ) 

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

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

AnnouncementFeedBlockPlugin.getInstallSitePluginSettingsFile (  ) 

Install default settings on system install.

Returns:
string

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

References getPluginPath().

AnnouncementFeedBlockPlugin.getName (  ) 

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

Returns:
String name of plugin

Reimplemented from BlockPlugin.

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

AnnouncementFeedBlockPlugin.getPluginPath (  ) 

Override the builtin to get the correct plugin path.

Returns:
string

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

References getAnnouncementFeedPlugin().

Referenced by getInstallSitePluginSettingsFile().

AnnouncementFeedBlockPlugin.getSupportedContexts (  ) 

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

Returns:
array

Reimplemented from BlockPlugin.

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

AnnouncementFeedBlockPlugin.getTemplatePath (  ) 

Override the builtin to get the correct template path.

Returns:
string

Reimplemented from Plugin.

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

References getAnnouncementFeedPlugin().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7