PaymentManager Class Reference
[Payment]

Provides payment management functions. More...

Inheritance diagram for PaymentManager:

List of all members.

Public Member Functions
	displayConfigurationForm ()
	displayPaymentForm ($queuedPaymentId, &$queuedPayment)
	fulfillQueuedPayment (&$queuedPayment)
&	getManager ()
&	getPaymentPlugin ()
&	getQueuedPayment ($queuedPaymentId)
	isConfigured ()
	queuePayment (&$queuedPayment)

---

Detailed Description

Provides payment management functions.

See also:

Payment, QueuedPaymentDAO

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

---

Member Function Documentation

PaymentManager.displayConfigurationForm

(

)

Call the payment plugin's settings display method

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

References getPaymentPlugin(), and isConfigured().

PaymentManager.displayPaymentForm	(	$	queuedPaymentId,
		&$	queuedPayment
	)

Call the payment plugin's display method

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

References getPaymentPlugin(), and isConfigured().

PaymentManager.fulfillQueuedPayment

(

&$

queuedPayment

)

Abstract method for fulfilling a queued payment

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

& PaymentManager.getManager

(

)

Get the payment manager.

Reimplemented in OJSPaymentManager.

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

& PaymentManager.getPaymentPlugin

(

)

Abstract method for fetching the payment plugin

Returns:

null

Reimplemented in OJSPaymentManager.

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

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

& PaymentManager.getQueuedPayment

(

$

queuedPaymentId

)

Fetch a queued payment

Returns:

QueuedPayment

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

References DAORegistry.getDAO().

PaymentManager.isConfigured

(

)

Check if there is a payment plugin and if is configured

Returns:

bool

Reimplemented in OJSPaymentManager.

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

References getPaymentPlugin().

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

PaymentManager.queuePayment

(

&$

queuedPayment

)

Queue a payment for receipt.

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

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

---

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

• classes/payment/PaymentManager.inc.php