AccountStatusDetails
in package
Table of Contents
- $details : mixed
- $expired : mixed
- $icon : mixed
- $id : mixed
- $locked : mixed
- $partiallyExpired : mixed
- $partiallyLocked : mixed
- __construct() : mixed
- Constructor.
- getDetails() : string
- Returns the details.
- getIcon() : string
- Returns the icon name.
- getId() : string
- Returns the id.
- isExpired() : bool
- Returns if the account/password is fully expired (e.g. login no longer possible without password change).
- isLocked() : bool
- Returns if the account is fully locked (login no longer possible).
- isPartiallyExpired() : bool
- Returns if the account/password is partially expired (e.g. a single application is expired).
- isPartiallyLocked() : bool
- Returns if the account is partially locked (e.g. a single application is locked).
- newExpired() : AccountStatusDetails
- Creates a new expired status entry.
- newLocked() : AccountStatusDetails
- Creates a new locked status entry.
- newPartiallyExpired() : AccountStatusDetails
- Creates a new partially expired status entry.
- newPartiallyLocked() : AccountStatusDetails
- Creates a new partially locked status entry.
Properties
$details
private
mixed
$details
$expired
private
mixed
$expired
= \false
$icon
private
mixed
$icon
$id
private
mixed
$id
$locked
private
mixed
$locked
= \false
$partiallyExpired
private
mixed
$partiallyExpired
= \false
$partiallyLocked
private
mixed
$partiallyLocked
= \false
Methods
__construct()
Constructor.
public
__construct(string $details, string $id, string $icon) : mixed
Parameters
- $details : string
-
details message
- $id : string
-
ID for reference
- $icon : string
-
icon name
Return values
mixed —getDetails()
Returns the details.
public
getDetails() : string
Return values
string —details
getIcon()
Returns the icon name.
public
getIcon() : string
Return values
string —icon name
getId()
Returns the id.
public
getId() : string
Return values
string —id
isExpired()
Returns if the account/password is fully expired (e.g. login no longer possible without password change).
public
isExpired() : bool
Return values
bool —is expired
isLocked()
Returns if the account is fully locked (login no longer possible).
public
isLocked() : bool
Return values
bool —is locked
isPartiallyExpired()
Returns if the account/password is partially expired (e.g. a single application is expired).
public
isPartiallyExpired() : bool
Return values
bool —is expired
isPartiallyLocked()
Returns if the account is partially locked (e.g. a single application is locked).
public
isPartiallyLocked() : bool
Return values
bool —is locked
newExpired()
Creates a new expired status entry.
public
static newExpired(string $details, string $id[, string $icon = null ]) : AccountStatusDetails
Parameters
- $details : string
-
details message
- $id : string
-
ID for reference
- $icon : string = null
-
icon name
Return values
AccountStatusDetails —status entry
newLocked()
Creates a new locked status entry.
public
static newLocked(string $details, string $id[, string $icon = null ]) : AccountStatusDetails
Parameters
- $details : string
-
details message
- $id : string
-
ID for reference
- $icon : string = null
-
icon name
Return values
AccountStatusDetails —status entry
newPartiallyExpired()
Creates a new partially expired status entry.
public
static newPartiallyExpired(string $details, string $id[, string $icon = null ]) : AccountStatusDetails
Parameters
- $details : string
-
details message
- $id : string
-
ID for reference
- $icon : string = null
-
icon name
Return values
AccountStatusDetails —status entry
newPartiallyLocked()
Creates a new partially locked status entry.
public
static newPartiallyLocked(string $details, string $id[, string $icon = null ]) : AccountStatusDetails
Parameters
- $details : string
-
details message
- $id : string
-
ID for reference
- $icon : string = null
-
icon name
Return values
AccountStatusDetails —status entry