Abstract class for paymethod plugins. More...
Public Member Functions | |
| _smartyDisplayPaymentSettingsForm ($hookName, $args) | |
| getDescription () | |
| getName () | |
| getTemplatePath () | |
| handle ($args) | |
| PaymethodPlugin () | |
| register ($category, $path) | |
Detailed Description
Abstract class for paymethod plugins.
Definition at line 18 of file PaymethodPlugin.inc.php.
Member Function Documentation
| PaymethodPlugin._smartyDisplayPaymentSettingsForm | ( | $ | hookName, | |
| $ | args | |||
| ) |
This is a hook wrapper that is responsible for calling displayPaymentSettingsForm. Subclasses should override displayPaymentSettingsForm as necessary.
Definition at line 79 of file PaymethodPlugin.inc.php.
References getName().
| PaymethodPlugin.getDescription | ( | ) |
Get a description of this plugin.
Reimplemented in ManualPaymentPlugin, and PayPalPlugin.
Definition at line 55 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).
- Returns:
- String name of plugin
Reimplemented in ManualPaymentPlugin, and PayPalPlugin.
Definition at line 48 of file PaymethodPlugin.inc.php.
Referenced by _smartyDisplayPaymentSettingsForm().
| PaymethodPlugin.getTemplatePath | ( | ) |
Get the Template path for this plugin.
Reimplemented from Plugin.
Definition at line 62 of file PaymethodPlugin.inc.php.
| PaymethodPlugin.handle | ( | $ | args | ) |
Handle an incoming request from a user callback or an external payment processing system.
Reimplemented in ManualPaymentPlugin, and PayPalPlugin.
Definition at line 102 of file PaymethodPlugin.inc.php.
References Request.redirect().
| PaymethodPlugin.PaymethodPlugin | ( | ) |
| PaymethodPlugin.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 ManualPaymentPlugin, and PayPalPlugin.
Definition at line 34 of file PaymethodPlugin.inc.php.
The documentation for this class was generated from the following file:
- classes/plugins/PaymethodPlugin.inc.php
Generated on Thu Sep 20 2012 17:26:07 for Open Conference Systems by
1.7.1