XOOPS 2.5.6  Final
 All Classes Namespaces Files Functions Variables Pages
XoopsGroupHandler Class Reference
Inheritance diagram for XoopsGroupHandler:
Inheritance graph

Public Member Functions

create ($isNew=true)
 
 delete (&$group)
 
get ($id)
 
 getObjects ($criteria=null, $id_as_key=false)
 
 insert (&$group)
 
- Public Member Functions inherited from XoopsObjectHandler
create ()
 
 delete (&$object)
 
get ($int_id)
 
 insert (&$object)
 
 XoopsObjectHandler (&$db)
 

Additional Inherited Members

- Public Attributes inherited from XoopsObjectHandler
 $db
 

Detailed Description

Definition at line 94 of file group.php.

Member Function Documentation

& XoopsGroupHandler::create (   $isNew = true)

create a new XoopsGroup object

Parameters
bool$isNewmark the new object as "new"?
Returns
object XoopsGroup reference to the new object

Definition at line 103 of file group.php.

XoopsGroupHandler::delete ( $group)

remove a group from the database

Parameters
object$groupreference to the group to be removed
Returns
bool FALSE if failed

: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5

Definition at line 181 of file group.php.

References $result, and $sql.

& XoopsGroupHandler::get (   $id)

retrieve a specific group

Parameters
int$idID of the group to get
Returns
object XoopsGroup reference to the group object, FALSE if failed

Definition at line 118 of file group.php.

References $result, and $sql.

XoopsGroupHandler::getObjects (   $criteria = null,
  $id_as_key = false 
)

retrieve groups from the database

Parameters
object$criteriaCriteriaElement with conditions for the groups
bool$id_as_keyshould the groups' IDs be used as keys for the associative array?
Returns
mixed Array of groups

Definition at line 203 of file group.php.

References $criteria, $limit, $result, $ret, $sql, and $start.

XoopsGroupHandler::insert ( $group)

insert a group into the database

Parameters
objectreference to the group object
Returns
mixed ID of the group if inserted, FALSE if failed, TRUE if already present and unchanged.

: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5

Definition at line 142 of file group.php.

References $result, and $sql.


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