RoleBlockPlugin Class Reference
[Plugins_blocks_role]

Class for role block plugin. More...

Inheritance diagram for RoleBlockPlugin:

List of all members.

Public Member Functions
	getBlockTemplateFilename ()
	getDescription ()
	getDisplayName ()
	getName ()
	getNewJournalPluginSettingsFile ()
	getSupportedContexts ()
	register ($category, $path)

---

Detailed Description

Class for role block plugin.

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

---

Member Function Documentation

RoleBlockPlugin.getBlockTemplateFilename

(

)

Override the block contents based on the current role being browsed.

Returns:

string

Reimplemented from BlockPlugin.

Definition at line 74 of file RoleBlockPlugin.inc.php.

References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getRequestedOp(), Request.getRequestedPage(), and Request.getUser().

RoleBlockPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from BlockPlugin.

Definition at line 57 of file RoleBlockPlugin.inc.php.

References Locale.translate().

RoleBlockPlugin.getDisplayName

(

)

Get the display name of this plugin.

Returns:

String

Reimplemented from BlockPlugin.

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

References Locale.translate().

RoleBlockPlugin.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 34 of file RoleBlockPlugin.inc.php.

RoleBlockPlugin.getNewJournalPluginSettingsFile

(

)

Install default settings on journal creation.

Returns:

string

Reimplemented from Plugin.

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

References Plugin.getPluginPath().

RoleBlockPlugin.getSupportedContexts

(

)

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

Returns:

array

Reimplemented from BlockPlugin.

Definition at line 65 of file RoleBlockPlugin.inc.php.

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

References Plugin.addLocaleData().

---

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

• plugins/blocks/role/RoleBlockPlugin.inc.php