LDAP Account Manager

AccountStatusProvider
in

Provides module information about the status of an LDAP account.

Table of Contents

accountStatusPerformLock()  : void
Locks the account with the given lock IDs.
accountStatusPerformUnlock()  : void
Unlocks the account with the given lock IDs.
getAccountStatusDetails()  : array<string|int, AccountStatusDetails>
Returns the list of account status detail lines.
getAccountStatusPossibleLockOptions()  : array<string|int, AccountStatusDetails>
Returns a list of options how the account could be locked.
getAccountStatusRequiredAttributes()  : array<string|int, mixed>
Returns the list of LDAP attributes that must be read to get the account status.

Methods

accountStatusPerformLock()

Locks the account with the given lock IDs.

public accountStatusPerformLock(ConfiguredType $type, array<string|int, mixed>|null &$attributes, array<string|int, mixed> $lockIds) : void
Parameters
$type : ConfiguredType

type

$attributes : array<string|int, mixed>|null

LDAP attributes

$lockIds : array<string|int, mixed>

IDs from AccountStatusDetails

Tags
throws
LAMException

error during locking

Return values
void —

accountStatusPerformUnlock()

Unlocks the account with the given lock IDs.

public accountStatusPerformUnlock(ConfiguredType $type, array<string|int, mixed>|null &$attributes, array<string|int, mixed> $lockIds) : void
Parameters
$type : ConfiguredType

type

$attributes : array<string|int, mixed>|null

LDAP attributes

$lockIds : array<string|int, mixed>

IDs from AccountStatusDetails

Return values
void —

getAccountStatusDetails()

Returns the list of account status detail lines.

public getAccountStatusDetails(ConfiguredType $type, array<string|int, mixed>|null &$attributes) : array<string|int, AccountStatusDetails>
Parameters
$type : ConfiguredType

account type

$attributes : array<string|int, mixed>|null

LDAP attributes (use account container attributes if not provided)

Return values
array<string|int, AccountStatusDetails> —

status details

getAccountStatusPossibleLockOptions()

Returns a list of options how the account could be locked.

public getAccountStatusPossibleLockOptions(ConfiguredType $type, array<string|int, mixed>|null &$attributes) : array<string|int, AccountStatusDetails>
Parameters
$type : ConfiguredType

type

$attributes : array<string|int, mixed>|null

LDAP attributes

Return values
array<string|int, AccountStatusDetails> —

lock options

getAccountStatusRequiredAttributes()

Returns the list of LDAP attributes that must be read to get the account status.

public getAccountStatusRequiredAttributes(ConfiguredType $type) : array<string|int, mixed>
Parameters
$type : ConfiguredType

type

Return values
array<string|int, mixed> —

attribute names

Search results