PaymentManager Class Reference

Inheritance diagram for PaymentManager:

Public Member Functions
	__construct ($context)
	displayConfigurationForm ()
	fulfillQueuedPayment ($request, $queuedPayment)
	getPaymentForm ($queuedPayment)
	getPaymentPlugin ()
	getQueuedPayment ($queuedPaymentId)
	isConfigured ()
	queuePayment ($queuedPayment, $expiryDate=null)

Data Fields
	$_context

Detailed Description

Provides payment management functions.

See also

Payment

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

Constructor & Destructor Documentation

__construct()

PaymentManager::__construct

(

$context

)

Constructor

Parameters

$context

Context

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

Member Function Documentation

displayConfigurationForm()

PaymentManager::displayConfigurationForm

(

)

Call the payment plugin's settings display method

Returns

boolean

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

References getPaymentPlugin().

fulfillQueuedPayment()

PaymentManager::fulfillQueuedPayment (   $request,   $queuedPayment  )

abstract

Fulfill a queued payment

Parameters

$request	PKPRequest
$queuedPayment	QueuedPayment

Returns

boolean success/failure

getPaymentForm()

PaymentManager::getPaymentForm

(

$queuedPayment

)

Get the payment form for the configured payment plugin and specified payment.

Parameters

$queuedPayment

QueuedPayment

Returns

Form

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

References getPaymentPlugin().

getPaymentPlugin()

PaymentManager::getPaymentPlugin ( )

abstract

Abstract method for fetching the payment plugin

Returns

object

Reimplemented in OJSPaymentManager.

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

getQueuedPayment()

PaymentManager::getQueuedPayment

(

$queuedPaymentId

)

Fetch a queued payment

Parameters

$queuedPaymentId

int

Returns

QueuedPayment

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

References DAORegistry\getDAO().

isConfigured()

PaymentManager::isConfigured

(

)

Check if there is a payment plugin and if is configured

Returns

bool

Reimplemented in OJSPaymentManager.

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

References getPaymentPlugin().

Referenced by queuePayment().

queuePayment()

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

Queue a payment for receipt.

Parameters

$queuedPayment	object
$expiryDate	date optional

Returns

mixed Queued payment ID for new payment, or false if fails

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

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

Field Documentation

$_context

Context PaymentManager::$_context

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

---

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

• PaymentManager.inc.php