OMV\System\Group Class Reference

Public Member Functions
	__construct ($id)
	refresh ()
	exists ()
	assertExists ()
	assertNotExists ()
	getName ()
	getGid ()
	getMembers ()
	getQuotas ()
	isSystemAccount ()

Static Public Member Functions
static	getGroups ()

Protected Attributes
	$name = NULL
	$gid = NULL
	$members = NULL

Detailed Description

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

Constructor & Destructor Documentation

__construct()

OMV\System\Group::__construct

(

$id

)

Constructor

Parameters

id	The name or GID of the system group.

Member Function Documentation

assertExists()

OMV\System\Group::assertExists

(

)

Assert that the system group exists.

Exceptions

assertNotExists()

OMV\System\Group::assertNotExists

(

)

Assert that the system group not exists.

Exceptions

exists()

OMV\System\Group::exists

(

)

Check whether the system group exists.

Returns

TRUE if the system group exists, otherwise FALSE.

getGid()

OMV\System\Group::getGid

(

)

Get the group ID.

Returns

The group ID.

getGroups()

static OMV\System\Group::getGroups ( )

static

Enumerate group names.

Returns

An array of group names.

Exceptions

getMembers()

OMV\System\Group::getMembers

(

)

Get the user names who are member of this group.

Returns

An array of user names that are member of this group.

getName()

OMV\System\Group::getName

(

)

Get the group name.

Returns

The group name.

getQuotas()

OMV\System\Group::getQuotas

(

)

Get the group quotas.

Returns

An array containing the quotas.

Exceptions

isSystemAccount()

OMV\System\Group::isSystemAccount

(

)

Check if the given group is a system account.

Returns

TRUE if the group is a system account, otherwise FALSE.

refresh()

OMV\System\Group::refresh

(

)

Refresh the cached information.

Returns

None.

---

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

• group.inc