OMPCompletedPaymentDAO Class Reference

Operations for retrieving and querying past payments. More...

List of all members.

Public Member Functions
&	_returnPaymentFromRow (&$row)
&	getCompletedPayment ($completedPaymentId, $pressId=null)
	getInsertCompletedPaymentId ()
&	getPaymentsByPressId ($pressId, $rangeInfo=null)
	hasPaidPurchaseFile ($userId, $fileIdAndRevision)
	insertCompletedPayment (&$completedPayment)
	newDataObject ()

---

Detailed Description

Operations for retrieving and querying past payments.

See also:

OMPCompletedPayment, Payment

Definition at line 20 of file OMPCompletedPaymentDAO.inc.php.

---

Member Function Documentation

& OMPCompletedPaymentDAO._returnPaymentFromRow

(

&$

row

)

Internal function to return a OMPCompletedPayment object from a row.

Parameters:

$row

array

Returns:

CompletedPayment

Definition at line 132 of file OMPCompletedPaymentDAO.inc.php.

References newDataObject().

Referenced by getCompletedPayment().

& OMPCompletedPaymentDAO.getCompletedPayment	(	$	completedPaymentId,
		$	pressId = null
	)

Retrieve a ComplatedPayment by its ID.

Parameters:

	$completedPaymentId	int
	$pressId	int optional

Returns:

OMPCompletedPayment

Definition at line 27 of file OMPCompletedPaymentDAO.inc.php.

References _returnPaymentFromRow().

OMPCompletedPaymentDAO.getInsertCompletedPaymentId

(

)

Get the ID of the last inserted completed payment.

Returns:

int

Definition at line 75 of file OMPCompletedPaymentDAO.inc.php.

Referenced by insertCompletedPayment().

& OMPCompletedPaymentDAO.getPaymentsByPressId	(	$	pressId,
		$	rangeInfo = null
	)

Retrieve an array of payments for a particular press ID.

Parameters:

$pressId

int

Returns:

object DAOResultFactory containing matching payments

Definition at line 108 of file OMPCompletedPaymentDAO.inc.php.

OMPCompletedPaymentDAO.hasPaidPurchaseFile	(	$	userId,
		$	fileIdAndRevision
	)

Look for a completed PURCHASE_PUBLICATION_FORMAT payment matching the article ID

Parameters:

	$userId	int
	string	$fileIdAndRevision

Definition at line 84 of file OMPCompletedPaymentDAO.inc.php.

OMPCompletedPaymentDAO.insertCompletedPayment

(

&$

completedPayment

)

Insert a new completed payment.

Parameters:

$completedPayment

OMPCompletedPayment

Definition at line 50 of file OMPCompletedPaymentDAO.inc.php.

References getInsertCompletedPaymentId().

OMPCompletedPaymentDAO.newDataObject

(

)

Return a new data object.

Returns:

OMPCompletedPayment

Definition at line 123 of file OMPCompletedPaymentDAO.inc.php.

Referenced by _returnPaymentFromRow().

---

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

• classes/payment/omp/OMPCompletedPaymentDAO.inc.php