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

Public Member Functions

_returnGroupFromRow (&$row)
 
 deleteGroupById ($groupId)
 
 deleteGroupsByAssocId ($assocType, $assocId)
 
 deleteObject (&$group)
 
getById ($groupId, $assocType=null, $assocId=null)
 
getGroups ($assocType, $assocId, $context=null, $rangeInfo=null)
 
 getInsertGroupId ()
 
 getLocaleFieldNames ()
 
 GroupDAO ()
 
 insertGroup (&$group)
 
 newDataObject ()
 
 resequenceGroups ($assocType=null, $assocId=null)
 
 updateLocaleFields (&$group)
 
 updateObject (&$group)
 
- 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 objects.

See Also
Group

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

Member Function Documentation

& GroupDAO::_returnGroupFromRow ( $row)

Internal function to return a Group object from a row.

Parameters
$rowarray
Returns
Group

Definition at line 102 of file GroupDAO.inc.php.

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

Referenced by getById().

GroupDAO::deleteGroupById (   $groupId)

Delete a board group, including membership info

Parameters
$groupIdint

Definition at line 203 of file GroupDAO.inc.php.

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

Referenced by deleteObject().

GroupDAO::deleteGroupsByAssocId (   $assocType,
  $assocId 
)

Delete board groups by assoc ID, including membership info

Parameters
$assocTypeint
$assocIdint

Definition at line 215 of file GroupDAO.inc.php.

References deleteObject(), and getGroups().

GroupDAO::deleteObject ( $group)

Delete a board group, including membership info

Parameters
$groupGroup

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

References deleteGroupById().

Referenced by deleteGroupsByAssocId().

& GroupDAO::getById (   $groupId,
  $assocType = null,
  $assocId = null 
)

Retrieve a group by ID.

Parameters
$groupIdint
$assocTypeint optional
$assocIdint optional
Returns
Group

Definition at line 35 of file GroupDAO.inc.php.

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

& GroupDAO::getGroups (   $assocType,
  $assocId,
  $context = null,
  $rangeInfo = null 
)

Get all groups for a given context.

Parameters
$assocTypeint
$assocIdint
$contextint (optional)
$rangeInfoobject RangeInfo object (optional)
Returns
array

Definition at line 68 of file GroupDAO.inc.php.

References DAO\retrieveRange().

Referenced by deleteGroupsByAssocId().

GroupDAO::getInsertGroupId ( )

Get the ID of the last inserted board group.

Returns
int

Definition at line 259 of file GroupDAO.inc.php.

References DAO\getInsertId().

Referenced by insertGroup().

GroupDAO::getLocaleFieldNames ( )

Get the list of fields for which locale data is stored.

Returns
array

Definition at line 85 of file GroupDAO.inc.php.

GroupDAO::GroupDAO ( )

Constructor

Definition at line 24 of file GroupDAO.inc.php.

GroupDAO::insertGroup ( $group)

Insert a new board group.

Parameters
$groupGroup

Definition at line 132 of file GroupDAO.inc.php.

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

GroupDAO::newDataObject ( )

Instantiate a new DataObject.

Returns
PKPGroup

Definition at line 93 of file GroupDAO.inc.php.

Referenced by _returnGroupFromRow().

GroupDAO::resequenceGroups (   $assocType = null,
  $assocId = null 
)

Sequentially renumber board groups in their sequence order, optionally by assoc info.

Parameters
$assocTypeint
$assocIdint

Definition at line 228 of file GroupDAO.inc.php.

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

GroupDAO::updateLocaleFields ( $group)

Update the settings for this object

Parameters
$groupobject

Definition at line 122 of file GroupDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertGroup(), and updateObject().

GroupDAO::updateObject ( $group)

Update an existing board group.

Parameters
$groupGroup

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

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


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