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

Public Member Functions

 displayConfigurationForm ()
 
 displayPaymentForm ($queuedPaymentId, &$queuedPayment)
 
 fulfillQueuedPayment ($request, &$queuedPayment)
 
getPaymentPlugin ()
 
getQueuedPayment ($queuedPaymentId)
 
 isConfigured ()
 
 PaymentManager ($request)
 
 queuePayment ($queuedPayment, $expiryDate=null)
 

Detailed Description

Provides payment management functions.

See Also
Payment

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

Member Function Documentation

PaymentManager::displayConfigurationForm ( )

Call the payment plugin's settings display method

Returns
boolean

Definition at line 86 of file PaymentManager.inc.php.

PaymentManager::displayPaymentForm (   $queuedPaymentId,
$queuedPayment 
)

Call the payment plugin's display method

Parameters
$queuedPaymentIdint
$queuedPaymentobject
Returns
boolean

Definition at line 76 of file PaymentManager.inc.php.

PaymentManager::fulfillQueuedPayment (   $request,
$queuedPayment 
)

Fulfill a queued payment

Parameters
$requestPKPRequest
$queuedPaymentQueuedPayment
Returns
boolean success/failure

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

& PaymentManager::getPaymentPlugin ( )

Abstract method for fetching the payment plugin

Returns
object

Definition at line 55 of file PaymentManager.inc.php.

& PaymentManager::getQueuedPayment (   $queuedPaymentId)

Fetch a queued payment

Parameters
$queuedPaymentIdint
Returns
QueuedPayment

Definition at line 97 of file PaymentManager.inc.php.

PaymentManager::isConfigured ( )

Check if there is a payment plugin and if is configured

Returns
bool

Definition at line 64 of file PaymentManager.inc.php.

Referenced by PaymentManager().

PaymentManager::PaymentManager (   $request)

Constructor

Parameters
$requestPKPRequest

Definition at line 29 of file PaymentManager.inc.php.

References isConfigured().

PaymentManager::queuePayment (   $queuedPayment,
  $expiryDate = null 
)

Queue a payment for receipt.

Parameters
$queuedPaymentobject
$expiryDatedate optional
Returns
mixed Queued payment ID for new payment, or false if fails

Definition at line 39 of file PaymentManager.inc.php.


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