CustomBlockPlugin Class Reference

Inheritance diagram for CustomBlockPlugin:

BlockPlugin Plugin List of all members.

Public Member Functions

 CustomBlockPlugin ($blockName)
 getBlockContext ()
 getContents (&$templateMgr)
 getDescription ()
 getDisplayName ()
 getEnabled ()
 getManagementVerbs ()
getManagerPlugin ()
 getName ()
 getPluginPath ()
 getSeq ()
 getSupportedContexts ()
 getTemplatePath ()
 manage ($verb, $args)

Public Attributes

 $blockName

Detailed Description

A generic sidebar block that can be customized through the CustomBlockManagerPlugin

Definition at line 17 of file CustomBlockPlugin.inc.php.


Member Function Documentation

CustomBlockPlugin.getBlockContext (  ) 

Get the block context. Overrides parent so that the plugin will be displayed during install.

Returns:
int

Reimplemented from BlockPlugin.

Definition at line 168 of file CustomBlockPlugin.inc.php.

CustomBlockPlugin.getContents ( &$  templateMgr  ) 

Get the contents of the Block

Parameters:
$templateMgr object
Returns:
string

Reimplemented from BlockPlugin.

Definition at line 154 of file CustomBlockPlugin.inc.php.

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

CustomBlockPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented from BlockPlugin.

Definition at line 210 of file CustomBlockPlugin.inc.php.

CustomBlockPlugin.getDisplayName (  ) 

Get the display name of this plugin.

Returns:
String

Reimplemented from BlockPlugin.

Definition at line 203 of file CustomBlockPlugin.inc.php.

Referenced by manage().

CustomBlockPlugin.getEnabled (  ) 

Determine whether the plugin is enabled. Overrides parent so that the plugin will be displayed during install.

Reimplemented from BlockPlugin.

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

Referenced by getManagementVerbs().

& CustomBlockPlugin.getManagerPlugin (  ) 

Get the management plugin

Returns:
object

Definition at line 29 of file CustomBlockPlugin.inc.php.

Referenced by getPluginPath(), and getTemplatePath().

CustomBlockPlugin.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 195 of file CustomBlockPlugin.inc.php.

Referenced by manage().

CustomBlockPlugin.getPluginPath (  ) 

Override the builtin to get the correct plugin path.

Returns:
string

Definition at line 37 of file CustomBlockPlugin.inc.php.

References getManagerPlugin().

CustomBlockPlugin.getSeq (  ) 

Determine the plugin sequence. Overrides parent so that the plugin will be displayed during install.

Reimplemented from BlockPlugin.

Definition at line 185 of file CustomBlockPlugin.inc.php.

CustomBlockPlugin.getSupportedContexts (  ) 

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

Returns:
array

Reimplemented from BlockPlugin.

Definition at line 177 of file CustomBlockPlugin.inc.php.

CustomBlockPlugin.getTemplatePath (  ) 

Override the builtin to get the correct template path.

Returns:
string

Reimplemented from Plugin.

Definition at line 46 of file CustomBlockPlugin.inc.php.

References getManagerPlugin().

CustomBlockPlugin.manage ( verb,
args 
)

Perform management functions

Definition at line 83 of file CustomBlockPlugin.inc.php.

References Request.getConference(), getDisplayName(), getName(), BlockPlugin.setEnabled(), and Request.url().


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