File_Passwd_Unix::addUser
Synopsis
mixed File_Passwd_Unix::addUser (
string $user
, string $pass
, array $extra = array()
)
Description
The username must start with an alphabetical character and must NOT contain any other characters than alphanumerics, the underline and dash.
If you use the 'name map' you should also use these naming in the supplied extra array, because your values would get mixed up if they are in the wrong order, which is always true if you DON'T use the 'name map'!
So be warned and USE the 'name map'!
If the passwd file is shadowed, the user will be added though, but with an 'x' as password, and a PEAR_Error will be returned, too.
Parameter
-
string
$user -
the name of the user to add
-
string
$pass -
the password of the user to add
-
array
$extra -
extra properties of user to add
Return value
Returns TRUE on success, PEAR_Error on failure.
| Error Code | Summary |
|---|---|
| FILE_PASSWD_E_ALREADY_EXISTS | user already exists |
| FILE_PASSWD_E_INVALID_CHARS | username contains illegal characters |
| FILE_PASSWD_E_INVALID_CHARS | any of the extra proporties contains a colon |
| FILE_PASSWD_E_INVALID_ENC_MODE | actual encryption mode is not supported |
| FILE_PASSWD_E_UNDEFINED | if passwd file is shadowed |
Note
This function can not be called statically.