Open Journal Systems  3.3.0
DataObjectTombstoneDAO Class Reference
Inheritance diagram for DataObjectTombstoneDAO:
DAO

Public Member Functions

 _fromRow ($row)
 
 _getSelectTombstoneSql ($assocType, $assocId)
 
 deleteByDataObjectId ($dataObjectId)
 
 deleteById ($tombstoneId, $assocType=null, $assocId=null)
 
 deleteOAISetObjects ($tombstoneId)
 
getByDataObjectId ($dataObjectId)
 
 getById ($tombstoneId, $assocType=null, $assocId=null)
 
 getInsertId ()
 
 getOAISetObjectsIds ($tombstoneId)
 
getSets ($assocType, $assocId)
 
 insertOAISetObjects ($dataObjectTombstone)
 
 insertObject (&$dataObjectTombstone)
 
 newDataObject ()
 
 updateOAISetObjects ($dataObjectTombstone)
 
 updateObject (&$dataObjectTombstone)
 
- 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

Base class for retrieving and modifying DataObjectTombstone objects.

See also
DataObjectTombstone

Definition at line 19 of file DataObjectTombstoneDAO.inc.php.

Member Function Documentation

◆ _fromRow()

DataObjectTombstoneDAO::_fromRow (   $row)

Creates and returns a data object tombstone object from a row.

Parameters
$rowarray
Returns
DataObjectTombstone object

Definition at line 75 of file DataObjectTombstoneDAO.inc.php.

References DAO\datetimeFromDB(), getOAISetObjectsIds(), and newDataObject().

Referenced by getByDataObjectId(), and getById().

◆ _getSelectTombstoneSql()

DataObjectTombstoneDAO::_getSelectTombstoneSql (   $assocType,
  $assocId 
)

Get the sql to select a tombstone from table, optionally using an OAI set object id.

Returns
string

Definition at line 301 of file DataObjectTombstoneDAO.inc.php.

Referenced by getById().

◆ deleteByDataObjectId()

DataObjectTombstoneDAO::deleteByDataObjectId (   $dataObjectId)

Delete DataObjectTombstone by data object id.

Parameters
$dataObjectIdint
Returns
boolean

Definition at line 123 of file DataObjectTombstoneDAO.inc.php.

References deleteById(), and getByDataObjectId().

◆ deleteById()

DataObjectTombstoneDAO::deleteById (   $tombstoneId,
  $assocType = null,
  $assocId = null 
)

Delete DataObjectTombstone by tombstone id.

Parameters
$tombstoneIdint
$assocTypeint
$assocIdint
Returns
boolean

Definition at line 97 of file DataObjectTombstoneDAO.inc.php.

References deleteOAISetObjects(), DAO\getAffectedRows(), getById(), DAORegistry\getDAO(), and DAO\update().

Referenced by deleteByDataObjectId().

◆ deleteOAISetObjects()

DataObjectTombstoneDAO::deleteOAISetObjects (   $tombstoneId)

Delete OAI set objects data from data_object_tombstone_oai_set_objects table.

Parameters
$tombstoneIdint The related tombstone id.

Definition at line 243 of file DataObjectTombstoneDAO.inc.php.

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

Referenced by deleteById().

◆ getByDataObjectId()

& DataObjectTombstoneDAO::getByDataObjectId (   $dataObjectId)

Retrieve DataObjectTombstone by data object id.

Parameters
$dataObjectIdint
Returns
DataObjectTombstone object

Definition at line 59 of file DataObjectTombstoneDAO.inc.php.

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

Referenced by deleteByDataObjectId().

◆ getById()

DataObjectTombstoneDAO::getById (   $tombstoneId,
  $assocType = null,
  $assocId = null 
)

Retrieve DataObjectTombstone by id.

Parameters
$tombstoneIdint
$assocTypeint
$assocIdint
Returns
DataObjectTombstone object

Definition at line 36 of file DataObjectTombstoneDAO.inc.php.

References _fromRow(), _getSelectTombstoneSql(), and DAO\retrieve().

Referenced by deleteById().

◆ getInsertId()

DataObjectTombstoneDAO::getInsertId ( )

Get the ID of the last inserted data object tombstone.

Returns
int

Definition at line 189 of file DataObjectTombstoneDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

◆ getOAISetObjectsIds()

DataObjectTombstoneDAO::getOAISetObjectsIds (   $tombstoneId)

Get all objects ids that are part of the passed tombstone OAI set.

Parameters
$tombstoneIdint
Returns
array assocType => assocId

Definition at line 224 of file DataObjectTombstoneDAO.inc.php.

References DAO\retrieve().

Referenced by _fromRow().

◆ getSets()

& DataObjectTombstoneDAO::getSets (   $assocType,
  $assocId 
)

Retrieve all sets for data object tombstones that are inside of the passed set object id.

Parameters
$assocTypeint The assoc type of the parent set object.
$assocIdint The id of the parent set object.
Returns
array('setSpec' => setName)

Definition at line 200 of file DataObjectTombstoneDAO.inc.php.

References DAO\retrieve().

◆ insertOAISetObjects()

DataObjectTombstoneDAO::insertOAISetObjects (   $dataObjectTombstone)

Insert OAI set objects data into data_object_tombstone_oai_set_objects table.

Parameters
$dataObjectTombstoneDataObjectTombstone

Definition at line 256 of file DataObjectTombstoneDAO.inc.php.

References DAO\update().

Referenced by insertObject().

◆ insertObject()

DataObjectTombstoneDAO::insertObject ( $dataObjectTombstone)

Inserts a new data object tombstone into data_object_tombstone table.

Parameters
$dataObjectTombstoneDataObjectTombstone
Returns
int Data object tombstone id.

Definition at line 133 of file DataObjectTombstoneDAO.inc.php.

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

◆ newDataObject()

DataObjectTombstoneDAO::newDataObject ( )

Return an instance of the DataObjectTombstone class.

Returns
DataObjectTombstone

Definition at line 25 of file DataObjectTombstoneDAO.inc.php.

Referenced by _fromRow().

◆ updateOAISetObjects()

DataObjectTombstoneDAO::updateOAISetObjects (   $dataObjectTombstone)

Update OAI set objects data into data_object_tombstone_oai_set_objects table.

Parameters
$dataObjectTombstoneDataObjectTombstone
Returns
boolean

Definition at line 276 of file DataObjectTombstoneDAO.inc.php.

References DAO\update().

Referenced by updateObject().

◆ updateObject()

DataObjectTombstoneDAO::updateObject ( $dataObjectTombstone)

Update a data object tombstone in the data_object_tombstones table.

Parameters
$dataObjectTombstoneDataObjectTombstone
Returns
int dataObjectTombstone id

Definition at line 160 of file DataObjectTombstoneDAO.inc.php.

References DAO\datetimeToDB(), DAO\update(), and updateOAISetObjects().


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