Xoops\Auth\Provisioning Class Reference

Public Member Functions
	__construct (AuthAbstract $auth_instance)
	add ($data, $uname, $pwd=null)
	change (\XoopsUser $xoopsUser, $data, $uname, $pwd=null)
	delete ()
	getXoopsUser ($uname)
	resetpwd ()
	restore ()
	suspend ()
	sync ($data, $uname, $pwd=null)

Static Public Member Functions
static	getInstance (AuthAbstract $auth_instance)

Public Attributes
	$ldap_field_mapping
	$ldap_provisioning
	$ldap_provisioning_group
	$ldap_provisioning_upd

Protected Member Functions
	setVarsMapping ($object, $data)

Protected Attributes
	$auth_instance

Detailed Description

Definition at line 29 of file Provisioning.php.

Constructor & Destructor Documentation

Xoops\Auth\Provisioning::__construct

(

AuthAbstract

$auth_instance

)

Authentication Service constructor

Parameters

AuthAbstract

$auth_instance

auth instance

Definition at line 78 of file Provisioning.php.

References Xoops\Auth\Provisioning\$auth_instance, $configs, $xoops, and Xoops\getInstance().

Here is the call graph for this function:

Member Function Documentation

Xoops\Auth\Provisioning::add	(		$data,
			$uname,
			$pwd = null
	)

Add a new user to the system

Parameters

string	$data	data
string	$uname	username
string	$pwd	password

Returns

mixed XoopsUser or false

Definition at line 172 of file Provisioning.php.

References $member_handler, $uname, $xoops, XoopsBaseConfig\get(), Xoops\getInstance(), and Xoops\Auth\Provisioning\setVarsMapping().

Referenced by Xoops\Auth\Provisioning\sync().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Auth\Provisioning::change	(	\XoopsUser	$xoopsUser,
			$data,
			$uname,
			$pwd = null
	)

Modify user information

Parameters

\XoopsUser	$xoopsUser	user object
string	$data	data
string	$uname	username
string	$pwd	password

Returns

bool|XoopsUser

Definition at line 214 of file Provisioning.php.

References $member_handler, $xoops, $xoopsUser, XoopsBaseConfig\get(), Xoops\Core\Kernel\XoopsObject\getHtmlErrors(), Xoops\getInstance(), Xoops\Core\Kernel\XoopsObject\setVar(), and Xoops\Auth\Provisioning\setVarsMapping().

Referenced by Xoops\Auth\Provisioning\sync().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Auth\Provisioning::delete

(

)

Modify a user

Returns

boolean|null

Definition at line 236 of file Provisioning.php.

static Xoops\Auth\Provisioning::getInstance ( AuthAbstract  $auth_instance )

static

getInstance()

Parameters

AuthAbstract

$auth_instance

auth instance

Returns

Provisioning Xoops

Definition at line 63 of file Provisioning.php.

References Xoops\Auth\Provisioning\$auth_instance.

Referenced by Xoops\Auth\Ldap\loadXoopsUser().

Here is the caller graph for this function:

Xoops\Auth\Provisioning::getXoopsUser

(

$uname

)

Return a Xoops User Object

Parameters

string

$uname

username

Returns

mixed bool|XoopsUser

Definition at line 95 of file Provisioning.php.

References $criteria, $getuser, $member_handler, $uname, $xoops, and Xoops\getInstance().

Referenced by Xoops\Auth\Provisioning\sync().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Auth\Provisioning::resetpwd

(

)

Add a new user to the system

Returns

boolean|null

Definition at line 263 of file Provisioning.php.

Xoops\Auth\Provisioning::restore

(

)

Restore a user

Returns

boolean|null

Definition at line 254 of file Provisioning.php.

Xoops\Auth\Provisioning::setVarsMapping (   $object,   $data  )

protected

setVarsMapping

Parameters

object	$object	user object
array	$data	data

Returns

void

Definition at line 146 of file Provisioning.php.

Referenced by Xoops\Auth\Provisioning\add(), and Xoops\Auth\Provisioning\change().

Here is the caller graph for this function:

Xoops\Auth\Provisioning::suspend

(

)

Suspend a user

Returns

boolean|null

Definition at line 245 of file Provisioning.php.

Xoops\Auth\Provisioning::sync	(		$data,
			$uname,
			$pwd = null
	)

Launch the synchronisation process

Parameters

string	$data	data
string	$uname	username
string	$pwd	password

Returns

bool|XoopsUser

Definition at line 117 of file Provisioning.php.

References $uname, $xoopsUser, Xoops\Auth\Provisioning\add(), Xoops\Auth\Provisioning\change(), XoopsLocaleEn_US\EF_CORRESPONDING_USER_NOT_FOUND_IN_DATABASE, and Xoops\Auth\Provisioning\getXoopsUser().

Here is the call graph for this function:

Member Data Documentation

Xoops\Auth\Provisioning::$auth_instance

protected

Definition at line 34 of file Provisioning.php.

Referenced by Xoops\Auth\Provisioning\__construct(), and Xoops\Auth\Provisioning\getInstance().

Xoops\Auth\Provisioning::$ldap_field_mapping

var array

Definition at line 49 of file Provisioning.php.

Xoops\Auth\Provisioning::$ldap_provisioning

Definition at line 39 of file Provisioning.php.

Xoops\Auth\Provisioning::$ldap_provisioning_group

Definition at line 54 of file Provisioning.php.

Xoops\Auth\Provisioning::$ldap_provisioning_upd

Definition at line 44 of file Provisioning.php.

---

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

• C:/usr64/htdocs/xoops_lib/Xoops/Auth/Provisioning.php