Inheritance diagram for QueryDAO:

Public Member Functions
	_fromRow ($row)

	deleteByAssoc ($assocType, $assocId)

	deleteById ($queryId, $assocType=null, $assocId=null)

	deleteObject ($query)

	getByAssoc ($assocType, $assocId, $stageId=null, $userId=null)

	getById ($queryId, $assocType=null, $assocId=null)

	getInsertId ()

	getParticipantIds ($queryId, $userId=null)

	insertObject ($query)

	insertParticipant ($queryId, $userId)

	newDataObject ()

	removeAllParticipants ($queryId)

	removeParticipant ($queryId, $userId)

	resequence ($assocType, $assocId)

	updateObject ($query)

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

Operations for retrieving and modifying Query objects.

See also: Query

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

Member Function Documentation

◆ _fromRow()

QueryDAO::_fromRow ( $row )

Internal function to return a submission query object from a row.

Parameters

$row array

Returns: Query

Definition at line 92 of file QueryDAO.inc.php.

References HookRegistry\call(), and newDataObject().

Referenced by getById().

◆ deleteByAssoc()

QueryDAO::deleteByAssoc	(	$assocType,
		$assocId
	)

Delete queries by assoc info.

Parameters

$assocType	int ASSOC_TYPE_...
$assocId	int Assoc ID per assocType

Definition at line 306 of file QueryDAO.inc.php.

References deleteObject(), and getByAssoc().

◆ deleteById()

QueryDAO::deleteById	(	$queryId,
		$assocType = `null`,
		$assocId = `null`
	)

Delete a submission query by ID.

Parameters

$queryId	int Query ID
$assocType	int Optional ASSOC_TYPE_...
$assocId	int Optional assoc ID per assocType

Definition at line 239 of file QueryDAO.inc.php.

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

Referenced by deleteObject().

◆ deleteObject()

QueryDAO::deleteObject ( $query )

Delete a submission query.

Parameters

$query Query

Definition at line 229 of file QueryDAO.inc.php.

References deleteById().

Referenced by deleteByAssoc().

◆ getByAssoc()

QueryDAO::getByAssoc	(	$assocType,
		$assocId,
		$stageId = `null`,
		$userId = `null`
	)

Retrieve all queries by association

Parameters

$assocType	int ASSOC_TYPE_...
$assocId	int Assoc ID
$stageId	int Optional stage ID
$userId	int Optional user ID; when set, show only assigned queries

Returns: array Query

Definition at line 60 of file QueryDAO.inc.php.

References DAO\retrieve().

Referenced by deleteByAssoc().

◆ getById()

QueryDAO::getById	(	$queryId,
		$assocType = `null`,
		$assocId = `null`
	)

Retrieve a submission query by ID.

Parameters

$queryId	int Query ID
$assocType	int Optional ASSOC_TYPE_...
$assocId	int Optional assoc ID per assocType

Returns: Query

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

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

◆ getInsertId()

QueryDAO::getInsertId ( )

Get the ID of the last inserted submission query.

Returns: int

Definition at line 297 of file QueryDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

◆ getParticipantIds()

QueryDAO::getParticipantIds	(	$queryId,
		$userId = `null`
	)

Retrieve all participant user IDs for a query.

Parameters

$queryId	int Query ID
$userId	int User ID to restrict results to

Returns: array

Definition at line 181 of file QueryDAO.inc.php.

References DAO\retrieve().

◆ insertObject()

QueryDAO::insertObject ( $query )

Insert a new Query.

Parameters

$query Query

Returns: int New query ID

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

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

◆ insertParticipant()

QueryDAO::insertParticipant	(	$queryId,
		$userId
	)

Adds a participant to a query.

Parameters

$queryId	int Query ID
$userId	int User ID

Definition at line 139 of file QueryDAO.inc.php.

References DAO\update().

◆ newDataObject()

QueryDAO::newDataObject ( )

Get a new data object

Returns: DataObject

Definition at line 109 of file QueryDAO.inc.php.

Referenced by _fromRow().

◆ removeAllParticipants()

QueryDAO::removeAllParticipants ( $queryId )

Removes all participants from a query.

Parameters

$queryId int Query ID

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

References DAO\update().

◆ removeParticipant()

QueryDAO::removeParticipant	(	$queryId,
		$userId
	)

Removes a participant from a query.

Parameters

$queryId	int Query ID
$userId	int User ID

Definition at line 157 of file QueryDAO.inc.php.

References DAO\update().

◆ resequence()

QueryDAO::resequence	(	$assocType,
		$assocId
	)

Sequentially renumber queries in their sequence order.

Parameters

$assocType	int ASSOC_TYPE_...
$assocId	int Assoc ID per assocType

Definition at line 272 of file QueryDAO.inc.php.

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

◆ updateObject()

QueryDAO::updateObject ( $query )

Update an existing Query.

Parameters

$query Query

Definition at line 205 of file QueryDAO.inc.php.

References DAO\update().

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

QueryDAO.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _fromRow()

◆ deleteByAssoc()

◆ deleteById()

◆ deleteObject()

◆ getByAssoc()

◆ getById()

◆ getInsertId()

◆ getParticipantIds()

◆ insertObject()

◆ insertParticipant()

◆ newDataObject()

◆ removeAllParticipants()

◆ removeParticipant()

◆ resequence()

◆ updateObject()