Public Member Functions | |
| _fromRow ($row) | |
| deleteAssignment (&$userGroupAssignment) | |
| deleteAssignmentsByContextId ($contextId, $userId=null) | |
| deleteAssignmentsByUserGroupId ($userGroupId) | |
| deleteByUserId ($userId, $userGroupId=null) | |
| getByUserId ($userId, $contextId=null, $roleId=null) | |
| insertObject ($userGroupAssignment) | |
| newDataObject () | |
 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 user group assignments FIXME: Some of the context-specific features of this class will have to be changed for zero- or double-context applications when user groups are ported over to them.
- See also
- UserGroupAssigment
Definition at line 22 of file UserGroupAssignmentDAO.inc.php.
Member Function Documentation
◆ _fromRow()
| UserGroupAssignmentDAO::_fromRow | ( | $row | ) |
Internal function to return a UserGroupAssignment object from a row.
- Parameters
-
$row array
- Returns
- Role
Definition at line 37 of file UserGroupAssignmentDAO.inc.php.
References newDataObject().
◆ deleteAssignment()
| UserGroupAssignmentDAO::deleteAssignment | ( | & | $userGroupAssignment | ) |
Remove an assignment
- Parameters
-
$userGroupAssignment
Definition at line 141 of file UserGroupAssignmentDAO.inc.php.
References DAO\update().
◆ deleteAssignmentsByContextId()
| UserGroupAssignmentDAO::deleteAssignmentsByContextId | ( | $contextId, | |
$userId = null |
|||
| ) |
Remove all user group assignments in a given context
- Parameters
-
int $contextId int $userId
Definition at line 77 of file UserGroupAssignmentDAO.inc.php.
References deleteByUserId(), and DAO\retrieve().
◆ deleteAssignmentsByUserGroupId()
| UserGroupAssignmentDAO::deleteAssignmentsByUserGroupId | ( | $userGroupId | ) |
Remove all user group assignments for a given group
- Parameters
-
int $userGroupId
Definition at line 66 of file UserGroupAssignmentDAO.inc.php.
References DAO\update().
◆ deleteByUserId()
| UserGroupAssignmentDAO::deleteByUserId | ( | $userId, | |
$userGroupId = null |
|||
| ) |
Delete all user group assignments for a given userId
- Parameters
-
int $userId $userGroupId int optional
Definition at line 50 of file UserGroupAssignmentDAO.inc.php.
References DAO\update().
Referenced by deleteAssignmentsByContextId().
◆ getByUserId()
| UserGroupAssignmentDAO::getByUserId | ( | $userId, | |
$contextId = null, |
|||
$roleId = null |
|||
| ) |
Retrieve user group assignments for a user
- Parameters
-
$userId int $contextId int $roleId int
- Returns
- Iterator UserGroup
Definition at line 103 of file UserGroupAssignmentDAO.inc.php.
References DAO\retrieve().
◆ insertObject()
| UserGroupAssignmentDAO::insertObject | ( | $userGroupAssignment | ) |
Insert an assignment
- Parameters
-
$userId $groupId
Definition at line 126 of file UserGroupAssignmentDAO.inc.php.
References DAO\replace().
◆ newDataObject()
| UserGroupAssignmentDAO::newDataObject | ( | ) |
Create a new UserGroupAssignment object (allows extensibility)
Definition at line 28 of file UserGroupAssignmentDAO.inc.php.
Referenced by _fromRow().
The documentation for this class was generated from the following file:
