Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
EventLogDAO Class Reference
Inheritance diagram for EventLogDAO:
DAO ArticleEventLogDAO

Public Member Functions

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

See Also
EventLogEntry

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

Member Function Documentation

& EventLogDAO::build ( $row)

Internal function to return an EventLogEntry object from a row.

Parameters
$rowarray
Returns
EventLogEntry

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

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

Referenced by getById().

EventLogDAO::changeUser (   $oldUserId,
  $newUserId 
)

Transfer all log entries to another user.

Parameters
$oldUserIdint
$newUserIdint

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

References DAO\update().

EventLogDAO::deleteByAssoc (   $assocType,
  $assocId 
)

Delete all log entries for an object.

Parameters
$assocTypeint
$assocIdint

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

References deleteObject(), and getByAssoc().

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

Delete a single log entry (and associated settings).

Parameters
$logIdint

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

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

Referenced by deleteByAssoc().

EventLogDAO::EventLogDAO ( )

Constructor

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

& 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 66 of file EventLogDAO.inc.php.

References DAO\retrieveRange().

Referenced by deleteByAssoc().

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

Retrieve a log entry by ID.

Parameters
$logIdint
$assocIdint optional
$assocTypeint optional
Returns
EventLogEntry

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

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

EventLogDAO::getInsertLogId ( )

Get the ID of the last inserted log entry.

Returns
int

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

References DAO\getInsertId().

Referenced by insertObject().

EventLogDAO::insertObject ( $entry)

Insert a new log entry.

Parameters
$entryEventLogEntry

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

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

EventLogDAO::newDataObject ( )

Instantiate a new data object

Returns
object

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

Referenced by build().


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