API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsAuthProvisionning Class Reference

Public Member Functions

 __construct (XoopsAuth $auth_instance=null)
 
 getXoopsUser ($uname)
 
 sync ($datas, $uname, $pwd=null)
 
 add ($datas, $uname, $pwd=null)
 
 change (&$xoopsUser, $datas, $uname, $pwd=null)
 
 delete ()
 
 suspend ()
 
 restore ()
 
 resetpwd ()
 

Static Public Member Functions

static getInstance (XoopsAuth $auth_instance=null)
 

Protected Attributes

 $_auth_instance
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( XoopsAuth  $auth_instance = null)

Authentication Service constructor

Parameters
XoopsAuth$auth_instance
Here is the call graph for this function:

Member Function Documentation

◆ add()

add (   $datas,
  $uname,
  $pwd = null 
)

Add a new user to the system

Parameters
$datas
$uname
null$pwd
Returns
bool
Here is the call graph for this function:
Here is the caller graph for this function:

◆ change()

change ( $xoopsUser,
  $datas,
  $uname,
  $pwd = null 
)

Modify user information

Parameters
$xoopsUser
$datas
$uname
null$pwd
Returns
bool
Here is the call graph for this function:
Here is the caller graph for this function:

◆ delete()

delete ( )

Modify a user

Returns
bool

◆ getInstance()

static getInstance ( XoopsAuth  $auth_instance = null)
static

XoopsAuthProvisionning::getInstance()

Parameters
mixed$auth_instance
Returns
\XoopsAuthProvisionning
Here is the caller graph for this function:

◆ getXoopsUser()

getXoopsUser (   $uname)

Return a Xoops User Object

Parameters
$uname
Returns
XoopsUser or false
Here is the call graph for this function:
Here is the caller graph for this function:

◆ resetpwd()

resetpwd ( )

Add a new user to the system

Returns
bool

◆ restore()

restore ( )

Restore a user

Returns
bool

◆ suspend()

suspend ( )

Suspend a user

Returns
bool

◆ sync()

sync (   $datas,
  $uname,
  $pwd = null 
)

Launch the synchronisation process

Parameters
$datas
$uname
null$pwd
Returns
bool
Here is the call graph for this function:

Field Documentation

◆ $_auth_instance

$_auth_instance
protected

The documentation for this class was generated from the following file: