Class Accounts_Driver_localhost

Description

Implements the Accounts API for servers with unix accounts on the localhost machine (same machine as the web server). Should work for local unix accounts, nis/nis+ accounts, or any PAM oriented accounts that appear as local accounts on the local machine. The exception is the quota support.

See that routine for additional comments.

Copyright 2002-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /lib/Block/account.php (line 252)

Accounts_Driver
   |
   --Accounts_Driver_localhost
Variable Summary
 array $params
Method Summary
 Accounts_Driver_localhost Accounts_Driver_localhost ([array $params = array()])
 mixed getFullname ()
 mixed getHome ()
 mixed getQuota ()
 mixed getShell ()
 array _getAccount ()
Variables
array $params = array() (line 259)

Hash containing connection parameters.

Inherited Variables

Inherited from Accounts_Driver

Accounts_Driver::$err_str
Methods
Constructor Accounts_Driver_localhost (line 266)

Constructor.

Accounts_Driver_localhost Accounts_Driver_localhost ([array $params = array()])
  • array $params: Hash containing connection parameters.
getFullname (line 367)

Returns the user's full name.

  • return: The user's full name (string), or false (error).
mixed getFullname ()

Redefinition of:
Accounts_Driver::getFullname()
Returns the user's full name.
getHome (line 382)

Returns the user's home (login) directory.

  • return: The user's directory (string), or false (error).
mixed getHome ()

Redefinition of:
Accounts_Driver::getHome()
Returns the user's home (login) directory.
getQuota (line 313)

Implement the Quota API for IMAP servers with a unix quota command.

This may require a modified "quota" command that allows the httpd server account to get quotas for other users... It requires that your web server and user server be the same server or at least have shared authentication and file servers (e.g. via NIS/NFS). And last, it (as written) requires the posix php extensions.

If your quota command wraps the output onto two lines, then this module will only work if you have a grep which supports the -A switch, and you append an -A1 switch to your grep_path (e.g. '/bin/grep -A1').

  • return: The quota hash (bytes used, limit) or false for error.
mixed getQuota ()

Redefinition of:
Accounts_Driver::getQuota()
Returns the user's quota if available.
getShell (line 396)

Returns the user's default shell.

  • return: The user's shell (string), or false (error).
mixed getShell ()

Redefinition of:
Accounts_Driver::getShell()
Returns the user's default shell.
_getAccount (line 282)

Returns the user account from the posix information.

  • return: A hash with complete account details.
array _getAccount ()

Inherited Methods

Inherited From Accounts_Driver

 Accounts_Driver::checkPasswordStatus()
 Accounts_Driver::getFullname()
 Accounts_Driver::getHome()
 Accounts_Driver::getPasswordChange()
 Accounts_Driver::getQuota()
 Accounts_Driver::getRealm()
 Accounts_Driver::getShell()
 Accounts_Driver::getUsername()

Documentation generated on Sun, 30 Jan 2011 05:26:53 +0000 by phpDocumentor 1.4.3