Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
OMPPaymentManager Class Reference
Inheritance diagram for OMPPaymentManager:
PaymentManager

Public Member Functions

createCompletedPayment ($queuedPayment, $payMethod)
 
createQueuedPayment ($pressId, $type, $userId, $assocId, $amount, $currencyCode=null)
 
 fulfillQueuedPayment ($request, &$queuedPayment, $payMethodPluginName=null)
 
getPaymentPlugin ()
 
 isConfigured ()
 
 OMPPaymentManager ($request)
 
- Public Member Functions inherited from PaymentManager
 displayConfigurationForm ()
 
 displayPaymentForm ($queuedPaymentId, &$queuedPayment)
 
 fulfillQueuedPayment ($request, &$queuedPayment)
 
getPaymentPlugin ()
 
getQueuedPayment ($queuedPaymentId)
 
 isConfigured ()
 
 PaymentManager ($request)
 
 queuePayment ($queuedPayment, $expiryDate=null)
 

Public Attributes

 $press
 

Detailed Description

Provides payment management functions.

See Also
OMPQueuedPayment

Definition at line 23 of file OMPPaymentManager.inc.php.

Member Function Documentation

& OMPPaymentManager::createCompletedPayment (   $queuedPayment,
  $payMethod 
)

Create a completed payment from a queued payment.

Parameters
$queuedPaymentQueuedPayment Payment to complete.
$payMethodstring Name of payment plugin used.
Returns
OMPCompletedPayment

Definition at line 136 of file OMPPaymentManager.inc.php.

& OMPPaymentManager::createQueuedPayment (   $pressId,
  $type,
  $userId,
  $assocId,
  $amount,
  $currencyCode = null 
)

Create a queued payment.

Parameters
$pressIdint ID of press payment applies under
$typeint PAYMENT_TYPE_...
$userIdint ID of user responsible for payment
$assocIdint ID of associated entity
$amountnumeric Amount of currency $currencyCode
$currencyCodestring optional ISO 4217 currency code
Returns
QueuedPayment

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

OMPPaymentManager::fulfillQueuedPayment (   $request,
$queuedPayment,
  $payMethodPluginName = null 
)

Fulfill a queued payment.

Parameters
$requestPKPRequest
$queuedPaymentQueuedPayment
$payMethodPluginNamestring Name of payment plugin.
Returns
mixed Dependent on payment type.

Definition at line 109 of file OMPPaymentManager.inc.php.

& OMPPaymentManager::getPaymentPlugin ( )

Get the payment plugin.

Parameters
$pressPress
Returns
PaymentPlugin

Definition at line 92 of file OMPPaymentManager.inc.php.

References PluginRegistry\loadCategory().

OMPPaymentManager::isConfigured ( )

Determine whether the payment system is configured.

Returns
boolean true iff configured

Definition at line 43 of file OMPPaymentManager.inc.php.

References $press, and DAORegistry\getDAO().

OMPPaymentManager::OMPPaymentManager (   $request)

Constructor

Parameters
$requestPKPRequest

Definition at line 34 of file OMPPaymentManager.inc.php.

Member Data Documentation

$press OMPPaymentManager::$press

Press

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

Referenced by isConfigured().


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