Public Member Functions | |
| _getByEventType ($assocType, $assocId, $eventType, $userId=null, $rangeInfo=null) | |
| _insertLogUserIds ($entry) | |
| & | build ($row) |
| changeUser ($oldUserId, $newUserId) | |
| deleteByAssoc ($assocType, $assocId) | |
| deleteObject ($logId, $assocType=null, $assocId=null) | |
| getByAssoc ($assocType=null, $assocId=null, $rangeInfo=null) | |
| getById ($logId, $assocType=null, $assocId=null) | |
| getInsertId () | |
| insertObject (&$entry) | |
 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
Class for inserting/accessing email log entries.
- See also
- EmailLogEntry, Log
Definition at line 20 of file EmailLogDAO.inc.php.
Member Function Documentation
◆ _getByEventType()
| EmailLogDAO::_getByEventType | ( | $assocType, | |
| $assocId, | |||
| $eventType, | |||
$userId = null, |
|||
$rangeInfo = null |
|||
| ) |
Retrieve a log entry by event type.
- Parameters
-
$assocType int $assocId int $eventType int $userId int optional $rangeInfo object optional
- Returns
- EmailLogEntry
Definition at line 60 of file EmailLogDAO.inc.php.
References DAO\retrieveRange().
◆ _insertLogUserIds()
| EmailLogDAO::_insertLogUserIds | ( | $entry | ) |
Stores the correspondent user ids of the all recipient emails.
- Parameters
-
$entry EmailLogEntry
Definition at line 218 of file EmailLogDAO.inc.php.
References DAORegistry\getDAO(), and DAO\replace().
Referenced by insertObject().
◆ build()
| & EmailLogDAO::build | ( | $row | ) |
Internal function to return an EmailLogEntry object from a row.
- Parameters
-
$row array
- Returns
- EmailLogEntry
Definition at line 108 of file EmailLogDAO.inc.php.
References HookRegistry\call(), and DAO\datetimeFromDB().
Referenced by getById().
◆ changeUser()
| EmailLogDAO::changeUser | ( | $oldUserId, | |
| $newUserId | |||
| ) |
Transfer all log entries to another user.
- Parameters
-
$oldUserId int $newUserId int
Definition at line 195 of file EmailLogDAO.inc.php.
References DAO\update().
◆ deleteByAssoc()
| EmailLogDAO::deleteByAssoc | ( | $assocType, | |
| $assocId | |||
| ) |
Delete all log entries for an object.
- Parameters
-
$assocType int @praam $assocId int
Definition at line 183 of file EmailLogDAO.inc.php.
References DAO\update().
◆ deleteObject()
| EmailLogDAO::deleteObject | ( | $logId, | |
$assocType = null, |
|||
$assocId = null |
|||
| ) |
Delete a single log entry for an object.
- Parameters
-
$logId int $assocType int optional $assocId int optional
Definition at line 165 of file EmailLogDAO.inc.php.
References DAO\update().
◆ getByAssoc()
| EmailLogDAO::getByAssoc | ( | $assocType = null, |
|
$assocId = null, |
|||
$rangeInfo = null |
|||
| ) |
Retrieve all log entries for an object matching the specified association.
- Parameters
-
$assocType int $assocId int $rangeInfo object optional
- Returns
- DAOResultFactory containing matching EventLogEntry ordered by sequence
Definition at line 89 of file EmailLogDAO.inc.php.
References DAO\retrieveRange().
Referenced by SubmissionEmailLogDAO\getBySubmissionId().
◆ getById()
| EmailLogDAO::getById | ( | $logId, | |
$assocType = null, |
|||
$assocId = null |
|||
| ) |
Retrieve a log entry by ID.
- Parameters
-
$logId int $assocType int optional $assocId int optional
- Returns
- EmailLogEntry
Definition at line 29 of file EmailLogDAO.inc.php.
References build(), and DAO\retrieve().
◆ getInsertId()
| EmailLogDAO::getInsertId | ( | ) |
Get the ID of the last inserted log entry.
- Returns
- int
Definition at line 206 of file EmailLogDAO.inc.php.
References DAO\_getInsertId().
Referenced by insertObject().
◆ insertObject()
| EmailLogDAO::insertObject | ( | & | $entry | ) |
Insert a new log entry.
- Parameters
-
$entry EmailLogEntry
Definition at line 132 of file EmailLogDAO.inc.php.
References _insertLogUserIds(), DAO\datetimeToDB(), getInsertId(), and DAO\update().
The documentation for this class was generated from the following file:
