Public Member Functions | |
| _fromRow ($row) | |
| _newDataObject () | |
| _updateObjectMetadata ($citation) | |
| deleteById ($citationId) | |
| deleteByPublicationId ($publicationId) | |
| deleteObject ($citation) | |
| getAdditionalFieldNames () | |
| getById ($citationId) | |
| getByPublicationId ($publicationId, $rangeInfo=null) | |
| getInsertId () | |
| importCitations ($publicationId, $rawCitationList) | |
| insertObject ($citation) | |
| updateObject ($citation) | |
 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) | |
| 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 Citation objects.
- See also
- Citation
Definition at line 19 of file CitationDAO.inc.php.
Member Function Documentation
◆ _fromRow()
| CitationDAO::_fromRow | ( | $row | ) |
Internal function to return a citation object from a row.
- Parameters
-
$row array
- Returns
- Citation
Definition at line 226 of file CitationDAO.inc.php.
References _newDataObject(), and DAO\getDataObjectSettings().
Referenced by getById().
◆ _newDataObject()
| CitationDAO::_newDataObject | ( | ) |
Construct a new citation object.
- Returns
- Citation
Definition at line 216 of file CitationDAO.inc.php.
Referenced by _fromRow().
◆ _updateObjectMetadata()
| CitationDAO::_updateObjectMetadata | ( | $citation | ) |
Update the citation meta-data
- Parameters
-
$citation Citation
Definition at line 242 of file CitationDAO.inc.php.
References DAO\updateDataObjectSettings().
Referenced by insertObject(), and updateObject().
◆ deleteById()
| CitationDAO::deleteById | ( | $citationId | ) |
Delete a citation by id.
- Parameters
-
$citationId int
- Returns
- boolean
Definition at line 175 of file CitationDAO.inc.php.
References DAO\update().
Referenced by deleteByPublicationId(), and deleteObject().
◆ deleteByPublicationId()
| CitationDAO::deleteByPublicationId | ( | $publicationId | ) |
Delete all citations matching a particular publication id.
- Parameters
-
$publicationId int
- Returns
- boolean
Definition at line 189 of file CitationDAO.inc.php.
References deleteById(), and getByPublicationId().
Referenced by importCitations().
◆ deleteObject()
| CitationDAO::deleteObject | ( | $citation | ) |
Delete a citation.
- Parameters
-
$citation Citation
- Returns
- boolean
Definition at line 166 of file CitationDAO.inc.php.
References deleteById().
◆ getAdditionalFieldNames()
| CitationDAO::getAdditionalFieldNames | ( | ) |
Get a list of additional fields that do not have dedicated accessors.
- Returns
- array
Reimplemented from DAO.
Definition at line 135 of file CitationDAO.inc.php.
◆ getById()
| CitationDAO::getById | ( | $citationId | ) |
Retrieve a citation by id.
- Parameters
-
$citationId integer
- Returns
- Citation
Definition at line 68 of file CitationDAO.inc.php.
References _fromRow(), and DAO\retrieve().
◆ getByPublicationId()
| CitationDAO::getByPublicationId | ( | $publicationId, | |
$rangeInfo = null |
|||
| ) |
Retrieve an array of citations matching a particular publication id.
- Parameters
-
$publicationId int $dbResultRange DBResultRange the desired range
- Returns
- DAOResultFactory containing matching Citations
Definition at line 118 of file CitationDAO.inc.php.
References DAO\retrieveRange().
Referenced by deleteByPublicationId().
◆ getInsertId()
| CitationDAO::getInsertId | ( | ) |
Get the id of the last inserted citation.
- Returns
- int
Definition at line 204 of file CitationDAO.inc.php.
Referenced by insertObject().
◆ importCitations()
| CitationDAO::importCitations | ( | $publicationId, | |
| $rawCitationList | |||
| ) |
Import citations from a raw citation list of the particular publication.
- Parameters
-
$publicationId int $rawCitationList string
Definition at line 87 of file CitationDAO.inc.php.
References deleteByPublicationId(), and insertObject().
◆ insertObject()
| CitationDAO::insertObject | ( | $citation | ) |
Insert a new citation.
- Parameters
-
$citation Citation
- Returns
- integer the new citation id
Definition at line 26 of file CitationDAO.inc.php.
References _updateObjectMetadata(), getInsertId(), DAO\retrieve(), and DAO\update().
Referenced by importCitations().
◆ updateObject()
| CitationDAO::updateObject | ( | $citation | ) |
Update an existing citation.
- Parameters
-
$citation Citation
Definition at line 144 of file CitationDAO.inc.php.
References _updateObjectMetadata(), and DAO\update().
The documentation for this class was generated from the following file:
