BlockPlugin Class Reference
[Plugins]

Abstract class for block plugins. More...

Inheritance diagram for BlockPlugin:

List of all members.

Public Member Functions
	getBlockContext ()
	getBlockTemplateFilename ()
	getContents (&$templateMgr)
&	getContextMap ()
	getDescription ()
	getDisplayName ()
	getEnabled ()
	getName ()
	getSeq ()
	getSupportedContexts ()
	register ($category, $path)
	setBlockContext ($context)
	setEnabled ($enabled)
	setSeq ($i)

---

Detailed Description

Abstract class for block plugins.

Definition at line 22 of file BlockPlugin.inc.php.

---

Member Function Documentation

BlockPlugin.getBlockContext

(

)

Get the block context (e.g. BLOCK_CONTEXT_...) for this block.

Returns:

int

Reimplemented in DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, and LanguageToggleBlockPlugin.

Definition at line 40 of file BlockPlugin.inc.php.

References Request.getJournal().

Referenced by register().

BlockPlugin.getBlockTemplateFilename

(

)

Get the filename of the template block. (Default behavior may be overridden through some combination of this function and the getContents function.) Returning null from this function results in an empty display.

Returns:

string

Reimplemented in RoleBlockPlugin.

Definition at line 154 of file BlockPlugin.inc.php.

Referenced by getContents().

BlockPlugin.getContents

(

&$

templateMgr

)

Get the HTML contents for this block.

Parameters:

$templateMgr

object

Returns:

string

Reimplemented in DonationBlockPlugin, FontSizeBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, SubscriptionBlockPlugin, UserBlockPlugin, AnnouncementFeedBlockPlugin, CmsBlockPlugin, OpenAdsBlockPlugin, ThesisFeedBlockPlugin, and WebFeedBlockPlugin.

Definition at line 163 of file BlockPlugin.inc.php.

References getBlockTemplateFilename().

& BlockPlugin.getContextMap

(

)

Get an associative array linking block context to hook name.

Returns:

array

Definition at line 110 of file BlockPlugin.inc.php.

References HookRegistry.call().

Referenced by register().

BlockPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from Plugin.

Reimplemented in DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, RoleBlockPlugin, SubscriptionBlockPlugin, UserBlockPlugin, AnnouncementFeedBlockPlugin, CmsBlockPlugin, OpenAdsBlockPlugin, ThesisFeedBlockPlugin, and WebFeedBlockPlugin.

Definition at line 143 of file BlockPlugin.inc.php.

BlockPlugin.getDisplayName

(

)

Get the display name of this plugin.

Returns:

String

Reimplemented from Plugin.

Reimplemented in DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, RoleBlockPlugin, SubscriptionBlockPlugin, UserBlockPlugin, AnnouncementFeedBlockPlugin, CmsBlockPlugin, OpenAdsBlockPlugin, ThesisFeedBlockPlugin, and WebFeedBlockPlugin.

Definition at line 134 of file BlockPlugin.inc.php.

BlockPlugin.getEnabled

(

)

Determine whether or not this plugin is currently enabled.

Returns:

boolean

Reimplemented in DevelopedByBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, LanguageToggleBlockPlugin, CmsBlockPlugin, and OpenAdsBlockPlugin.

Definition at line 68 of file BlockPlugin.inc.php.

References Request.getJournal().

Referenced by ThesisFeedBlockPlugin.getContents(), and register().

BlockPlugin.getName

(

)

Get the name of this plugin. The name must be unique within its category.

Returns:

String name of plugin

Reimplemented from Plugin.

Reimplemented in DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, RoleBlockPlugin, SubscriptionBlockPlugin, UserBlockPlugin, AnnouncementFeedBlockPlugin, CmsBlockPlugin, OpenAdsBlockPlugin, ThesisFeedBlockPlugin, and WebFeedBlockPlugin.

Definition at line 125 of file BlockPlugin.inc.php.

BlockPlugin.getSeq

(

)

Get the sequence information for this plugin. Higher numbers move plugins down the page compared to other blocks.

Returns:

int

Reimplemented from Plugin.

Reimplemented in DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, and LanguageToggleBlockPlugin.

Definition at line 89 of file BlockPlugin.inc.php.

References Request.getJournal().

BlockPlugin.getSupportedContexts

(

)

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

Returns:

array

Reimplemented in DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, RoleBlockPlugin, SubscriptionBlockPlugin, UserBlockPlugin, AnnouncementFeedBlockPlugin, CmsBlockPlugin, OpenAdsBlockPlugin, ThesisFeedBlockPlugin, and WebFeedBlockPlugin.

Definition at line 60 of file BlockPlugin.inc.php.

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

Reimplemented in DevelopedByBlockPlugin, DonationBlockPlugin, FontSizeBlockPlugin, HelpBlockPlugin, InformationBlockPlugin, LanguageToggleBlockPlugin, NavigationBlockPlugin, RoleBlockPlugin, SubscriptionBlockPlugin, and UserBlockPlugin.

Definition at line 23 of file BlockPlugin.inc.php.

References getBlockContext(), getContextMap(), getEnabled(), and HookRegistry.register().

BlockPlugin.setBlockContext

(

$

context

)

Set the block context (e.g. BLOCK_CONTEXT_...) for this block.

Parameters:

context

int

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

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

BlockPlugin.setEnabled

(

$

enabled

)

Set whether or not this plugin is currently enabled.

Parameters:

$enabled

boolean

Definition at line 78 of file BlockPlugin.inc.php.

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

BlockPlugin.setSeq

(

$

i

)

Set the sequence information for this plugin. Higher numbers move plugins down the page compared to other blocks.

Parameters:

i

int

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

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

---

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

• classes/plugins/BlockPlugin.inc.php