Public Member Functions | |
| createCompletedPayment ($queuedPayment, $payMethod) | |
| createQueuedPayment ($request, $type, $userId, $assocId, $amount, $currencyCode=null) | |
| fulfillQueuedPayment ($request, $queuedPayment, $payMethodPluginName=null) | |
| getPaymentName ($payment) | |
| getPaymentPlugin () | |
| isConfigured () | |
 Public Member Functions inherited from PaymentManager | |
| __construct ($context) | |
| displayConfigurationForm () | |
| fulfillQueuedPayment ($request, $queuedPayment) | |
| getPaymentForm ($queuedPayment) | |
| getQueuedPayment ($queuedPaymentId) | |
| queuePayment ($queuedPayment, $expiryDate=null) | |
Additional Inherited Members | |
| Data Fields inherited from PaymentManager | |
| $_context | |
Detailed Description
Provides payment management functions.
- See also
- QueuedPayment
Definition at line 24 of file OMPPaymentManager.inc.php.
Member Function Documentation
◆ createCompletedPayment()
| OMPPaymentManager::createCompletedPayment | ( | $queuedPayment, | |
| $payMethod | |||
| ) |
Create a completed payment from a queued payment.
- Parameters
-
$queuedPayment QueuedPayment Payment to complete. $payMethod string Name of payment plugin used.
- Returns
- CompletedPayment
Definition at line 120 of file OMPPaymentManager.inc.php.
Referenced by fulfillQueuedPayment().
◆ createQueuedPayment()
| OMPPaymentManager::createQueuedPayment | ( | $request, | |
| $type, | |||
| $userId, | |||
| $assocId, | |||
| $amount, | |||
$currencyCode = null |
|||
| ) |
Create a queued payment.
- Parameters
-
$request PKPRequest $type int PAYMENT_TYPE_... $userId int ID of user responsible for payment $assocId int ID of associated entity $amount numeric Amount of currency $currencyCode $currencyCode string optional ISO 4217 currency code
- Returns
- QueuedPayment
Definition at line 43 of file OMPPaymentManager.inc.php.
References DAORegistry\getDAO().
◆ fulfillQueuedPayment()
| OMPPaymentManager::fulfillQueuedPayment | ( | $request, | |
| $queuedPayment, | |||
$payMethodPluginName = null |
|||
| ) |
Fulfill a queued payment.
- Parameters
-
$request PKPRequest $queuedPayment QueuedPayment $payMethodPluginName string Name of payment plugin.
- Returns
- mixed Dependent on payment type.
Definition at line 93 of file OMPPaymentManager.inc.php.
References createCompletedPayment(), and DAORegistry\getDAO().
◆ getPaymentName()
| OMPPaymentManager::getPaymentName | ( | $payment | ) |
Returns the name of a payment.
- Returns
- string
Definition at line 138 of file OMPPaymentManager.inc.php.
References DAORegistry\getDAO().
◆ getPaymentPlugin()
| OMPPaymentManager::getPaymentPlugin | ( | ) |
Get the payment plugin.
- Returns
- PaymentPlugin
Reimplemented from PaymentManager.
Definition at line 76 of file OMPPaymentManager.inc.php.
References PluginRegistry\loadCategory().
◆ isConfigured()
| OMPPaymentManager::isConfigured | ( | ) |
Determine whether the payment system is configured.
- Returns
- boolean true iff configured
Reimplemented from PaymentManager.
Definition at line 29 of file OMPPaymentManager.inc.php.
The documentation for this class was generated from the following file:
