Public Member Functions | |
| _fromRow ($row) | |
| deleteByJournalId ($journalId) | |
| deleteObject ($deposit) | |
| getById ($depositId, $journalId=null) | |
| getByJournalId ($journalId, $dbResultRange=null) | |
| getByUUID ($journalId, $depositUuid) | |
| getInsertId () | |
| getNeedPackaging ($journalId) | |
| getNeedStagingStatusUpdate ($journalId) | |
| getNeedTransferring ($journalId) | |
| getNew ($journalId) | |
| insertObject ($deposit) | |
| newDataObject () | |
| updateObject ($deposit) | |
 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 adding a PLN deposit.
Definition at line 16 of file DepositDAO.inc.php.
Member Function Documentation
◆ _fromRow()
| DepositDAO::_fromRow | ( | $row | ) |
Internal function to return a deposit from a row.
- Parameters
-
$row array
- Returns
- Deposit
Definition at line 137 of file DepositDAO.inc.php.
References HookRegistry\call(), DAO\datetimeFromDB(), and newDataObject().
Referenced by getById(), and getByUUID().
◆ deleteByJournalId()
| DepositDAO::deleteByJournalId | ( | $journalId | ) |
Delete deposits by journal id
- Parameters
-
$journalId
Definition at line 291 of file DepositDAO.inc.php.
References getByJournalId().
◆ deleteObject()
| DepositDAO::deleteObject | ( | $deposit | ) |
Delete deposit
- Parameters
-
$deposit Deposit
Definition at line 112 of file DepositDAO.inc.php.
References DAORegistry\getDAO(), and DAO\update().
◆ getById()
| DepositDAO::getById | ( | $depositId, | |
$journalId = null |
|||
| ) |
Retrieve deposit by ID.
- Parameters
-
$depositId int $journalId int optional
- Returns
- Deposit Object
Definition at line 31 of file DepositDAO.inc.php.
References _fromRow(), and DAO\retrieve().
◆ getByJournalId()
| DepositDAO::getByJournalId | ( | $journalId, | |
$dbResultRange = null |
|||
| ) |
Retrieve all deposits.
- Parameters
-
$journalId int
- Returns
- array Deposit
Definition at line 183 of file DepositDAO.inc.php.
References DAO\retrieveRange().
Referenced by deleteByJournalId().
◆ getByUUID()
| DepositDAO::getByUUID | ( | $journalId, | |
| $depositUuid | |||
| ) |
Retrieve a deposit by deposit uuid and journal id.
- Parameters
-
$journalId int $depositUuid string
- Returns
- Deposit
Definition at line 159 of file DepositDAO.inc.php.
References _fromRow(), and DAO\retrieve().
◆ getInsertId()
| DepositDAO::getInsertId | ( | ) |
Get the ID of the last inserted deposit.
- Returns
- int
Definition at line 128 of file DepositDAO.inc.php.
References DAO\_getInsertId().
Referenced by insertObject().
◆ getNeedPackaging()
| DepositDAO::getNeedPackaging | ( | $journalId | ) |
Retrieve all deposits that need packaging
- Parameters
-
$journalId int
- Returns
- array Deposit
Definition at line 244 of file DepositDAO.inc.php.
References DAO\retrieve().
◆ getNeedStagingStatusUpdate()
| DepositDAO::getNeedStagingStatusUpdate | ( | $journalId | ) |
Retrieve all deposits that need a status update
- Parameters
-
$journalId int
- Returns
- array Deposit
Definition at line 268 of file DepositDAO.inc.php.
References DAO\retrieve().
◆ getNeedTransferring()
| DepositDAO::getNeedTransferring | ( | $journalId | ) |
Retrieve all deposits that need packaging
- Parameters
-
$journalId int
- Returns
- array Deposit
Definition at line 220 of file DepositDAO.inc.php.
References DAO\retrieve().
◆ getNew()
| DepositDAO::getNew | ( | $journalId | ) |
Retrieve all newly-created deposits (ones with new status)
- Parameters
-
$journalId int
- Returns
- array Deposit
Definition at line 203 of file DepositDAO.inc.php.
References DAO\retrieve().
◆ insertObject()
| DepositDAO::insertObject | ( | $deposit | ) |
Insert deposit object
- Parameters
-
$deposit Deposit
- Returns
- int inserted Deposit id
Definition at line 54 of file DepositDAO.inc.php.
References DAO\datetimeToDB(), getInsertId(), and DAO\update().
◆ newDataObject()
| DepositDAO::newDataObject | ( | ) |
Construct a new deposit object.
- Returns
- Deposit
Definition at line 21 of file DepositDAO.inc.php.
Referenced by _fromRow().
◆ updateObject()
| DepositDAO::updateObject | ( | $deposit | ) |
Update deposit
- Parameters
-
$deposit Deposit
Definition at line 83 of file DepositDAO.inc.php.
References DAO\datetimeToDB(), and DAO\update().
The documentation for this class was generated from the following file:
