ManualPaymentPlugin Class Reference
[Plugins]

Manual payment plugin class. More...

Inheritance diagram for ManualPaymentPlugin:

List of all members.

Public Member Functions
	getDescription ()
	getDisplayName ()
	getInstallDataFile ()
	getName ()
	register ($category, $path)

---

Detailed Description

Manual payment plugin class.

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

---

Member Function Documentation

ManualPaymentPlugin.getDescription

(

)

Get a description of this plugin.

Reimplemented from PaymethodPlugin.

Definition at line 28 of file ManualPaymentPlugin.inc.php.

References Locale.translate().

ManualPaymentPlugin.getDisplayName

(

)

Get the display name for this plugin.

Returns:

string

Reimplemented from Plugin.

Definition at line 24 of file ManualPaymentPlugin.inc.php.

References Locale.translate().

ManualPaymentPlugin.getInstallDataFile

(

)

Get the filename of the install data for this plugin. Subclasses using SQL tables should override this.

Returns:

string

Reimplemented from Plugin.

Definition at line 93 of file ManualPaymentPlugin.inc.php.

References Plugin.getPluginPath().

ManualPaymentPlugin.getName

(

)

Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns:

String name of plugin

Reimplemented from PaymethodPlugin.

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

ManualPaymentPlugin.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 PaymethodPlugin.

Definition at line 32 of file ManualPaymentPlugin.inc.php.

References Plugin.addLocaleData().

---

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

• plugins/paymethod/manual/ManualPaymentPlugin.inc.php