Public Member Functions | |
| _fromRow ($row) | |
| deleteById ($fileId, $revision=null) | |
| filenameExists ($contextId, $fileName) | |
| getByContextId ($contextId, $type=null) | |
| getById ($fileId, $contextId=null) | |
| getBySubmissionId ($submissionId, $type=null, $contextId=null) | |
| getInsertId () | |
| getLocaleFieldNames () | |
| insertObject ($libraryFile) | |
| newDataObject () | |
| updateLocaleFields (&$libraryFile) | |
| updateObject ($libraryFile) | |
 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 () | |
| 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 LibraryFile objects.
- See also
- LibraryFile
Definition at line 19 of file LibraryFileDAO.inc.php.
Member Function Documentation
◆ _fromRow()
| LibraryFileDAO::_fromRow | ( | $row | ) |
Internal function to return a LibraryFile object from a row.
- Parameters
-
$row array
- Returns
- LibraryFile
Definition at line 121 of file LibraryFileDAO.inc.php.
References HookRegistry\call(), DAO\datetimeFromDB(), DAO\getDataObjectSettings(), and newDataObject().
Referenced by getById().
◆ deleteById()
| LibraryFileDAO::deleteById | ( | $fileId, | |
$revision = null |
|||
| ) |
Delete a library file by ID.
- Parameters
-
$libraryId int $revision int
Definition at line 219 of file LibraryFileDAO.inc.php.
References DAO\update().
◆ filenameExists()
| LibraryFileDAO::filenameExists | ( | $contextId, | |
| $fileName | |||
| ) |
Check if a file with this filename already exists
- Parameters
-
$contextId int the context to check in. $filename String the filename to be checked
- Returns
- bool
Definition at line 236 of file LibraryFileDAO.inc.php.
References DAO\retrieve().
◆ getByContextId()
| LibraryFileDAO::getByContextId | ( | $contextId, | |
$type = null |
|||
| ) |
Retrieve all library files for a context.
- Parameters
-
$contextId int $type (optional)
- Returns
- array LibraryFiles
Definition at line 53 of file LibraryFileDAO.inc.php.
References DAO\retrieve().
◆ getById()
| LibraryFileDAO::getById | ( | $fileId, | |
$contextId = null |
|||
| ) |
Retrieve a library file by ID.
- Parameters
-
$fileId int $contextId int optional
- Returns
- LibraryFile
Definition at line 27 of file LibraryFileDAO.inc.php.
References _fromRow(), and DAO\retrieve().
◆ getBySubmissionId()
| LibraryFileDAO::getBySubmissionId | ( | $submissionId, | |
$type = null, |
|||
$contextId = null |
|||
| ) |
Retrieve all library files for a submission.
- Parameters
-
$submissionId int $type (optional) $contextId (optional) int
- Returns
- array LibraryFiles
Definition at line 73 of file LibraryFileDAO.inc.php.
References DAO\retrieve().
◆ getInsertId()
| LibraryFileDAO::getInsertId | ( | ) |
Get the ID of the last inserted library file.
- Returns
- int
Definition at line 251 of file LibraryFileDAO.inc.php.
References DAO\_getInsertId().
Referenced by insertObject().
◆ getLocaleFieldNames()
| LibraryFileDAO::getLocaleFieldNames | ( | ) |
Get the list of fields for which data is localized.
- Returns
- array
Reimplemented from DAO.
Definition at line 100 of file LibraryFileDAO.inc.php.
◆ insertObject()
| LibraryFileDAO::insertObject | ( | $libraryFile | ) |
Insert a new LibraryFile.
- Parameters
-
$libraryFile LibraryFile
- Returns
- int
Definition at line 147 of file LibraryFileDAO.inc.php.
References getInsertId(), DAO\update(), and updateLocaleFields().
◆ newDataObject()
| LibraryFileDAO::newDataObject | ( | ) |
Construct a new data object corresponding to this DAO.
- Returns
- LibraryFile
Definition at line 91 of file LibraryFileDAO.inc.php.
Referenced by _fromRow().
◆ updateLocaleFields()
| LibraryFileDAO::updateLocaleFields | ( | & | $libraryFile | ) |
Update the localized fields for this file.
- Parameters
-
$libraryFile
Definition at line 108 of file LibraryFileDAO.inc.php.
References DAO\updateDataObjectSettings().
Referenced by insertObject(), and updateObject().
◆ updateObject()
| LibraryFileDAO::updateObject | ( | $libraryFile | ) |
Update a LibraryFile
- Parameters
-
$libraryFile LibraryFile
- Returns
- int
Definition at line 183 of file LibraryFileDAO.inc.php.
References DAO\datetimeToDB(), DAO\update(), and updateLocaleFields().
The documentation for this class was generated from the following file:
