OMPPaymentManager Class Reference

Provides payment management functions. More...

List of all members.

Public Member Functions
&	createCompletedPayment ($queuedPayment, $payMethod)
&	createCompletedPayment ($queuedPayment, $payMethod)
&	createQueuedPayment ($pressId, $type, $userId, $assocId, $amount, $currencyCode=null)
&	createQueuedPayment ($pressId, $type, $userId, $assocId, $amount, $currencyCode=null)
	fulfillQueuedPayment (&$queuedPayment, $payMethodPluginName=null)
	fulfillQueuedPayment (&$queuedPayment, $payMethodPluginName=null)
&	getPaymentPlugin ()
&	getPaymentPlugin ()
	isConfigured ()
	isConfigured ()
	OMPPaymentManager (&$request)
	OMPPaymentManager (&$request)

---

Detailed Description

Provides payment management functions.

See also:

OMPQueuedPayment

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

---

Member Function Documentation

& OMPPaymentManager.createCompletedPayment	(	$	queuedPayment,
		$	payMethod
	)

Create a completed payment from a queued payment.

Parameters:

	$queuedPayment	QueuedPayment Payment to complete.
	$payMethod	string Name of payment plugin used.

Returns:

OMPCompletedPayment

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

Referenced by fulfillQueuedPayment().

& OMPPaymentManager.createCompletedPayment	(	$	queuedPayment,
		$	payMethod
	)

Create a completed payment from a queued payment.

Parameters:

	$queuedPayment	QueuedPayment Payment to complete.
	$payMethod	string Name of payment plugin used.

Returns:

OMPCompletedPayment

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

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

Create a queued payment.

Parameters:

	$pressId	int ID of press payment applies under
	$type	int PAYMENT_TYPE_...
	$userId	int ID of user responsible for payment
	$assocId	int ID of associated entity
	$amount	numeric Amount of currency $currencyCode
	$currencyCode	string optional ISO 4217 currency code

Returns:

QueuedPayment

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

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

Create a queued payment.

Parameters:

	$pressId	int ID of press payment applies under
	$type	int PAYMENT_TYPE_...
	$userId	int ID of user responsible for payment
	$assocId	int ID of associated entity
	$amount	numeric Amount of currency $currencyCode
	$currencyCode	string optional ISO 4217 currency code

Returns:

QueuedPayment

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

OMPPaymentManager.fulfillQueuedPayment	(	&$	queuedPayment,
		$	payMethodPluginName = null
	)

Fulfill a queued payment.

Parameters:

	$queuedPayment	QueuedPayment
	$payMethodPluginName	string Name of payment plugin.

Returns:

mixed Dependent on payment type.

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

References createCompletedPayment().

OMPPaymentManager.fulfillQueuedPayment	(	&$	queuedPayment,
		$	payMethodPluginName = null
	)

Fulfill a queued payment.

Parameters:

	$queuedPayment	QueuedPayment
	$payMethodPluginName	string Name of payment plugin.

Returns:

mixed Dependent on payment type.

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

References createCompletedPayment().

& OMPPaymentManager.getPaymentPlugin

(

)

Get the payment plugin.

Parameters:

$press

Press

Returns:

PaymentPlugin

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

& OMPPaymentManager.getPaymentPlugin

(

)

Get the payment plugin.

Parameters:

$press

Press

Returns:

PaymentPlugin

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

OMPPaymentManager.isConfigured

(

)

Determine whether the payment system is configured.

Returns:

boolean true iff configured

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

References isConfigured().

OMPPaymentManager.isConfigured

(

)

Determine whether the payment system is configured.

Returns:

boolean true iff configured

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

Referenced by isConfigured().

OMPPaymentManager.OMPPaymentManager

(

&$

request

)

Constructor

Parameters:

$request

PKPRequest

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

OMPPaymentManager.OMPPaymentManager

(

&$

request

)

Constructor

Parameters:

$request

PKPRequest

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

---

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

• classes/payment/omp/OMPPaymentManager.inc.php
• omp.JipGdx/omp-1.0b/classes/payment/omp/OMPPaymentManager.inc.php