Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PaymentManager Class Reference
Inheritance diagram for PaymentManager:
OJSPaymentManager

Public Member Functions

 displayConfigurationForm ()
 
 displayPaymentForm ($queuedPaymentId, &$queuedPayment)
 
 fulfillQueuedPayment (&$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 83 of file PaymentManager.inc.php.

References getPaymentPlugin().

PaymentManager::displayPaymentForm (   $queuedPaymentId,
$queuedPayment 
)

Call the payment plugin's display method

Parameters
$queuedPaymentIdint
$queuedPaymentobject
Returns
boolean

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

References getPaymentPlugin().

PaymentManager::fulfillQueuedPayment ( $queuedPayment)

Fulfill a queued payment

Parameters
$queuedPaymentQueuedPayment
Returns
boolean success/failure

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

& PaymentManager::getPaymentPlugin ( )

Abstract method for fetching the payment plugin

Returns
object

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

Referenced by displayConfigurationForm(), displayPaymentForm(), and isConfigured().

& PaymentManager::getQueuedPayment (   $queuedPaymentId)

Fetch a queued payment

Parameters
$queuedPaymentIdint
Returns
QueuedPayment

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

References DAORegistry\getDAO().

PaymentManager::isConfigured ( )

Check if there is a payment plugin and if is configured

Returns
bool

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

References getPaymentPlugin(), and PKPApplication\getRequest().

Referenced by queuePayment().

PaymentManager::PaymentManager ( $request)

Constructor

Parameters
$requestPKPRequest

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

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 36 of file PaymentManager.inc.php.

References DAORegistry\getDAO(), and isConfigured().


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