Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
OJSCompletedPaymentDAO Class Reference
Inheritance diagram for OJSCompletedPaymentDAO:
DAO

Public Member Functions

_returnPaymentFromRow (&$row)
 
getCompletedPayment ($completedPaymentId, $journalId=null)
 
 getFastTrackCompletedPayment ($journalId, $articleId)
 
 getInsertCompletedPaymentId ()
 
getPaymentsByJournalId ($journalId, $rangeInfo=null)
 
 getPublicationCompletedPayment ($journalId, $articleId)
 
getSubmissionCompletedPayment ($journalId, $articleId)
 
 hasPaidFastTrack ($journalId, $articleId)
 
 hasPaidPublication ($journalId, $articleId)
 
 hasPaidPurchaseArticle ($userId, $articleId)
 
 hasPaidPurchaseIssue ($userId, $issueId)
 
 hasPaidSubmission ($journalId, $articleId)
 
 insertCompletedPayment (&$completedPayment)
 
 newDataObject ()
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($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

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and querying past payments.

See Also
OJSCompletedPayment, Payment

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

Member Function Documentation

& OJSCompletedPaymentDAO::_returnPaymentFromRow ( $row)

Internal function to return a OJSCompletedPayment object from a row.

Parameters
$rowarray
Returns
CompletedPayment

Definition at line 303 of file OJSCompletedPaymentDAO.inc.php.

References DAO\datetimeFromDB(), and newDataObject().

Referenced by getCompletedPayment(), getFastTrackCompletedPayment(), getPublicationCompletedPayment(), and getSubmissionCompletedPayment().

& OJSCompletedPaymentDAO::getCompletedPayment (   $completedPaymentId,
  $journalId = null 
)

Retrieve a ComplatedPayment by its ID.

Parameters
$completedPaymentIdint
$journalIdint optional
Returns
CompletedPayment

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

References _returnPaymentFromRow(), and DAO\retrieve().

OJSCompletedPaymentDAO::getFastTrackCompletedPayment (   $journalId,
  $articleId 
)

get a CompletedPayment for a FASTTRACK type payment matching the journal and article IDs

Parameters
int$journalId
int$articleId
Returns
CompletedPayment

Definition at line 208 of file OJSCompletedPaymentDAO.inc.php.

References _returnPaymentFromRow(), and DAO\retrieve().

OJSCompletedPaymentDAO::getInsertCompletedPaymentId ( )

Get the ID of the last inserted completed payment.

Returns
int

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

References DAO\getInsertId().

Referenced by insertCompletedPayment().

& OJSCompletedPaymentDAO::getPaymentsByJournalId (   $journalId,
  $rangeInfo = null 
)

Retrieve an array of payments for a particular journal ID.

Parameters
$journalIdint
Returns
object DAOResultFactory containing matching payments

Definition at line 279 of file OJSCompletedPaymentDAO.inc.php.

References DAO\retrieveRange().

OJSCompletedPaymentDAO::getPublicationCompletedPayment (   $journalId,
  $articleId 
)

get a CompletedPayment for a PUBLICATION type payment matching the journal and article IDs

Parameters
int$journalId
int$articleId
Returns
CompletedPayment

Definition at line 254 of file OJSCompletedPaymentDAO.inc.php.

References _returnPaymentFromRow(), and DAO\retrieve().

& OJSCompletedPaymentDAO::getSubmissionCompletedPayment (   $journalId,
  $articleId 
)

get a CompletedPayment for a SUBMISSION type payment matching the journal and article IDs

Parameters
int$journalId
int$articleId
Returns
CompletedPayment

Definition at line 158 of file OJSCompletedPaymentDAO.inc.php.

References _returnPaymentFromRow(), and DAO\retrieve().

OJSCompletedPaymentDAO::hasPaidFastTrack (   $journalId,
  $articleId 
)

Look for a completed FASTTRACK payment matching the journal and article IDs

Parameters
int$journalId
int$articleId
Returns
bool

Definition at line 184 of file OJSCompletedPaymentDAO.inc.php.

References DAO\retrieve().

OJSCompletedPaymentDAO::hasPaidPublication (   $journalId,
  $articleId 
)

Look for a completed payment matching the publication type and article ID

Parameters
int$journalId
int$articleId

Definition at line 233 of file OJSCompletedPaymentDAO.inc.php.

References DAO\retrieve().

OJSCompletedPaymentDAO::hasPaidPurchaseArticle (   $userId,
  $articleId 
)

Look for a completed PURCHASE_ARTICLE payment matching the article ID

Parameters
$userIdint
$articleIdint

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

References DAO\retrieve().

OJSCompletedPaymentDAO::hasPaidPurchaseIssue (   $userId,
  $issueId 
)

Look for a completed PURCHASE_ISSUE payment matching the journal and issue IDs

Parameters
int$journalId
int$issueId

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

References DAO\retrieve().

OJSCompletedPaymentDAO::hasPaidSubmission (   $journalId,
  $articleId 
)

Look for a completed SUBMISSION payment matching the journal and article IDs

Parameters
int$journalId
int$articleId
Returns
bool

Definition at line 133 of file OJSCompletedPaymentDAO.inc.php.

References DAO\retrieve().

OJSCompletedPaymentDAO::insertCompletedPayment ( $completedPayment)

Insert a new completed payment.

Parameters
$completedPaymentOJSCompletedPayment

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

References DAO\datetimeToDB(), Core\getCurrentDate(), getInsertCompletedPaymentId(), and DAO\update().

OJSCompletedPaymentDAO::newDataObject ( )

Return a new data object.

Returns
OJSCompletedPayment

Definition at line 294 of file OJSCompletedPaymentDAO.inc.php.

Referenced by _returnPaymentFromRow().


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