Open Journal Systems  3.3.0
EventLogDAO Class Reference
Inheritance diagram for EventLogDAO:
DAO SubmissionEventLogDAO SubmissionFileEventLogDAO

Public Member Functions

 build ($row)
 
 changeUser ($oldUserId, $newUserId)
 
 deleteByAssoc ($assocType, $assocId)
 
 deleteById ($logId, $assocType=null, $assocId=null)
 
 getByAssoc ($assocType, $assocId, $rangeInfo=null)
 
 getById ($logId, $assocType=null, $assocId=null)
 
 getInsertId ()
 
 insertObject ($entry)
 
 newDataObject ()
 
- 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 event log entries.

See also
EventLogEntry

Definition at line 20 of file EventLogDAO.inc.php.

Member Function Documentation

◆ build()

EventLogDAO::build (   $row)

Internal function to return an EventLogEntry object from a row.

Parameters
$rowarray
Returns
EventLogEntry

Definition at line 81 of file EventLogDAO.inc.php.

References HookRegistry\call(), DAO\convertFromDB(), DAO\datetimeFromDB(), newDataObject(), and DAO\retrieve().

Referenced by getById().

◆ changeUser()

EventLogDAO::changeUser (   $oldUserId,
  $newUserId 
)

Transfer all log entries to another user.

Parameters
$oldUserIdint
$newUserIdint

Definition at line 185 of file EventLogDAO.inc.php.

References DAO\update().

◆ deleteByAssoc()

EventLogDAO::deleteByAssoc (   $assocType,
  $assocId 
)

Delete all log entries for an object.

Parameters
$assocTypeint
$assocIdint

Definition at line 173 of file EventLogDAO.inc.php.

References deleteById(), and getByAssoc().

◆ deleteById()

EventLogDAO::deleteById (   $logId,
  $assocType = null,
  $assocId = null 
)

Delete a single log entry (and associated settings).

Parameters
$logIdint

Definition at line 154 of file EventLogDAO.inc.php.

References DAO\getAffectedRows(), and DAO\update().

Referenced by deleteByAssoc().

◆ getByAssoc()

EventLogDAO::getByAssoc (   $assocType,
  $assocId,
  $rangeInfo = null 
)

Retrieve all log entries matching the specified association.

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

Definition at line 58 of file EventLogDAO.inc.php.

References DAO\retrieveRange().

Referenced by deleteByAssoc(), SubmissionFileEventLogDAO\getByFileId(), and SubmissionEventLogDAO\getBySubmissionId().

◆ getById()

EventLogDAO::getById (   $logId,
  $assocType = null,
  $assocId = null 
)

Retrieve a log entry by ID.

Parameters
$logIdint
$assocIdint optional
$assocTypeint optional
Returns
EventLogEntry

Definition at line 29 of file EventLogDAO.inc.php.

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

◆ getInsertId()

EventLogDAO::getInsertId ( )

Get the ID of the last inserted log entry.

Returns
int

Definition at line 196 of file EventLogDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

◆ insertObject()

EventLogDAO::insertObject (   $entry)

Insert a new log entry.

Parameters
$entryEventLogEntry

Definition at line 114 of file EventLogDAO.inc.php.

References DAO\convertToDB(), DAO\datetimeToDB(), getInsertId(), and DAO\update().

◆ newDataObject()

EventLogDAO::newDataObject ( )

Instantiate a new data object

Returns
object

Reimplemented in SubmissionEventLogDAO, and SubmissionFileEventLogDAO.

Definition at line 72 of file EventLogDAO.inc.php.

Referenced by build().


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