IDS PHP Libraries

User
in package
uses Loggable

Table of Contents

Properties

$clientIpAddress  : string
$isUserLoggedIn  : bool
$logger  : object|null
$userName  : string
$userRole  : string

Methods

__construct()  : mixed
getClientIpAddress()  : string
getLoginStatus()  : bool
getUserName()  : string
getUserRole()  : string
log()  : void
setIpAddress()  : void
setLoginStatus()  : void
setUserName()  : void
setUserRole()  : void

Properties

$clientIpAddress

private string $clientIpAddress

$isUserLoggedIn

private bool $isUserLoggedIn = false

$logger

private object|null $logger = null

$userName

private string $userName

$userRole

private string $userRole = 'user'

Methods

__construct()

public __construct([string $name = '' ][, string $ip = '' ]) : mixed
Parameters
$name : string = ''
$ip : string = ''

getClientIpAddress()

public getClientIpAddress() : string
Return values
string

getLoginStatus()

public getLoginStatus() : bool
Return values
bool

getUserName()

public getUserName() : string
Return values
string

getUserRole()

public getUserRole() : string
Return values
string

log()

public log([mixed $message = '' ][, string $level = 'info' ][, mixed $backtrace = null ][, int $spacing = 0 ]) : void
Parameters
$message : mixed = ''
$level : string = 'info'
$backtrace : mixed = null
$spacing : int = 0

setIpAddress()

public setIpAddress(string $ip) : void
Parameters
$ip : string

setLoginStatus()

public setLoginStatus([bool|null $isUserLoggedIn = null ]) : void
Parameters
$isUserLoggedIn : bool|null = null

setUserName()

public setUserName(string $name) : void
Parameters
$name : string

setUserRole()

public setUserRole(string $role) : void
Parameters
$role : string

        
On this page

Search results