Public Member Functions | |
| _fromRow ($row) | |
| getByContextId ($contextId, $rangeInfo=null) | |
| getById ($completedPaymentId, $contextId=null) | |
| getByUserId ($userId, $rangeInfo=null) | |
| getInsertId () | |
| hasPaidPurchaseFile ($userId, $fileIdAndRevision) | |
| insertCompletedPayment ($completedPayment) | |
| newDataObject () | |
| updateObject ($completedPayment) | |
 Public Member Functions inherited from DAO | |
| __construct ($dataSource=null, $callHooks=true) | |
| concat () | |
| convertFromDB ($value, $type) | |
| convertToDB ($value, &$type) | |
| dateFromDB ($d) | |
| datetimeFromDB ($dt) | |
| datetimeToDB ($dt) | |
| dateToDB ($d) | |
| flushCache () | |
| formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true) | |
| getAdditionalFieldNames () | |
| getAffectedRows () | |
| getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject) | |
| getDataSource () | |
| getDirectionMapping ($direction) | |
| getDriver () | |
| getLocaleFieldNames () | |
| getType ($value) | |
| handleError ($dataSource, $sql) | |
| nullOrInt ($value) | |
| replace ($table, $arrFields, $keyCols) | |
| & | retrieve ($sql, $params=false, $callHooks=true) |
| & | retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true) |
| & | retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true) |
| & | retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true) |
| setCacheDir () | |
| setDataSource ($dataSource) | |
| update ($sql, $params=false, $callHooks=true, $dieOnError=true) | |
| updateDataObjectSettings ($tableName, $dataObject, $idArray) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from DAO | |
| static | getDataChangedEvent ($elementId=null, $parentElementId=null, $content='') |
| Data Fields inherited from DAO | |
| $_dataSource | |
| Protected Member Functions inherited from DAO | |
| _getInsertId ($table='', $id='') | |
Detailed Description
Operations for retrieving and querying past payments.
- See also
- CompletedPayment, Payment
Definition at line 21 of file OMPCompletedPaymentDAO.inc.php.
Member Function Documentation
◆ _fromRow()
| OMPCompletedPaymentDAO::_fromRow | ( | $row | ) |
Internal function to return a CompletedPayment object from a row.
- Parameters
-
$row array
- Returns
- CompletedPayment
Definition at line 183 of file OMPCompletedPaymentDAO.inc.php.
References DAO\datetimeFromDB(), and newDataObject().
Referenced by getById().
◆ getByContextId()
| OMPCompletedPaymentDAO::getByContextId | ( | $contextId, | |
$rangeInfo = null |
|||
| ) |
Retrieve an array of payments for a particular context ID.
- Parameters
-
$contextId int
- Returns
- object DAOResultFactory containing matching payments
Definition at line 144 of file OMPCompletedPaymentDAO.inc.php.
References DAO\retrieveRange().
◆ getById()
| OMPCompletedPaymentDAO::getById | ( | $completedPaymentId, | |
$contextId = null |
|||
| ) |
Retrieve a ComplatedPayment by its ID.
- Parameters
-
$completedPaymentId int $contextId int optional
- Returns
- CompletedPayment
Definition at line 28 of file OMPCompletedPaymentDAO.inc.php.
References _fromRow(), and DAO\retrieve().
◆ getByUserId()
| OMPCompletedPaymentDAO::getByUserId | ( | $userId, | |
$rangeInfo = null |
|||
| ) |
Retrieve an array of payments for a particular user ID.
- Parameters
-
$userId int
- Returns
- object DAOResultFactory containing matching payments
Definition at line 159 of file OMPCompletedPaymentDAO.inc.php.
References DAO\retrieveRange().
◆ getInsertId()
| OMPCompletedPaymentDAO::getInsertId | ( | ) |
Get the ID of the last inserted completed payment.
- Returns
- int
Definition at line 111 of file OMPCompletedPaymentDAO.inc.php.
References DAO\_getInsertId().
Referenced by insertCompletedPayment().
◆ hasPaidPurchaseFile()
| OMPCompletedPaymentDAO::hasPaidPurchaseFile | ( | $userId, | |
| $fileIdAndRevision | |||
| ) |
Look for a completed PURCHASE_PUBLICATION_FORMAT payment matching the article ID
- Parameters
-
$userId int string $fileIdAndRevision
Definition at line 120 of file OMPCompletedPaymentDAO.inc.php.
References DAO\retrieve().
◆ insertCompletedPayment()
| OMPCompletedPaymentDAO::insertCompletedPayment | ( | $completedPayment | ) |
Insert a new completed payment.
- Parameters
-
$completedPayment CompletedPayment
Definition at line 50 of file OMPCompletedPaymentDAO.inc.php.
References DAO\datetimeToDB(), Core\getCurrentDate(), getInsertId(), and DAO\update().
◆ newDataObject()
| OMPCompletedPaymentDAO::newDataObject | ( | ) |
Return a new data object.
- Returns
- CompletedPayment
Definition at line 174 of file OMPCompletedPaymentDAO.inc.php.
Referenced by _fromRow().
◆ updateObject()
| OMPCompletedPaymentDAO::updateObject | ( | $completedPayment | ) |
Update an existing completed payment.
- Parameters
-
$completedPayment CompletedPayment
- Returns
- boolean
Definition at line 76 of file OMPCompletedPaymentDAO.inc.php.
References DAO\datetimeToDB(), and DAO\update().
The documentation for this class was generated from the following file:
