XoopsAuthProvisionning	XoopsAuthProvisionning()	Authentication Service constructor
array	add()	Adds a new user to the system
object XoopsUser	change()	Modify user information
bool	delete()	Modify a user
object	&getInstance()	Gets instance of XoopsAuthProvisionning
mixed	getXoopsUser()	Return a Xoops User Object
bool	resetpwd()	Resets Password for the user
bool	restore()	Restore a user
bool	suspend()	Suspend a user
object XoopsUser	sync()	Launch the synchronisation process

[ Top ]

Properties

mixed $_auth_instance [line 28]

[ Top ]

Methods

Constructor XoopsAuthProvisionning [line 48]

XoopsAuthProvisionning XoopsAuthProvisionning(

&$auth_instance, object
$auth_instance 
)

Authentication Service constructor

Parameters:

object	$auth_instance:	XoopsAuthProvisionning
	&$auth_instance:

[ Top ]

add [line 102]

array add(
array
$datas, string
$uname, [string
$pwd = null] 
)

Adds a new user to the system

Parameters:

array	$datas:	Some Data
string	$uname:	Username of the user
string	$pwd:	Password of the user

[ Top ]

change [line 142]

object XoopsUser change(
object {@link
&$icmsUser, array
$datas, string
$uname, [string
$pwd = null] 
)

Modify user information

Parameters:

array	$datas:	Some Data
string	$uname:	Username of the user
string	$pwd:	Password of the user
object {@link	&$icmsUser:	XoopsUser} reference to XoopsUser Object

API Tags:

Return:

XoopsUser

[ Top ]

delete [line 165]

bool delete(
)

Modify a user

[ Top ]

getInstance [line 35]

object &getInstance(

&$auth_instance, object
$auth_instance 
)

Gets instance of XoopsAuthProvisionning

Parameters:

object	$auth_instance:
	&$auth_instance:

API Tags:

Return:

XoopsAuthProvisionning

[ Top ]

getXoopsUser [line 65]

mixed getXoopsUser(
string
$uname 
)

Return a Xoops User Object

Parameters:

string

$uname:

Username of the user

API Tags:

Return:

XoopsUser XoopsUser or false if failed

[ Top ]

resetpwd [line 189]

bool resetpwd(
)

Resets Password for the user

[ Top ]

restore [line 181]

bool restore(
)

Restore a user

[ Top ]

suspend [line 173]

bool suspend(
)

Suspend a user

[ Top ]

sync [line 81]

object XoopsUser sync(
array
$datas, string
$uname, [string
$pwd = null] 
)

Launch the synchronisation process

Parameters:

array	$datas:	Some Data
string	$uname:	Username of the user
string	$pwd:	Password of the user

API Tags:

Return:

XoopsUser

[ Top ]

Documentation generated on Sat, 12 Dec 2009 21:10:31 -0600 by phpDocumentor 1.4.1