PHP Class Ezrbac

Author: Roni Kumar Saha ([email protected])
Afficher le fichier Open project: xiidea/ezrbac

Méthodes publiques

Méthode Description
__construct ( )
createUser ( array $data = [] ) : mixed api create new user
getCurrentUser ( ) : null | obj return the user object for logged in user
getCurrentUserID ( ) : null | integer return the user id for logged in user
getUserByID ( $user_id ) : mixed find and return user object by user ID
getUserMeta ( $user_id ) : mixed return the user meta data
isGuest ( ) : boolean check if accessing as guest user or not
logoutUrl ( ) : string find and return Logout url
registerUserSession ( $user, boolean $remember = FALSE ) : boolean Helpful if you have your login verification script, you can register session just by passing the user object
setCurrentUser ( $user ) : mixed set current user object while login
updateUser ( array $data = [] ) : mixed api update user data

Method Details

__construct() public méthode

public __construct ( )

createUser() public méthode

api create new user
public createUser ( array $data = [] ) : mixed
$data array
Résultat mixed

getCurrentUser() public méthode

return the user object for logged in user
public getCurrentUser ( ) : null | obj
Résultat null | obj

getCurrentUserID() public méthode

return the user id for logged in user
public getCurrentUserID ( ) : null | integer
Résultat null | integer

getUserByID() public méthode

find and return user object by user ID
public getUserByID ( $user_id ) : mixed
$user_id
Résultat mixed

getUserMeta() public méthode

return the user meta data
public getUserMeta ( $user_id ) : mixed
$user_id
Résultat mixed

isGuest() public méthode

check if accessing as guest user or not
public isGuest ( ) : boolean
Résultat boolean

logoutUrl() public méthode

find and return Logout url
public logoutUrl ( ) : string
Résultat string

registerUserSession() public méthode

Helpful if you have your login verification script, you can register session just by passing the user object
public registerUserSession ( $user, boolean $remember = FALSE ) : boolean
$user
$remember boolean
Résultat boolean

setCurrentUser() public méthode

set current user object while login
public setCurrentUser ( $user ) : mixed
$user
Résultat mixed

updateUser() public méthode

api update user data
public updateUser ( array $data = [] ) : mixed
$data array
Résultat mixed