Interface jIAuthDriver

Description

interface for auth drivers

Located in /auth/jIAuthDriver.iface.php (line 18)


	
			
Method Summary
jIAuthDriver __construct (array $params)
void changePassword (string $login, string $newpassword)
object the createUserObject (string $login, string $password)
object the getUser (string $login)
array getUserList (string $pattern)
void removeUser (string $login)
void saveNewUser (object $user)
void updateUser (object $user)
object|false verifyPassword (string $login, string $password)
Methods
Constructor __construct (line 23)

constructor

jIAuthDriver __construct (array $params)
  • array $params: driver parameters, written in the ini file of the auth plugin
changePassword (line 76)

change a user password

  • access: public
void changePassword (string $login, string $newpassword)
  • string $login: the login of the user
  • string $newpassword
createUserObject (line 32)

creates a new user object, with some first data..

Careful : it doesn't create a user in a database for example. Just an object.

  • return: returned object depends on the driver
  • access: public
object the createUserObject (string $login, string $password)
  • string $login: the user login
  • string $password: the user password
getUser (line 61)

return user data corresponding to the given login

  • return: user data container
  • access: public
object the getUser (string $login)
  • string $login: the login of the user
getUserList (line 68)

construct the user list

  • return: array of user object
  • access: public
array getUserList (string $pattern)
  • string $pattern: '' for all users
removeUser (line 47)

Erase user data of the user $login

  • access: public
void removeUser (string $login)
  • string $login: the login of the user to remove
saveNewUser (line 41)

store a new user.

It create the user in a database for example should be call after a call of createUser and after setting some of its properties...

  • access: public
void saveNewUser (object $user)
  • object $user: the user data container
updateUser (line 54)

save updated data of a user

warning : should not save the password !

  • access: public
void updateUser (object $user)
  • object $user: the user data container
verifyPassword (line 84)

verify that the password correspond to the login

  • access: public
object|false verifyPassword (string $login, string $password)
  • string $login: the login of the user
  • string $password: the password to test

Documentation generated on Thu, 19 Sep 2013 00:05:21 +0200 by phpDocumentor 1.4.3