WindowsManagedGroupsNotifyJob
extends PasswordExpirationJob
in package
Job to notify users about their managed groups.
Table of Contents
- MANAGED_GROUPS = 'LAM_MANAGED_GROUPS'
- PERIOD_HALF_YEARLY = 'HALF_YEARLY'
- PERIOD_MONTHLY = 'MONTHLY'
- PERIOD_QUARTERLY = 'QUARTERLY'
- PERIOD_YEARLY = 'YEARLY'
- checkConfigOptions() : mixed
- execute() : mixed
- getAlias() : string
- Returns the alias name of the job.
- getConfigOptions() : mixed
- getDescription() : mixed
- getLastEffectiveExecutionDate() : mixed
- Returns the last effective execution date.
- checkSingleUser() : mixed
- findUsers() : array<string|int, mixed>
- Searches for users in LDAP.
- getPolicyOptions() : mixed
- formatGroups() : string
- Formats the managed groups.
- getBaseDate() : DateTime
- Returns the base date (first of month) for the current date.
- getMonthInterval() : int
- Returns the month interval.
- shouldRun() : bool
- Returns if the job should run.
Constants
MANAGED_GROUPS
public
mixed
MANAGED_GROUPS
= 'LAM_MANAGED_GROUPS'
PERIOD_HALF_YEARLY
public
mixed
PERIOD_HALF_YEARLY
= 'HALF_YEARLY'
PERIOD_MONTHLY
public
mixed
PERIOD_MONTHLY
= 'MONTHLY'
PERIOD_QUARTERLY
public
mixed
PERIOD_QUARTERLY
= 'QUARTERLY'
PERIOD_YEARLY
public
mixed
PERIOD_YEARLY
= 'YEARLY'
Methods
checkConfigOptions()
public
checkConfigOptions(mixed $jobID, mixed $options) : mixed
Parameters
- $jobID : mixed
- $options : mixed
Tags
Return values
mixed —execute()
public
execute(mixed $jobID, mixed $options, mixed &$pdo, mixed $isDryRun, mixed &$resultLog) : mixed
Parameters
- $jobID : mixed
- $options : mixed
- $pdo : mixed
- $isDryRun : mixed
- $resultLog : mixed
Tags
Return values
mixed —getAlias()
Returns the alias name of the job.
public
getAlias() : string
Return values
string —name
getConfigOptions()
public
getConfigOptions(mixed $jobID) : mixed
Parameters
- $jobID : mixed
Tags
Return values
mixed —getDescription()
public
getDescription() : mixed
Tags
Return values
mixed —getLastEffectiveExecutionDate()
Returns the last effective execution date.
public
static getLastEffectiveExecutionDate(DateTime $baseDate, int $monthInterval, JobResultLog $resultLog) : mixed
Parameters
- $baseDate : DateTime
-
base date
- $monthInterval : int
-
number of months in interval
- $resultLog : JobResultLog
-
result log
Return values
mixed —checkSingleUser()
protected
checkSingleUser(mixed $jobID, mixed $options, mixed &$pdo, mixed $now, mixed $policyOptions, mixed $user, mixed $isDryRun) : mixed
Parameters
- $jobID : mixed
- $options : mixed
- $pdo : mixed
- $now : mixed
- $policyOptions : mixed
- $user : mixed
- $isDryRun : mixed
Tags
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
getPolicyOptions()
protected
getPolicyOptions() : mixed
Tags
Return values
mixed —formatGroups()
Formats the managed groups.
private
formatGroups( $managedGroups, bool $isHTML) : string
Parameters
Return values
string —formatted text
getBaseDate()
Returns the base date (first of month) for the current date.
private
getBaseDate(DateTime $currentDate) : DateTime
Parameters
- $currentDate : DateTime
-
current date
Return values
DateTime —base date
getMonthInterval()
Returns the month interval.
private
getMonthInterval(array<string|int, mixed> $options, $jobId) : int
Parameters
Return values
int —interval
shouldRun()
Returns if the job should run.
private
shouldRun( &$pdo, $jobId, DateTime $baseDate, int $monthInterval) : bool
Parameters
Return values
bool —should run