OpenMediaVault  0.6 (Kralizec)
The open network attached storage solution
 All Classes Functions Variables Groups Pages
Public Member Functions | Protected Attributes | List of all members
Inheritance diagram for OMVUser:
OMVObject

Public Member Functions

 __construct ($id)
 
 exists ()
 
 getName ()
 
 getUid ()
 
 getGid ()
 
 getGecos ()
 
 getHomeDirectory ()
 
 getShell ()
 
 getPassword ()
 
 getLastChanged ()
 
 getMinimum ()
 
 getMaximum ()
 
 getWarn ()
 
 getInactive ()
 
 getExpire ()
 
 getReserved ()
 
 getGroups ()
 
 getQuotas ()
 
 authenticate ($password)
 
- Public Member Functions inherited from OMVObject
 __construct ()
 
 getLastError ()
 

Protected Attributes

 $name = null
 
 $uid = null
 
 $gid = null
 
 $password = null
 
 $gecos = null
 
 $dir = null
 
 $shell = null
 
 $lastchanged = null
 
 $minimum = null
 
 $maximum = null
 
 $warn = null
 
 $inactive = null
 
 $expire = null
 
 $reserved = null
 
 $groups = 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 user.

Constructor & Destructor Documentation

OMVUser::__construct (   $id)

Constructor

Parameters
idThe name or UID of the system user.

Member Function Documentation

OMVUser::authenticate (   $password)

Authenticate user via PAM. Account expiration and access hours are checked, too. Note, the calling process must have the privilege to read the user shadow file.

Parameters
passwordThe password.
Returns
TRUE if the authentication was successful, otherwise FALSE.
OMVUser::exists ( )

Check whether the system user exists.

Returns
TRUE if the system user exists, otherwise FALSE.
OMVUser::getGecos ( )

Get the comment.

Returns
The comment, otherwise FALSE.
OMVUser::getGid ( )

Get the users group ID.

Returns
The user group ID, otherwise FALSE.
OMVUser::getGroups ( )

Get the groups the user is in.

Returns
An array of groups the user is in, otherwise FALSE.
OMVUser::getHomeDirectory ( )

Get the home directory.

Returns
The home directory, otherwise FALSE.
OMVUser::getName ( )

Get the group name.

Returns
The group name.
OMVUser::getPassword ( )

Get the encrypted password.

Returns
The encrypted password, otherwise FALSE.
OMVUser::getQuotas ( )

Get the user quotas.

Returns
An array containing the quotas.
OMVUser::getShell ( )

Get the shell.

Returns
The shell, otherwise FALSE.
OMVUser::getUid ( )

Get the user ID.

Returns
The user ID, otherwise FALSE.

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