Class Provisioning

Authentication provisioning class

This class is responsible to provide synchronisation method to Xoops User Database

Namespace: Xoops\Auth
Package: Provisioning
Category: Xoops\Auth
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Pierre-Eric MENUET pemphp@free.fr
Since: 2.0
Link: http://xoops.org
Located at oops_lib/Xoops/Auth/Provisioning.php

Methods summary
`public static Xoops\Auth\Provisioning`	# `getInstance( Xoops\Auth\AuthAbstract $auth_instance )` getInstance() getInstance() Parameters `$auth_instance` auth instance Returns `Xoops\Auth\Provisioning` Xoops\Auth\Provisioning
`public`	# `__construct( Xoops\Auth\AuthAbstract $auth_instance )` Authentication Service constructor Authentication Service constructor Parameters `$auth_instance` auth instance
`public mixed`	# `getXoopsUser( string $uname )` Return a Xoops User Object Return a Xoops User Object Parameters `$uname` username Returns mixed bool\|XoopsUser
`public boolean\|XoopsUser`	# `sync( string $data, string $uname, string $pwd = null )` Launch the synchronisation process Launch the synchronisation process Parameters `$data` data `$uname` username `$pwd` password Returns boolean\|`XoopsUser`
`protected`	# `setVarsMapping( object $object, array $data )` setVarsMapping setVarsMapping Parameters `$object` user object `$data` data
`public mixed`	# `add( string $data, string $uname, string $pwd = null )` Add a new user to the system Add a new user to the system Parameters `$data` data `$uname` username `$pwd` password Returns mixed XoopsUser or false
`public boolean\|XoopsUser`	# `change( Xoops\Core\Kernel\Handlers\XoopsUser $xoopsUser, string $data, string $uname, string $pwd = null )` Modify user information Modify user information Parameters `$xoopsUser` user object `$data` data `$uname` username `$pwd` password Returns boolean\|`XoopsUser`
`public boolean\|null`	# `delete( )` Modify a user Modify a user Returns boolean\|null
`public boolean\|null`	# `suspend( )` Suspend a user Suspend a user Returns boolean\|null
`public boolean\|null`	# `restore( )` Restore a user Restore a user Returns boolean\|null
`public boolean\|null`	# `resetpwd( )` Add a new user to the system Add a new user to the system Returns boolean\|null

Properties summary
`protected Xoops\Auth\AuthAbstract`	`$auth_instance` instance instance	#
`public boolean`	`$ldap_provisioning`	#
`public boolean`	`$ldap_provisioning_upd`	#
`public`	`$ldap_field_mapping` var array var array	#
`public array`	`$ldap_provisioning_group`	#

`public static Xoops\Auth\Provisioning`	# `getInstance( Xoops\Auth\AuthAbstract $auth_instance )` getInstance() getInstance() Parameters `$auth_instance` auth instance Returns `Xoops\Auth\Provisioning` Xoops\Auth\Provisioning
`public`	# `__construct( Xoops\Auth\AuthAbstract $auth_instance )` Authentication Service constructor Authentication Service constructor Parameters `$auth_instance` auth instance
`public mixed`	# `getXoopsUser( string $uname )` Return a Xoops User Object Return a Xoops User Object Parameters `$uname` username Returns mixed bool\|XoopsUser
`public boolean\|XoopsUser`	# `sync( string $data, string $uname, string $pwd = null )` Launch the synchronisation process Launch the synchronisation process Parameters `$data` data `$uname` username `$pwd` password Returns boolean\|`XoopsUser`
`protected`	# `setVarsMapping( object $object, array $data )` setVarsMapping setVarsMapping Parameters `$object` user object `$data` data
`public mixed`	# `add( string $data, string $uname, string $pwd = null )` Add a new user to the system Add a new user to the system Parameters `$data` data `$uname` username `$pwd` password Returns mixed XoopsUser or false
`public boolean\|XoopsUser`	# `change( Xoops\Core\Kernel\Handlers\XoopsUser $xoopsUser, string $data, string $uname, string $pwd = null )` Modify user information Modify user information Parameters `$xoopsUser` user object `$data` data `$uname` username `$pwd` password Returns boolean\|`XoopsUser`
`public boolean\|null`	# `delete( )` Modify a user Modify a user Returns boolean\|null
`public boolean\|null`	# `suspend( )` Suspend a user Suspend a user Returns boolean\|null
`public boolean\|null`	# `restore( )` Restore a user Restore a user Returns boolean\|null
`public boolean\|null`	# `resetpwd( )` Add a new user to the system Add a new user to the system Returns boolean\|null

Namespaces

Classes

Class Provisioning

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns