Abstract class for paymethod plugins. More...
Public Member Functions | |
| displayPaymentForm ($queuedPaymentId, $key, &$queuedPayment, $request) | |
| displayPaymentSettingsForm (&$params, &$smarty) | |
| getDescription () | |
| getName () | |
| getSettingsFormFieldNames () | |
| getTemplatePath () | |
| handle ($args, &$request) | |
| isConfigured () | |
| PaymethodPlugin () | |
Abstract class for paymethod plugins.
Definition at line 17 of file PaymethodPlugin.inc.php.
| PaymethodPlugin.displayPaymentForm | ( | $ | queuedPaymentId, | |
| $ | key, | |||
| &$ | queuedPayment, | |||
| $ | request | |||
| ) |
Display the payment form.
| $queuedPaymentId | int | |
| $key | string | |
| $queuedPayment | QueuedPayment | |
| $request | PKPRequest |
Definition at line 56 of file PaymethodPlugin.inc.php.
| PaymethodPlugin.displayPaymentSettingsForm | ( | &$ | params, | |
| &$ | smarty | |||
| ) |
Display the payment settings form.
| $params | array | |
| $smarty | Smarty |
Reimplemented in PayPalPlugin.
Definition at line 73 of file PaymethodPlugin.inc.php.
References getTemplatePath().
| PaymethodPlugin.getDescription | ( | ) |
Get a description of this plugin.
Reimplemented in ManualPaymentPlugin, and PayPalPlugin.
Definition at line 38 of file PaymethodPlugin.inc.php.
| PaymethodPlugin.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).
Reimplemented in ManualPaymentPlugin, and PayPalPlugin.
Definition at line 31 of file PaymethodPlugin.inc.php.
| PaymethodPlugin.getSettingsFormFieldNames | ( | ) |
Fetch the settings form field names.
Reimplemented in ManualPaymentPlugin, and PayPalPlugin.
Definition at line 81 of file PaymethodPlugin.inc.php.
| PaymethodPlugin.getTemplatePath | ( | ) |
Get the Template path for this plugin.
Definition at line 45 of file PaymethodPlugin.inc.php.
Referenced by PayPalPlugin.displayPaymentForm(), ManualPaymentPlugin.displayPaymentForm(), and displayPaymentSettingsForm().
| PaymethodPlugin.handle | ( | $ | args, | |
| &$ | request | |||
| ) |
Handle an incoming request from a user callback or an external payment processing system.
| $args | array | |
| $request | PKPRequest |
Reimplemented in ManualPaymentPlugin, and PayPalPlugin.
Definition at line 91 of file PaymethodPlugin.inc.php.
| PaymethodPlugin.isConfigured | ( | ) |
Determine whether or not the payment plugin is configured for use.
Reimplemented in ManualPaymentPlugin, and PayPalPlugin.
Definition at line 64 of file PaymethodPlugin.inc.php.
| PaymethodPlugin.PaymethodPlugin | ( | ) |
Constructor
Definition at line 21 of file PaymethodPlugin.inc.php.
References Plugin.Plugin().
Referenced by ManualPaymentPlugin.ManualPaymentPlugin(), and PayPalPlugin.PayPalPlugin().
1.7.1