In_Support_Group Class Reference

Handles the linkage of users being in a support group. More...

Public Member Functions
	__construct ()
	A constructor.
	set ($values)
	sets the object's attributes.
	create ()
	creates a new 'in_support_group' entry.
	delete ()
	deletes an existing 'in_support_group' entry.
	getUser ()
	get user attribute of the object.
	getGroup ()
	get group attribute of the object.
	setUser ($u)
	set user attribute of the object.
	setGroup ($g)
	set group attribute of the object.
Static Public Member Functions
static	userExistsInSGroup ($user_id, $group_id)
	Check if user is in in_support_group.
Private Attributes
	$user
	The id of the user being in a support group.
	$group
	The id of the support group.

---

Detailed Description

Handles the linkage of users being in a support group.

Moderators and Admins can be part of a support group, this class offers functionality to check if a link between a user and group is existing.

Author:

Daan Janssens, mentored by Matthew Lagoe

---

Constructor & Destructor Documentation

__construct

(

)

A constructor.

Empty constructor

---

Member Function Documentation

create

(

)

creates a new 'in_support_group' entry.

this method will use the object's attributes for creating a new 'in_support_group' entry in the database.

delete

(

)

deletes an existing 'in_support_group' entry.

this method will use the object's attributes for deleting an existing 'in_support_group' entry in the database.

getGroup

(

)

get group attribute of the object.

getUser

(

)

get user attribute of the object.

set

(

$

values

)

sets the object's attributes.

Parameters:

$values

should be an array of the form array('User' => user_id, 'Group' => support_groups_id).

setGroup

(

$

g

)

set group attribute of the object.

Parameters:

$g	integer id of the support group

setUser

(

$

u

)

set user attribute of the object.

Parameters:

$u	integer id of the user

static userExistsInSGroup	(	$	user_id,
		$	group_id
	)		[static]

Check if user is in in_support_group.

Parameters:

$user_id	the id of the user.
$group_id	the id of the support group.

Returns:

true is returned in case the user is in the support group, else false is returned.

---

Field Documentation

$group [private]

The id of the support group.

$user [private]

The id of the user being in a support group.

---

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

• /home/daan/ryzom/ryzomcore/code/ryzom/tools/server/ryzom_ams/ams_lib/autoload/in_support_group.php