Inheritance diagram for DepositPointDAO:

Public Member Functions
	__construct (SwordPlugin $parentPlugin)

	_fromRow ($row)

	deleteByContextId ($contextId)

	deleteById ($depositPointId, $contextId=null)

	deleteObject ($depositPoint)

	depositPointExists ($depositPointId, $contextId)

	getByContextId ($contextId, $rangeInfo=null, $type=null)

	getById ($depositPointId, $contextId=null)

	getInsertId ()

	getLocaleFieldNames ()

	insertObject ($depositPoint)

	newDataObject ()

	resequenceDepositPoints ($contextId)

	updateLocaleFields ($depositPoint)

	updateObject ($depositPoint)

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 ()

	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)

Protected Attributes
	$_plugin = null

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

Operations for retrieving and modifying DepositPoint objects.

Definition at line 16 of file DepositPointDAO.inc.php.

Constructor & Destructor Documentation

◆ __construct()

DepositPointDAO::__construct ( SwordPlugin $parentPlugin )

Constructor

Parameters

$parentPlugin SwordPlugin

Definition at line 27 of file DepositPointDAO.inc.php.

Member Function Documentation

◆ _fromRow()

DepositPointDAO::_fromRow ( $row )

Internal function to return DepositPoint object from a row.

Parameters

$row array

Returns: DepositPoint

Definition at line 69 of file DepositPointDAO.inc.php.

References DAO\getDataObjectSettings(), and newDataObject().

Referenced by getById().

◆ deleteByContextId()

DepositPointDAO::deleteByContextId ( $contextId )

Delete deposit point by context ID.

Parameters

$contextId int

Definition at line 219 of file DepositPointDAO.inc.php.

References deleteById(), and getByContextId().

◆ deleteById()

DepositPointDAO::deleteById	(	$depositPointId,
		$contextId = `null`
	)

Delete a deposit point by ID.

Parameters

$depositPointId	int
$contextId	int

Returns: boolean

Definition at line 204 of file DepositPointDAO.inc.php.

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

Referenced by deleteByContextId(), and deleteObject().

◆ deleteObject()

DepositPointDAO::deleteObject ( $depositPoint )

Delete a deposit point.

Parameters

$depositPoint DepositPoint

Returns: boolean

Definition at line 179 of file DepositPointDAO.inc.php.

References deleteById().

◆ depositPointExists()

DepositPointDAO::depositPointExists	(	$depositPointId,
		$contextId
	)

Check if a deposit point exists with the specified ID

Parameters

$depositPointId	int Deposit Point ID
$contextId	int Context ID

Definition at line 188 of file DepositPointDAO.inc.php.

References DAO\retrieve().

Referenced by deleteById().

◆ getByContextId()

DepositPointDAO::getByContextId	(	$contextId,
		$rangeInfo = `null`,
		$type = `null`
	)

Retrieve deposit points matching a particular context ID.

Parameters

$contextId	int
$rangeInfo	object DBRangeInfo object describing range of results to return
$type	int limit results to a specific type

Returns: object DAOResultFactory containing matching DepositPoints

Definition at line 234 of file DepositPointDAO.inc.php.

References DAO\retrieveRange().

Referenced by deleteByContextId().

◆ getById()

DepositPointDAO::getById	(	$depositPointId,
		$contextId = `null`
	)

Retrieve a deposit point by ID.

Parameters

$depositPointId	int
$contextId	int

Returns: DepositPoint

Definition at line 47 of file DepositPointDAO.inc.php.

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

◆ getInsertId()

DepositPointDAO::getInsertId ( )

Get the ID of the last inserted deposit point.

Returns: int

Definition at line 274 of file DepositPointDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

◆ getLocaleFieldNames()

DepositPointDAO::getLocaleFieldNames ( )

Get a list of fields for which localized data is supported

Returns: array

Reimplemented from DAO.

Definition at line 128 of file DepositPointDAO.inc.php.

◆ insertObject()

DepositPointDAO::insertObject ( $depositPoint )

Insert a new deposit point.

Parameters

$depositPoint DepositPoint

Returns: int

Definition at line 95 of file DepositPointDAO.inc.php.

References getInsertId(), DAO\update(), and updateLocaleFields().

◆ newDataObject()

DepositPointDAO::newDataObject ( )

Instantiate a new data object.

Returns: DepositPoint

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

Referenced by _fromRow().

◆ resequenceDepositPoints()

DepositPointDAO::resequenceDepositPoints ( $contextId )

Sequentially renumber deposit points in their sequence order.

Parameters

$contextId int

Definition at line 250 of file DepositPointDAO.inc.php.

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

◆ updateLocaleFields()

DepositPointDAO::updateLocaleFields ( $depositPoint )

Update the localized fields for this object.

Parameters

$depositPoint DepositPoint

Definition at line 136 of file DepositPointDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

◆ updateObject()

DepositPointDAO::updateObject ( $depositPoint )

Update an existing deposit point.

Parameters

$depositPoint DepositPoint

Returns: boolean

Definition at line 147 of file DepositPointDAO.inc.php.

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

Field Documentation

◆ $_plugin

SwordPlugin DepositPointDAO::$_plugin = null

protected

reference to SWORD plugin

Definition at line 21 of file DepositPointDAO.inc.php.

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

DepositPointDAO.inc.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _fromRow()

◆ deleteByContextId()

◆ deleteById()

◆ deleteObject()

◆ depositPointExists()

◆ getByContextId()

◆ getById()

◆ getInsertId()

◆ getLocaleFieldNames()

◆ insertObject()

◆ newDataObject()

◆ resequenceDepositPoints()

◆ updateLocaleFields()

◆ updateObject()

Field Documentation

◆ $_plugin