XoopsMembershipHandler Class Reference

Inheritance diagram for XoopsMembershipHandler:

Public Member Functions
&	create ($isNew=true)
&	get ($id)
	insert (&$mship)
	delete (&$mship)
&	getObjects ($criteria=null, $id_as_key=false)
	getCount ($criteria=null)
	deleteAll ($criteria=null)
&	getGroupsByUser ($uid)
&	getUsersByGroup ($groupid, $limit=0, $start=0)
&	getUsersByNoGroup ($groupid, $limit=0, $start=0)
Public Member Functions inherited from XoopsObjectHandler
	__construct (&$db)
&	create ()

Additional Inherited Members
Data Fields inherited from XoopsObjectHandler
	$db

Detailed Description

Definition at line 231 of file group.php.

Member Function Documentation

create()

& create

(

$isNew = true

)

create a new membership

Parameters

bool

$isNew

should the new object be set to "new"?

Returns

object XoopsMembership

Definition at line 240 of file group.php.

delete()

delete

(

&

$mship

)

delete a membership from the database

Parameters

object

$mship

reference to the membership object

Returns

bool FALSE if failed

Reimplemented from XoopsObjectHandler.

Definition at line 319 of file group.php.

deleteAll()

deleteAll

(

$criteria = null

)

delete all memberships meeting the conditions

Parameters

object

$criteria

CriteriaElement with conditions to meet

Returns

bool

Definition at line 394 of file group.php.

get()

& get

(

$id

)

retrieve a membership

Parameters

int

$id

ID of the membership to get

Returns

mixed reference to the object if successful, else FALSE

Reimplemented from XoopsObjectHandler.

Definition at line 255 of file group.php.

getCount()

getCount

(

$criteria = null

)

count how many memberships meet the conditions

Parameters

object

$criteria

CriteriaElement conditions to meet

Returns

int

Definition at line 373 of file group.php.

getGroupsByUser()

& getGroupsByUser

(

$uid

)

retrieve groups for a user

Parameters

int

$uid

ID of the user

Returns

array array of groups the user belongs to

Definition at line 412 of file group.php.

getObjects()

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

retrieve memberships from the database

Parameters

object	$criteria	CriteriaElement conditions to meet
bool	$id_as_key	should the ID be used as the array's key?

Returns

array array of references

Definition at line 339 of file group.php.

getUsersByGroup()

& getUsersByGroup	(		$groupid,
			$limit = 0,
			$start = 0 )

retrieve users belonging to a group

Parameters

int	$groupid	ID of the group
int	$limit	number of entries to return
int	$start	offset of first entry to return

Returns

array array of users belonging to the group

Definition at line 435 of file group.php.

getUsersByNoGroup()

& getUsersByNoGroup	(		$groupid,
			$limit = 0,
			$start = 0 )

Parameters

	$groupid
int	$limit
int	$start

Returns

array

See also

getUsersByGroup

Definition at line 458 of file group.php.

insert()

insert

(

&

$mship

)

inserts a membership in the database

Parameters

object

$mship

reference to the membership object

Returns

bool TRUE if already in DB or successful, FALSE if failed

Reimplemented from XoopsObjectHandler.

Definition at line 279 of file group.php.

---

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

• html/kernel/group.php