LDAP Account Manager

FreeRadiusAccountExpirationCleanupJob extends AccountExpirationCleanupJob
in package

Job to delete or move users on account expiration.

Table of Contents

getAlias()  : string
Returns the alias name of the job.
getDescription()  : string
Returns the description of the job.
checkSingleUser()  : mixed
Checks if a user is expired.
findUsers()  : array<string|int, mixed>
Searches for users in LDAP.

Methods

getAlias()

Returns the alias name of the job.

public getAlias() : string
Return values
string

name

getDescription()

Returns the description of the job.

public getDescription() : string
Return values
string

description

checkSingleUser()

Checks if a user is expired.

protected checkSingleUser(int $jobID, array<string|int, mixed> $options, PDO &$pdo, DateTime $now, array<string|int, mixed> $policyOptions, array<string|int, mixed> $user, bool $isDryRun) : mixed
Parameters
$jobID : int

job ID

$options : array<string|int, mixed>

job settings

$pdo : PDO

PDO

$now : DateTime

current time

$policyOptions : array<string|int, mixed>

list of policy options by getPolicyOptions()

$user : array<string|int, mixed>

user attributes

$isDryRun : bool

just do a dry run, nothing is modified

Return values
mixed

findUsers()

Searches for users in LDAP.

protected findUsers(string $jobID, array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
$jobID : string

unique job identifier

$options : array<string|int, mixed>

config options (name => value)

Return values
array<string|int, mixed>

list of user attributes

Search results