Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
EmailLogDAO Class Reference
Inheritance diagram for EmailLogDAO:
DAO ArticleEmailLogDAO

Public Member Functions

 _insertLogUserIds ($entry)
 
build (&$row)
 
 changeUser ($oldUserId, $newUserId)
 
 deleteByAssoc ($assocType, $assocId)
 
 deleteObject ($logId, $assocType=null, $assocId=null)
 
 EmailLogDAO ()
 
getByAssoc ($assocType=null, $assocId=null, $rangeInfo=null)
 
getByEventType ($assocType, $assocId, $eventType, $userId=null, $rangeInfo=null)
 
getById ($logId, $assocType=null, $assocId=null)
 
 getInsertLogId ()
 
 insertObject (&$entry)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($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

- Public Attributes inherited from DAO
 $_dataSource
 

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

EmailLogDAO::_insertLogUserIds (   $entry)

Stores the correspondent user ids of the all recipient emails.

Parameters
$entryEmailLogEntry

Definition at line 230 of file EmailLogDAO.inc.php.

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

Referenced by insertObject().

& EmailLogDAO::build ( $row)

Internal function to return an EmailLogEntry object from a row.

Parameters
$rowarray
Returns
EmailLogEntry

Definition at line 118 of file EmailLogDAO.inc.php.

References HookRegistry\call(), and DAO\datetimeFromDB().

Referenced by getById().

EmailLogDAO::changeUser (   $oldUserId,
  $newUserId 
)

Transfer all log entries to another user.

Parameters
$oldUserIdint
$newUserIdint

Definition at line 207 of file EmailLogDAO.inc.php.

References DAO\update().

EmailLogDAO::deleteByAssoc (   $assocType,
  $assocId 
)

Delete all log entries for an object.

Parameters
$assocTypeint $assocId int

Definition at line 195 of file EmailLogDAO.inc.php.

References DAO\update().

EmailLogDAO::deleteObject (   $logId,
  $assocType = null,
  $assocId = null 
)

Delete a single log entry for an object.

Parameters
$logIdint
$assocTypeint optional
$assocIdint optional

Definition at line 177 of file EmailLogDAO.inc.php.

References DAO\update().

EmailLogDAO::EmailLogDAO ( )

Constructor

Definition at line 24 of file EmailLogDAO.inc.php.

& EmailLogDAO::getByAssoc (   $assocType = null,
  $assocId = null,
  $rangeInfo = null 
)

Retrieve all log entries for an object matching the specified association.

Parameters
$assocTypeint
$assocIdint
$rangeInfoobject optional
Returns
DAOResultFactory containing matching EventLogEntry ordered by sequence

Definition at line 98 of file EmailLogDAO.inc.php.

References DAO\retrieveRange().

& EmailLogDAO::getByEventType (   $assocType,
  $assocId,
  $eventType,
  $userId = null,
  $rangeInfo = null 
)

Retrieve a log entry by event type.

Parameters
$assocTypeint
$assocIdint
$eventTypeint
$userIdint optional
$rangeInfoobject optional
Returns
EmailLogEntry

Definition at line 68 of file EmailLogDAO.inc.php.

References DAO\retrieveRange().

& EmailLogDAO::getById (   $logId,
  $assocType = null,
  $assocId = null 
)

Retrieve a log entry by ID.

Parameters
$logIdint
$assocTypeint optional
$assocIdint optional
Returns
EmailLogEntry

Definition at line 35 of file EmailLogDAO.inc.php.

References build(), and DAO\retrieve().

EmailLogDAO::getInsertLogId ( )

Get the ID of the last inserted log entry.

Returns
int

Definition at line 218 of file EmailLogDAO.inc.php.

References DAO\getInsertId().

Referenced by insertObject().

EmailLogDAO::insertObject ( $entry)

Insert a new log entry.

Parameters
$entryEmailLogEntry

Definition at line 143 of file EmailLogDAO.inc.php.

References _insertLogUserIds(), DAO\datetimeToDB(), getInsertLogId(), and DAO\update().


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