CustomBlockManagerPlugin Class Reference

Inheritance diagram for CustomBlockManagerPlugin:

GenericPlugin Plugin List of all members.

Public Member Functions

 callbackLoadCategory ($hookName, $args)
 getDescription ()
 getDisplayName ()
 getEnabled ()
 getManagementVerbs ()
 getName ()
 manage ($verb, $args)
 register ($category, $path)
 setEnabled ($enabled)

Detailed Description

Plugin to let users add and delete sidebar blocks

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


Member Function Documentation

CustomBlockManagerPlugin.callbackLoadCategory ( hookName,
args 
)

Register as a block plugin, even though this is a generic plugin. This will allow the plugin to behave as a block plugin, i.e. to have layout tasks performed on it.

Parameters:
$hookName string
$args array

Definition at line 50 of file CustomBlockManagerPlugin.inc.php.

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

Referenced by register().

CustomBlockManagerPlugin.getEnabled (  ) 

Determine whether or not this plugin is enabled.

Definition at line 87 of file CustomBlockManagerPlugin.inc.php.

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

Referenced by callbackLoadCategory(), getManagementVerbs(), and register().

CustomBlockManagerPlugin.getManagementVerbs (  ) 

Display verbs for the management interface.

Definition at line 105 of file CustomBlockManagerPlugin.inc.php.

References getEnabled().

CustomBlockManagerPlugin.manage ( verb,
args 
)

Perform management functions

Definition at line 128 of file CustomBlockManagerPlugin.inc.php.

References Request.getConference(), setEnabled(), and Request.url().

CustomBlockManagerPlugin.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.

Definition at line 31 of file CustomBlockManagerPlugin.inc.php.

References callbackLoadCategory(), and getEnabled().

CustomBlockManagerPlugin.setEnabled ( enabled  ) 

Set the enabled/disabled state of this plugin

Definition at line 96 of file CustomBlockManagerPlugin.inc.php.

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

Referenced by manage().


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