HelpBlockPlugin Class Reference
[Plugins_blocks_help]

Class for help block plugin. More...

Inheritance diagram for HelpBlockPlugin:

List of all members.

Public Member Functions
	getBlockContext ()
	getDescription ()
	getDisplayName ()
	getEnabled ()
	getInstallSitePluginSettingsFile ()
	getName ()
	getNewJournalPluginSettingsFile ()
	getSeq ()
	getSupportedContexts ()
	register ($category, $path)

---

Detailed Description

Class for help block plugin.

Definition at line 20 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 59 of file HelpBlockPlugin.inc.php.

References Config.getVar().

HelpBlockPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from BlockPlugin.

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

References Locale.translate().

HelpBlockPlugin.getDisplayName

(

)

Get the display name of this plugin.

Returns:

String

Reimplemented from BlockPlugin.

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

References Locale.translate().

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

References Config.getVar().

HelpBlockPlugin.getInstallSitePluginSettingsFile

(

)

Install default settings on system install.

Returns:

string

Reimplemented from Plugin.

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

References Plugin.getPluginPath().

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

HelpBlockPlugin.getNewJournalPluginSettingsFile

(

)

Install default settings on journal creation.

Returns:

string

Reimplemented from Plugin.

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

References Plugin.getPluginPath().

HelpBlockPlugin.getSeq

(

)

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

Reimplemented from BlockPlugin.

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

References Config.getVar().

HelpBlockPlugin.getSupportedContexts

(

)

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

Returns:

array

Reimplemented from BlockPlugin.

Definition at line 68 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 21 of file HelpBlockPlugin.inc.php.

References Plugin.addLocaleData().

---

The documentation for this class was generated from the following file:

• plugins/blocks/help/HelpBlockPlugin.inc.php