Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
GroupMembershipDAO Class Reference
Inheritance diagram for GroupMembershipDAO:
DAO

Public Member Functions

_returnMembershipFromRow (&$row)
 
 deleteMembershipByGroupId ($groupId)
 
 deleteMembershipById ($groupId, $userId)
 
 deleteMembershipByUserId ($userId)
 
 deleteObject (&$membership)
 
getMembership ($groupId, $userId)
 
getMemberships ($groupId, $rangeInfo=null)
 
 GroupMembershipDAO ()
 
 insertMembership (&$membership)
 
 newDataObject ()
 
 resequenceMemberships ($groupId)
 
 updateObject (&$membership)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($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

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and modifying group membership info.

See Also
GroupMembership, Group

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

Member Function Documentation

& GroupMembershipDAO::_returnMembershipFromRow ( $row)

Internal function to return a GroupMembership object from a row.

Parameters
$rowarray
Returns
GroupMembership

Definition at line 81 of file GroupMembershipDAO.inc.php.

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

Referenced by getMembership().

GroupMembershipDAO::deleteMembershipByGroupId (   $groupId)

Delete group membership by group ID

Parameters
$groupIdint

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

References DAO\update().

GroupMembershipDAO::deleteMembershipById (   $groupId,
  $userId 
)

Delete a membership

Parameters
$groupIdint
$userIdint

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

References DAO\update().

Referenced by deleteObject().

GroupMembershipDAO::deleteMembershipByUserId (   $userId)

Delete group membership by user ID

Parameters
$userIdint

Definition at line 190 of file GroupMembershipDAO.inc.php.

References DAO\update().

GroupMembershipDAO::deleteObject ( $membership)

Delete a membership

Parameters
$membershipGroupMembership

Definition at line 154 of file GroupMembershipDAO.inc.php.

References deleteMembershipById().

& GroupMembershipDAO::getMembership (   $groupId,
  $userId 
)

Retrieve a membership by ID.

Parameters
$groupIdint
$userIdint
Returns
GroupMembership

Definition at line 37 of file GroupMembershipDAO.inc.php.

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

& GroupMembershipDAO::getMemberships (   $groupId,
  $rangeInfo = null 
)

Retrieve memberships by group ID.

Parameters
$groupIdint
Returns
ItemIterator

Definition at line 57 of file GroupMembershipDAO.inc.php.

References DAO\retrieveRange().

GroupMembershipDAO::GroupMembershipDAO ( )

Constructor.

Definition at line 26 of file GroupMembershipDAO.inc.php.

References DAORegistry\getDAO().

GroupMembershipDAO::insertMembership ( $membership)

Insert a new group membership.

Parameters
$membershipGroupMembership

Definition at line 108 of file GroupMembershipDAO.inc.php.

References DAO\update().

GroupMembershipDAO::newDataObject ( )

Instantiate a new data object.

Returns
GroupMembership

Definition at line 72 of file GroupMembershipDAO.inc.php.

Referenced by _returnMembershipFromRow().

GroupMembershipDAO::resequenceMemberships (   $groupId)

Sequentially renumber group members in their sequence order.

Parameters
$groupIdint

Definition at line 201 of file GroupMembershipDAO.inc.php.

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

GroupMembershipDAO::updateObject ( $membership)

Update an existing group membership.

Parameters
$membershipGroupMembership

Definition at line 127 of file GroupMembershipDAO.inc.php.

References DAO\update().


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