AccountStatus
in package
Provides the complete information about the status of an LDAP account.
Table of Contents
- $details : array<string|int, AccountStatusDetails>
- __construct() : mixed
- Constructor.
- fromAttributes() : AccountStatus
- Creates the account status from the given type and LDAP attributes.
- getDetails() : array<string|int, AccountStatusDetails>
- Returns the account details.
- 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).
- lockableFromAttributes() : AccountStatus
- Creates the lockable account status from the given type and LDAP attributes.
Properties
$details
private
array<string|int, AccountStatusDetails>
$details
list of details
Methods
__construct()
Constructor.
public
__construct(array<string|int, AccountStatusDetails> $details) : mixed
Parameters
- $details : array<string|int, AccountStatusDetails>
-
details
Return values
mixed —fromAttributes()
Creates the account status from the given type and LDAP attributes.
public
static fromAttributes(ConfiguredType $type, array<string|int, mixed> $attributes) : AccountStatus
Parameters
- $type : ConfiguredType
-
type
- $attributes : array<string|int, mixed>
-
LDAP attributes
Return values
AccountStatus —status
getDetails()
Returns the account details.
public
getDetails() : array<string|int, AccountStatusDetails>
Return values
array<string|int, AccountStatusDetails> —details
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
lockableFromAttributes()
Creates the lockable account status from the given type and LDAP attributes.
public
static lockableFromAttributes(ConfiguredType $type, array<string|int, mixed> $attributes) : AccountStatus
Parameters
- $type : ConfiguredType
-
type
- $attributes : array<string|int, mixed>
-
LDAP attributes
Return values
AccountStatus —lockable status