Open Journal Systems  3.3.0
QueuedPaymentDAO Class Reference
Inheritance diagram for QueuedPaymentDAO:
DAO

Public Member Functions

 deleteById ($queuedPaymentId)
 
 deleteExpired ()
 
 getById ($queuedPaymentId)
 
 getInsertId ()
 
 insertObject ($queuedPayment, $expiryDate=null)
 
 updateObject ($queuedPaymentId, $queuedPayment)
 
- 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 modifying queued payment objects.

See also
QueuedPayment

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

Member Function Documentation

◆ deleteById()

QueuedPaymentDAO::deleteById (   $queuedPaymentId)

Delete a queued payment.

Parameters
$queuedPaymentIdint

Definition at line 96 of file QueuedPaymentDAO.inc.php.

References DAORegistry\getDAO(), and DAO\update().

◆ deleteExpired()

QueuedPaymentDAO::deleteExpired ( )

Delete expired queued payments.

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

References DAO\update().

◆ getById()

QueuedPaymentDAO::getById (   $queuedPaymentId)

Retrieve a queued payment by ID.

Parameters
$queuedPaymentIdint
Returns
QueuedPayment or null on failure

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

References DAO\retrieve().

◆ getInsertId()

QueuedPaymentDAO::getInsertId ( )

Get the ID of the last inserted queued payment.

Returns
int

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

References DAO\_getInsertId().

Referenced by insertObject().

◆ insertObject()

QueuedPaymentDAO::insertObject (   $queuedPayment,
  $expiryDate = null 
)

Insert a new queued payment.

Parameters
$queuedPaymentQueuedPayment
$expiryDatedate optional

Definition at line 47 of file QueuedPaymentDAO.inc.php.

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

◆ updateObject()

QueuedPaymentDAO::updateObject (   $queuedPaymentId,
  $queuedPayment 
)

Update an existing queued payment.

Parameters
$queuedPaymentIdint
$queuedPaymentQueuedPayment

Definition at line 69 of file QueuedPaymentDAO.inc.php.

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


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