UserBlockPlugin Class Reference
[Plugins_blocks_user]

Class for user block plugin. More...

Inheritance diagram for UserBlockPlugin:

List of all members.

Public Member Functions
	getContents (&$templateMgr)
	getDescription ()
	getDisplayName ()
	getInstallSitePluginSettingsFile ()
	getName ()
	getNewJournalPluginSettingsFile ()
	getSupportedContexts ()
	register ($category, $path)

---

Detailed Description

Class for user block plugin.

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

---

Member Function Documentation

UserBlockPlugin.getContents

(

&$

templateMgr

)

Get the HTML contents for this block.

Parameters:

$templateMgr

object

Returns:

string

Reimplemented from BlockPlugin.

Definition at line 77 of file UserBlockPlugin.inc.php.

References Request.getSession().

UserBlockPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from BlockPlugin.

Definition at line 73 of file UserBlockPlugin.inc.php.

References Locale.translate().

UserBlockPlugin.getDisplayName

(

)

Get the display name of this plugin.

Returns:

String

Reimplemented from BlockPlugin.

Definition at line 66 of file UserBlockPlugin.inc.php.

References Locale.translate().

UserBlockPlugin.getInstallSitePluginSettingsFile

(

)

Install default settings on system install.

Returns:

string

Reimplemented from Plugin.

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

References Plugin.getPluginPath().

UserBlockPlugin.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 42 of file UserBlockPlugin.inc.php.

UserBlockPlugin.getNewJournalPluginSettingsFile

(

)

Install default settings on journal creation.

Returns:

string

Reimplemented from Plugin.

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

References Plugin.getPluginPath().

UserBlockPlugin.getSupportedContexts

(

)

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

Returns:

array

Reimplemented from BlockPlugin.

Definition at line 33 of file UserBlockPlugin.inc.php.

UserBlockPlugin.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 UserBlockPlugin.inc.php.

References Plugin.addLocaleData().

---

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

• plugins/blocks/user/UserBlockPlugin.inc.php