AnnouncementFeedBlockPlugin Class Reference
[Plugins_generic_announcementFeed]
Class for block component of announcement feed plugin.
More...
Public Member Functions | |
| & | getAnnouncementFeedPlugin () |
| getContents (&$templateMgr) | |
| getDescription () | |
| getDisplayName () | |
| getName () | |
| getPluginPath () | |
| getSupportedContexts () | |
| getTemplatePath () | |
Detailed Description
Class for block component of announcement feed plugin.Definition at line 20 of file AnnouncementFeedBlockPlugin.inc.php.
Member Function Documentation
| & AnnouncementFeedBlockPlugin.getAnnouncementFeedPlugin | ( | ) |
Get the announcement feed plugin
- Returns:
- object
Definition at line 57 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:
-
$templateMgr object
- Returns:
- $string
Reimplemented from BlockPlugin.
Definition at line 85 of file AnnouncementFeedBlockPlugin.inc.php.
References getAnnouncementFeedPlugin(), Request.getJournal(), and Request.getRequestedPage().
| AnnouncementFeedBlockPlugin.getDescription | ( | ) |
Get a description of the plugin.
Reimplemented from BlockPlugin.
Definition at line 41 of file AnnouncementFeedBlockPlugin.inc.php.
References Locale.translate().
| AnnouncementFeedBlockPlugin.getDisplayName | ( | ) |
Get the display name of this plugin.
- Returns:
- String
Reimplemented from BlockPlugin.
Definition at line 34 of file AnnouncementFeedBlockPlugin.inc.php.
References Locale.translate().
| 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 26 of file AnnouncementFeedBlockPlugin.inc.php.
| AnnouncementFeedBlockPlugin.getPluginPath | ( | ) |
Override the builtin to get the correct plugin path.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 66 of file AnnouncementFeedBlockPlugin.inc.php.
References getAnnouncementFeedPlugin().
| AnnouncementFeedBlockPlugin.getSupportedContexts | ( | ) |
Get the supported contexts (e.g. BLOCK_CONTEXT_...) for this block.
- Returns:
- array
Reimplemented from BlockPlugin.
Definition at line 49 of file AnnouncementFeedBlockPlugin.inc.php.
| AnnouncementFeedBlockPlugin.getTemplatePath | ( | ) |
Override the builtin to get the correct template path.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 75 of file AnnouncementFeedBlockPlugin.inc.php.
References getAnnouncementFeedPlugin().
The documentation for this class was generated from the following file:
- plugins/generic/announcementFeed/AnnouncementFeedBlockPlugin.inc.php
