BlockPlugin Class Reference
[Plugins]

Abstract class for block plugins. More...

Inheritance diagram for BlockPlugin:

Plugin AnnouncementFeedBlockPlugin CustomBlockPlugin DevelopedByBlockPlugin FontSizeBlockPlugin HelpBlockPlugin InformationBlockPlugin LanguageToggleBlockPlugin NavigationBlockPlugin NotificationBlockPlugin RoleBlockPlugin UserBlockPlugin List of all members.

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)

Detailed Description

Abstract class for block plugins.

Definition at line 21 of file BlockPlugin.inc.php.


Member Function Documentation

BlockPlugin.getBlockContext (  ) 

Get the block context (e.g. BLOCK_CONTEXT_...) for this block.

Returns:
int

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.

Returns:
string

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.

Parameters:
$templateMgr object
Returns:
string

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.

Returns:
array

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.

Returns:
String

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.

Returns:
boolean

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.

Returns:
String name of plugin

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.

Returns:
int

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.

Returns:
array

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.

Parameters:
$category String Name of category plugin was registered to
$path String The path the plugin was found in
Returns:
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

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.

Parameters:
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.

Parameters:
$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.

Parameters:
i int

Definition at line 103 of file BlockPlugin.inc.php.

References Request.getConference(), and Plugin.updateSetting().


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