Jelix 1.6.37

ldsAuthDriver
in package
implements jIAuthDriver

authentification driver, which communicate with a LDS server LDS = Linbox Directory Server

Tags
subpackage

auth_driver

link
http://lds.linbox.org/
see
jAuth
since
1.0b1

Interfaces, Classes and Traits

jIAuthDriver
interface for auth drivers

Table of Contents

$_params  : mixed
__construct()  : mixed
constructor
changePassword()  : bool
change a user password
createUserObject()  : object
creates a new user object, with some first data.. Careful : it doesn't create a user in a database for example. Just an object.
getUser()  : object
return user data corresponding to the given login
getUserList()  : array<string|int, object>
construct the user list
removeUser()  : mixed
Erase user data of the user $login
saveNewUser()  : mixed
store a new user.
updateUser()  : mixed
save updated data of a user warning : should not save the password !
verifyPassword()  : object|false
verify that the password correspond to the login
decodeEntities()  : string
function wich decode UTF-8 Entity with ref &#03; for example.
xmlCall()  : mixed
call an xmlrpc call for a method via the xmlrpc server in python (lmc-agent)

Properties

Methods

__construct()

constructor

public __construct(mixed $params) : mixed
Parameters
$params : mixed

driver parameters, written in the ini file of the auth plugin

Return values
mixed

changePassword()

change a user password

public changePassword(mixed $login, mixed $newpassword) : bool
Parameters
$login : mixed

the login of the user

$newpassword : mixed
Return values
bool

true if the password has been changed

createUserObject()

creates a new user object, with some first data.. Careful : it doesn't create a user in a database for example. Just an object.

public createUserObject(mixed $login, mixed $password) : object
Parameters
$login : mixed

the user login

$password : mixed

the user password

Return values
object

the returned object depends on the driver

getUser()

return user data corresponding to the given login

public getUser(mixed $login) : object
Parameters
$login : mixed

the login of the user

Return values
object

the user data container

getUserList()

construct the user list

public getUserList(mixed $pattern) : array<string|int, object>
Parameters
$pattern : mixed

'' for all users

Return values
array<string|int, object>

array of objects representing the users

removeUser()

Erase user data of the user $login

public removeUser(mixed $login) : mixed
Parameters
$login : mixed

the login of the user to remove

Return values
mixed

saveNewUser()

store a new user.

public saveNewUser(mixed $user) : mixed

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

Parameters
$user : mixed

the user data container

Return values
mixed

updateUser()

save updated data of a user warning : should not save the password !

public updateUser(mixed $user) : mixed
Parameters
$user : mixed

the user data container

Return values
mixed

verifyPassword()

verify that the password correspond to the login

public verifyPassword(mixed $login, mixed $password) : object|false
Parameters
$login : mixed

the login of the user

$password : mixed

the password to test

Return values
object|false

returns the object representing the user

decodeEntities()

function wich decode UTF-8 Entity with ref &#03; for example.

protected decodeEntities(string $text[, mixed $charset = 'UTF-8' ]) : string

It is needed because XMLRPC server doest not like this sort of encoding.

Parameters
$text : string

the content in which the entities should be decoded

$charset : mixed = 'UTF-8'
Return values
string

the decoded string

xmlCall()

call an xmlrpc call for a method via the xmlrpc server in python (lmc-agent)

protected xmlCall(string $method, array<string|int, mixed> $params) : mixed
Parameters
$method : string

name of the method

$params : array<string|int, mixed>

array with param

Tags
throws
jException
Return values
mixed

the value of the response returned by the call

Search results