DonationBlockPlugin Class Reference
[Plugins_blocks_user]

Class for user block plugin. More...

Inheritance diagram for DonationBlockPlugin:

List of all members.

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

---

Detailed Description

Class for user block plugin.

Definition at line 18 of file DonationBlockPlugin.inc.php.

---

Member Function Documentation

DonationBlockPlugin.getBlockContext

(

)

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

Returns:

int

Reimplemented from BlockPlugin.

Definition at line 48 of file DonationBlockPlugin.inc.php.

References Config.getVar().

DonationBlockPlugin.getContents

(

&$

templateMgr

)

Get the HTML contents for this block.

Parameters:

$templateMgr

object

Returns:

string

Reimplemented from BlockPlugin.

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

References Request.getJournal(), and OJSPaymentManager.getManager().

DonationBlockPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from BlockPlugin.

Definition at line 90 of file DonationBlockPlugin.inc.php.

References Locale.translate().

DonationBlockPlugin.getDisplayName

(

)

Get the display name of this plugin.

Returns:

String

Reimplemented from BlockPlugin.

Definition at line 83 of file DonationBlockPlugin.inc.php.

References Locale.translate().

DonationBlockPlugin.getInstallSitePluginSettingsFile

(

)

Install default settings on system install.

Returns:

string

Reimplemented from Plugin.

Definition at line 31 of file DonationBlockPlugin.inc.php.

References Plugin.getPluginPath().

DonationBlockPlugin.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 75 of file DonationBlockPlugin.inc.php.

DonationBlockPlugin.getNewJournalPluginSettingsFile

(

)

Install default settings on journal creation.

Returns:

string

Reimplemented from Plugin.

Definition at line 39 of file DonationBlockPlugin.inc.php.

References Plugin.getPluginPath().

DonationBlockPlugin.getSeq

(

)

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

Reimplemented from BlockPlugin.

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

References Config.getVar().

DonationBlockPlugin.getSupportedContexts

(

)

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

Returns:

array

Reimplemented from BlockPlugin.

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

DonationBlockPlugin.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 19 of file DonationBlockPlugin.inc.php.

References Plugin.addLocaleData().

---

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

• plugins/blocks/donation/DonationBlockPlugin.inc.php