Inheritance diagram for BlockPlugin:
Public Member Functions | |
BlockPlugin () | |
callback ($hookName, $args) | |
getBlockContext () | |
getBlockTemplateFilename () | |
getContents (&$templateMgr) | |
& | getContextMap () |
getDescription () | |
getDisplayName () | |
getEnabled () | |
getName () | |
getSeq () | |
getSupportedContexts () | |
register ($category, $path) | |
setBlockContext ($context) | |
setEnabled ($enabled) | |
setSeq ($i) |
Definition at line 21 of file BlockPlugin.inc.php.
BlockPlugin.getBlockContext | ( | ) |
Get the block context (e.g. BLOCK_CONTEXT_...) for this block.
Reimplemented in DevelopedByBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, LanguageToggleBlockPlugin, and CustomBlockPlugin.
Definition at line 43 of file BlockPlugin.inc.php.
References Request.getConference(), and Plugin.getSetting().
Referenced by register().
BlockPlugin.getBlockTemplateFilename | ( | ) |
Get the filename of the template block. (Default behavior may be overridden through some combination of this function and the getContents function.) Returning null from this function results in an empty display.
Reimplemented in RoleBlockPlugin.
Definition at line 157 of file BlockPlugin.inc.php.
Referenced by getContents().
BlockPlugin.getContents | ( | &$ | templateMgr | ) |
Get the HTML contents for this block.
$templateMgr | object |
Reimplemented in FontSizeBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, NotificationBlockPlugin, UserBlockPlugin, AnnouncementFeedBlockPlugin, and CustomBlockPlugin.
Definition at line 166 of file BlockPlugin.inc.php.
References getBlockTemplateFilename(), and Plugin.getTemplatePath().
Referenced by callback().
& BlockPlugin.getContextMap | ( | ) |
Get an associative array linking block context to hook name.
Definition at line 113 of file BlockPlugin.inc.php.
Referenced by register().
BlockPlugin.getDescription | ( | ) |
Get a description of the plugin.
Reimplemented in DevelopedByBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, NotificationBlockPlugin, RoleBlockPlugin, UserBlockPlugin, AnnouncementFeedBlockPlugin, and CustomBlockPlugin.
Definition at line 146 of file BlockPlugin.inc.php.
BlockPlugin.getDisplayName | ( | ) |
Get the display name of this plugin.
Reimplemented in DevelopedByBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, NotificationBlockPlugin, RoleBlockPlugin, UserBlockPlugin, AnnouncementFeedBlockPlugin, and CustomBlockPlugin.
Definition at line 137 of file BlockPlugin.inc.php.
BlockPlugin.getEnabled | ( | ) |
Determine whether or not this plugin is currently enabled.
Reimplemented in DevelopedByBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, LanguageToggleBlockPlugin, NotificationBlockPlugin, and CustomBlockPlugin.
Definition at line 71 of file BlockPlugin.inc.php.
References Request.getConference(), and Plugin.getSetting().
Referenced by register().
BlockPlugin.getName | ( | ) |
Get the name of this plugin. The name must be unique within its category.
Reimplemented in DevelopedByBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, NotificationBlockPlugin, RoleBlockPlugin, UserBlockPlugin, AnnouncementFeedBlockPlugin, and CustomBlockPlugin.
Definition at line 128 of file BlockPlugin.inc.php.
BlockPlugin.getSeq | ( | ) |
Get the sequence information for this plugin. Higher numbers move plugins down the page compared to other blocks.
Reimplemented in DevelopedByBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, LanguageToggleBlockPlugin, and CustomBlockPlugin.
Definition at line 92 of file BlockPlugin.inc.php.
References Request.getConference(), and Plugin.getSetting().
BlockPlugin.getSupportedContexts | ( | ) |
Get the supported contexts (e.g. BLOCK_CONTEXT_...) for this block.
Reimplemented in DevelopedByBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, NotificationBlockPlugin, RoleBlockPlugin, UserBlockPlugin, AnnouncementFeedBlockPlugin, and CustomBlockPlugin.
Definition at line 63 of file BlockPlugin.inc.php.
BlockPlugin.register | ( | $ | category, | |
$ | path | |||
) |
Called as a plugin is registered to the registry. Subclasses over- riding this method should call the parent method first.
$category | String Name of category plugin was registered to | |
$path | String The path the plugin was found in |
Reimplemented from Plugin.
Reimplemented in DevelopedByBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, NotificationBlockPlugin, RoleBlockPlugin, and UserBlockPlugin.
Definition at line 26 of file BlockPlugin.inc.php.
References callback(), getBlockContext(), getContextMap(), and getEnabled().
BlockPlugin.setBlockContext | ( | $ | context | ) |
Set the block context (e.g. BLOCK_CONTEXT_...) for this block.
context | int |
Definition at line 53 of file BlockPlugin.inc.php.
References Request.getConference(), and Plugin.updateSetting().
BlockPlugin.setEnabled | ( | $ | enabled | ) |
Set whether or not this plugin is currently enabled.
$enabled | boolean |
Definition at line 81 of file BlockPlugin.inc.php.
References Request.getConference(), and Plugin.updateSetting().
Referenced by CustomBlockPlugin.manage().
BlockPlugin.setSeq | ( | $ | i | ) |
Set the sequence information for this plugin. Higher numbers move plugins down the page compared to other blocks.
i | int |
Definition at line 103 of file BlockPlugin.inc.php.
References Request.getConference(), and Plugin.updateSetting().