Jelix 1.6.37

jIAuthDriverClass

interface for classes used with the jAuthDriverClass

Tags
subpackage

auth_driver

see
jAuth
since
1.0b2

Table of Contents

createUserObject()  : object
create an empty object which will contains user informations
deleteByLogin()  : mixed
delete a user
findAll()  : array<string|int, object>
gets all users
findByLoginPattern()  : array<string|int, object>
gets all users for which the login corresponds to the given pattern
getByLogin()  : object
get user informations
getByLoginPassword()  : object
get the user corresponding to the given login and encrypted password
insert()  : mixed
save a new user
update()  : mixed
update user informations
updatePassword()  : mixed
change the password of a user

Methods

createUserObject()

create an empty object which will contains user informations

public createUserObject() : object
Return values
object

user informations (empty)

deleteByLogin()

delete a user

public deleteByLogin(string $login) : mixed
Parameters
$login : string

login of the user to delete

Return values
mixed

findAll()

gets all users

public findAll() : array<string|int, object>
Return values
array<string|int, object>

list of users

findByLoginPattern()

gets all users for which the login corresponds to the given pattern

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

the pattern

Return values
array<string|int, object>

list of users

getByLogin()

get user informations

public getByLogin(string $login) : object
Parameters
$login : string

login of the user on which we want to get informations

Return values
object

user informations

getByLoginPassword()

get the user corresponding to the given login and encrypted password

public getByLoginPassword(string $login, string $cryptedpassword) : object
Parameters
$login : string

the user login

$cryptedpassword : string

the new encrypted password

Tags
deprecated

since 1.2.10

Return values
object

user informations

insert()

save a new user

public insert(object $user) : mixed
Parameters
$user : object

user informations

Return values
mixed

update()

update user informations

public update(object $user) : mixed
Parameters
$user : object

user informations

Return values
mixed

updatePassword()

change the password of a user

public updatePassword(string $login, string $cryptedpassword) : mixed
Parameters
$login : string

the user login

$cryptedpassword : string

the new encrypted password

Return values
mixed

Search results