OMVUserGroup Class Reference

Inheritance diagram for OMVUserGroup:

Public Member Functions
	__construct ($id)
	refresh ()
	exists ()
	getName ()
	getGid ()
	getMembers ()
	getQuotas ()
Public Member Functions inherited from OMVObject
	__construct ()
	getLastError ()

Protected Attributes
	$name = null
	$gid = null
	$members = null

Additional Inherited Members
Protected Member Functions inherited from OMVObject
	setLastError ($error)
	debug ()

Detailed Description

This class provides a simple interface to handle a system group.

Constructor & Destructor Documentation

OMVUserGroup::__construct

(

$id

)

Constructor

Parameters

id	The name or GID of the system group.

Member Function Documentation

OMVUserGroup::exists

(

)

Check whether the system group exists.

Returns

TRUE if the system group exists, otherwise FALSE.

OMVUserGroup::getGid

(

)

Get the group ID.

Returns

The group ID, otherwise FALSE.

OMVUserGroup::getMembers

(

)

Get the user names who are member of this group.

Returns

An array of user names that are member of this group, otherwise FALSE.

OMVUserGroup::getName

(

)

Get the group name.

Returns

The group name.

OMVUserGroup::getQuotas

(

)

Get the group quotas.

Returns

An array containing the quotas.

OMVUserGroup::refresh

(

)

Refresh the cached information.

Returns

TRUE if successful, otherwise FALSE.

---

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

• system.inc