XoopsGroupHandler Class Reference

Inheritance diagram for XoopsGroupHandler:

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

Additional Inherited Members
Data Fields inherited from XoopsObjectHandler
	$db

Detailed Description

Definition at line 58 of file group.php.

Member Function Documentation

create()

& create

(

$isNew = true

)

create a new XoopsGroup object

Parameters

bool

$isNew

mark the new object as "new"?

Returns

object XoopsGroup reference to the new object

Definition at line 68 of file group.php.

delete()

delete

(

&

$group

)

remove a group from the database

Parameters

object

$group

reference to the group to be removed

Returns

bool FALSE if failed

Reimplemented from XoopsObjectHandler.

Definition at line 151 of file group.php.

get()

& get

(

$id

)

retrieve a specific group

Parameters

int

$id

ID of the group to get

Returns

object XoopsGroup reference to the group object, FALSE if failed

Reimplemented from XoopsObjectHandler.

Definition at line 86 of file group.php.

getObjects()

& getObjects	(		$criteria = null,
			$id_as_key = false )

retrieve groups from the database

Parameters

object	$criteria	CriteriaElement with conditions for the groups
bool	$id_as_key	should the groups' IDs be used as keys for the associative array?

Returns

mixed Array of groups

Definition at line 170 of file group.php.

insert()

insert

(

&

$group

)

insert a group into the database

Parameters

object

reference to the group object

Returns

mixed ID of the group if inserted, FALSE if failed, TRUE if already present and unchanged.

Reimplemented from XoopsObjectHandler.

Definition at line 110 of file group.php.

---

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

• html/kernel/group.php