File_Passwd_Custom::addUser

File_Passwd_Custom::addUser() – Add an user

Synopsis

mixed File_Passwd_Custom::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.

The username MUST NOT contain the custom delimiter!

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'!

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.

Possible PEAR_Error values
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 the delimiter
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.

Save changes (Previous) Modify user (Next)
Last updated: Tue, 02 Sep 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.