SubEditorsDAO Class Reference

Inheritance diagram for SubEditorsDAO:

Public Member Functions
	deleteBySubmissionGroupId ($assocId, $assocType, $contextId=null)
	deleteByUserId ($userId, $contextId=null, $assocId=null, $assocType=null)
	deleteEditor ($contextId, $assocId, $userId, $assocType)
	editorExists ($contextId, $assocId, $userId, $assocType)
	getBySubmissionGroupId ($assocId, $assocType, $contextId)
	insertEditor ($contextId, $assocId, $userId, $assocType)
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 associating sections, series and categories to sub editors.

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

Member Function Documentation

deleteBySubmissionGroupId()

SubEditorsDAO::deleteBySubmissionGroupId	(		$assocId,
			$assocType,
			$contextId = null
	)

Delete all sub editors for a specified submission group in a context.

Parameters

$assocId	int
$assocType	int ASSOC_TYPE_SECTION or ASSOC_TYPE_CATEGORY
$contextId	int

Definition at line 100 of file SubEditorsDAO.inc.php.

References DAO\update().

deleteByUserId()

SubEditorsDAO::deleteByUserId	(		$userId,
			$contextId = null,
			$assocId = null,
			$assocType = null
	)

Delete all submission group assignments for the specified user.

Parameters

$userId	int
$contextId	int optional, include assignments only in this context
$assocId	int optional, include only this submission group
$assocType	int optional ASSOC_TYPE_SECTION or ASSOC_TYPE_CATEGORY

Definition at line 117 of file SubEditorsDAO.inc.php.

References DAO\update().

deleteEditor()

SubEditorsDAO::deleteEditor	(		$contextId,
			$assocId,
			$userId,
			$assocType
	)

Delete a sub editor.

Parameters

$contextId	int
$assocId	int
$userId	int
$assocType	int ASSOC_TYPE_SECTION or ASSOC_TYPE_CATEGORY

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

References DAO\update().

editorExists()

SubEditorsDAO::editorExists	(		$contextId,
			$assocId,
			$userId,
			$assocType
	)

Check if a user is assigned to a specified submission group.

Parameters

$contextId	int
$assocId	int
$userId	int
$assocType	int optional ASSOC_TYPE_SECTION or ASSOC_TYPE_CATEGORY

Returns

boolean

Definition at line 140 of file SubEditorsDAO.inc.php.

References DAO\retrieve().

getBySubmissionGroupId()

SubEditorsDAO::getBySubmissionGroupId	(		$assocId,
			$assocType,
			$contextId
	)

Retrieve a list of all sub editors assigned to the specified submission group.

Parameters

$assocId	int
$assocType	int ASSOC_TYPE_SECTION or ASSOC_TYPE_CATEGORY
$contextId	int

Returns

array matching Users

Definition at line 66 of file SubEditorsDAO.inc.php.

References DAORegistry\getDAO(), and DAO\retrieve().

insertEditor()

SubEditorsDAO::insertEditor	(		$contextId,
			$assocId,
			$userId,
			$assocType
	)

Insert a new sub editor.

Parameters

$contextId	int
$assocId	int
$userId	int
$userType	int ASSOC_TYPE_SECTION or ASSOC_TYPE_CATEGORY

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

References DAO\update().

---

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

• SubEditorsDAO.inc.php