HelpBlockPlugin Class Reference

Inheritance diagram for HelpBlockPlugin:

BlockPlugin Plugin List of all members.

Public Member Functions

 getBlockContext ()
 getDescription ()
 getDisplayName ()
 getEnabled ()
 getInstallSitePluginSettingsFile ()
 getName ()
 getNewConferencePluginSettingsFile ()
 getSeq ()
 getSupportedContexts ()
 register ($category, $path)

Detailed Description

Definition at line 19 of file HelpBlockPlugin.inc.php.


Member Function Documentation

HelpBlockPlugin.getBlockContext (  ) 

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

Returns:
int

Reimplemented from BlockPlugin.

Definition at line 58 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented from BlockPlugin.

Definition at line 100 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin.getDisplayName (  ) 

Get the display name of this plugin.

Returns:
String

Reimplemented from BlockPlugin.

Definition at line 93 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin.getEnabled (  ) 

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

Reimplemented from BlockPlugin.

Definition at line 32 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin.getInstallSitePluginSettingsFile (  ) 

Install default settings on system install.

Returns:
string

Definition at line 41 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin.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 85 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin.getNewConferencePluginSettingsFile (  ) 

Install default settings on conference creation.

Returns:
string

Reimplemented from Plugin.

Definition at line 49 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin.getSeq (  ) 

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

Reimplemented from BlockPlugin.

Definition at line 75 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin.getSupportedContexts (  ) 

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

Returns:
array

Reimplemented from BlockPlugin.

Definition at line 67 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin.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 BlockPlugin.

Definition at line 20 of file HelpBlockPlugin.inc.php.


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