XoopsGroupHandler Class Reference

Inheritance diagram for XoopsGroupHandler:

Collaboration diagram for XoopsGroupHandler:

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

Data Fields
	$table
Data Fields inherited from XoopsObjectHandler
	$db

Constructor & Destructor Documentation

__construct()

__construct

(

XoopsDatabase

$db

)

called from child classes only

Parameters

XoopsDatabase

$db

reference to the XoopsDatabase object @access protected

Reimplemented from XoopsObjectHandler.

Member Function Documentation

create()

create

(

$isNew = true

)

create a new XoopsGroup object

Parameters

bool

$isNew

mark the new object as "new"?

Returns

XoopsGroup XoopsGroup reference to the new object

delete()

delete

(

XoopsObject

$group

)

remove a group from the database

Parameters

XoopsObject | XoopsGroup

$group

a group object

Returns

bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

get()

get

(

$id

)

retrieve a specific group

Parameters

int

$id

ID of the group to get

Returns

XoopsGroup XoopsGroup reference to the group object, FALSE if failed

Reimplemented from XoopsObjectHandler.

getObjects()

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

retrieve groups from the database

Parameters

CriteriaElement | CriteriaCompo	$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

insert()

insert

(

XoopsObject

$group

)

insert a group into the database

Parameters

XoopsObject | XoopsGroup

$group

a group object

Returns

bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

Here is the call graph for this function:

Field Documentation

$table

$table

---

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

• C:/xoops2511b2/htdocs/kernel/group.php