Inheritance diagram for ilCronDeleteInactivatedUserAccounts:

Collaboration diagram for ilCronDeleteInactivatedUserAccounts:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	hasCustomSettings ()

	run ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

	isDue (?DateTimeImmutable $last_run, ?int $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule (?int $a_type, ?int $a_value)
	Update current schedule (if flexible) More...

	getAllScheduleTypes ()
	Get all available schedule types. More...

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...

	isManuallyExecutable ()

	hasCustomSettings ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)

	activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...

	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

Private Attributes
const	DEFAULT_INACTIVITY_PERIOD = 365

int	$period

array	$include_roles

ilSetting	$settings

ilLanguage	$lng

ilRbacReview	$rbacReview

ilObjectDataCache	$objectDataCache

ILIAS HTTP GlobalHttpState	$http

ILIAS Refinery Factory	$refinery

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_MINUTES = 2
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_HOURS = 3
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_DAYS = 4
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_WEEKLY = 5
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_MONTHLY = 6
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_QUARTERLY = 7
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_YEARLY = 8
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

Protected Attributes inherited from ilCronJob
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Definition at line 28 of file class.ilCronDeleteInactivatedUserAccounts.php.

Constructor & Destructor Documentation

◆ __construct()

ilCronDeleteInactivatedUserAccounts::__construct ( )

Definition at line 41 of file class.ilCronDeleteInactivatedUserAccounts.php.

    {
        global $DIC;
 
        if ($DIC) {
            if (isset($DIC['http'])) {
                $this->http = $DIC->http();
            }
 
            if (isset($DIC['lng'])) {
                $this->lng = $DIC->language();
            }
 
            if (isset($DIC['refinery'])) {
                $this->refinery = $DIC->refinery();
            }
 
            if (isset($DIC['ilObjDataCache'])) {
                $this->objectDataCache = $DIC['ilObjDataCache'];
            }
 
            if (isset($DIC['rbacreview'])) {
                $this->rbacReview = $DIC->rbac()->review();
            }
 
            $rbacreview = $DIC->rbac()->review();
            $ilObjDataCache = $DIC['ilObjDataCache'];
 
            if ($DIC['ilSetting']) {
                $this->settings = $DIC->settings();
 
                $include_roles = $this->settings->get(
                    'cron_inactivated_user_delete_include_roles',
                    null
                );
                if ($include_roles === null) {
                    $this->include_roles = [];
                } else {
                    $this->include_roles = array_filter(array_map('intval', explode(',', $include_roles)));
                }
 
                $this->period = (int) $this->settings->get(
                    'cron_inactivated_user_delete_period',
                    (string) self::DEFAULT_INACTIVITY_PERIOD
                );
            }
        }
    }

References $DIC, $include_roles, DEFAULT_INACTIVITY_PERIOD, ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ addCustomSettingsToForm()

ilCronDeleteInactivatedUserAccounts::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Reimplemented from ilCronJob.

Definition at line 177 of file class.ilCronDeleteInactivatedUserAccounts.php.

                                                                      : void
    {
        $sub_mlist = new ilMultiSelectInputGUI(
            $this->lng->txt('delete_inactivated_user_accounts_include_roles'),
            'cron_inactivated_user_delete_include_roles'
        );
        $sub_mlist->setInfo($this->lng->txt('delete_inactivated_user_accounts_include_roles_desc'));
        $roles = [];
        foreach ($this->rbacReview->getGlobalRoles() as $role_id) {
            if ($role_id !== ANONYMOUS_ROLE_ID) {
                $roles[$role_id] = $this->objectDataCache->lookupTitle($role_id);
            }
        }
        $sub_mlist->setOptions($roles);
        $setting = $this->settings->get('cron_inactivated_user_delete_include_roles', null);
        if ($setting === null) {
            $setting = [];
        } else {
            $setting = explode(',', $setting);
        }
        $sub_mlist->setValue($setting);
        $sub_mlist->setWidth(300);
        $a_form->addItem($sub_mlist);
 
        $sub_text = new ilNumberInputGUI(
            $this->lng->txt('delete_inactivated_user_accounts_period'),
            'cron_inactivated_user_delete_period'
        );
        $sub_text->allowDecimals(false);
        $sub_text->setInfo($this->lng->txt('delete_inactivated_user_accounts_period_desc'));
        $sub_text->setValue(
            $this->settings->get(
                'cron_inactivated_user_delete_period',
                (string) self::DEFAULT_INACTIVITY_PERIOD
            )
        );
        $sub_text->setSize(4);
        $sub_text->setMaxLength(4);
        $sub_text->setRequired(true);
        $a_form->addItem($sub_text);
    }

References ilPropertyFormGUI\addItem(), ANONYMOUS_ROLE_ID, ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilCronDeleteInactivatedUserAccounts::getDefaultScheduleType ( )

Reimplemented from ilCronJob.

Definition at line 108 of file class.ilCronDeleteInactivatedUserAccounts.php.

                                            : int
    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilCronDeleteInactivatedUserAccounts::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

Definition at line 113 of file class.ilCronDeleteInactivatedUserAccounts.php.

                                             : ?int
    {
        return null;
    }

◆ getDescription()

ilCronDeleteInactivatedUserAccounts::getDescription ( )

Reimplemented from ilCronJob.

Definition at line 100 of file class.ilCronDeleteInactivatedUserAccounts.php.

                                    : string
    {
        return sprintf(
            $this->lng->txt("delete_inactivated_user_accounts_desc"),
            $this->period
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilCronDeleteInactivatedUserAccounts::getId ( )

Reimplemented from ilCronJob.

Definition at line 90 of file class.ilCronDeleteInactivatedUserAccounts.php.

                           : string
    {
        return "user_inactivated";
    }

◆ getTitle()

ilCronDeleteInactivatedUserAccounts::getTitle ( )

Reimplemented from ilCronJob.

Definition at line 95 of file class.ilCronDeleteInactivatedUserAccounts.php.

                              : string
    {
        return $this->lng->txt("delete_inactivated_user_accounts");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasAutoActivation()

ilCronDeleteInactivatedUserAccounts::hasAutoActivation ( )

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ilCronJob.

Definition at line 118 of file class.ilCronDeleteInactivatedUserAccounts.php.

                                       : bool
    {
        return false;
    }

◆ hasCustomSettings()

ilCronDeleteInactivatedUserAccounts::hasCustomSettings ( )

Reimplemented from ilCronJob.

Definition at line 128 of file class.ilCronDeleteInactivatedUserAccounts.php.

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilCronDeleteInactivatedUserAccounts::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

Definition at line 123 of file class.ilCronDeleteInactivatedUserAccounts.php.

                                         : bool
    {
        return true;
    }

◆ run()

ilCronDeleteInactivatedUserAccounts::run ( )

Reimplemented from ilCronJob.

Definition at line 133 of file class.ilCronDeleteInactivatedUserAccounts.php.

                         : ilCronJobResult
    {
        global $DIC;
 
        $rbacreview = $DIC->rbac()->review();
 
        $status = ilCronJobResult::STATUS_NO_ACTION;
 
        $usr_ids = ilObjUser::_getUserIdsByInactivationPeriod($this->period);
 
        $counter = 0;
        foreach ($usr_ids as $usr_id) {
            if ($usr_id === ANONYMOUS_USER_ID || $usr_id === SYSTEM_USER_ID) {
                continue;
            }
 
            $continue = true;
            foreach ($this->include_roles as $role_id) {
                if ($rbacreview->isAssigned($usr_id, $role_id)) {
                    $continue = false;
                    break;
                }
            }
 
            if ($continue) {
                continue;
            }
 
            $user = ilObjectFactory::getInstanceByObjId($usr_id);
            $user->delete();
 
            $counter++;
        }
 
        if ($counter > 0) {
            $status = ilCronJobResult::STATUS_OK;
        }
 
        $result = new ilCronJobResult();
        $result->setStatus($status);
 
        return $result;
    }

References $DIC, ilObjUser\_getUserIdsByInactivationPeriod(), ANONYMOUS_USER_ID, ilObjectFactory\getInstanceByObjId(), ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, and SYSTEM_USER_ID.

Here is the call graph for this function:

◆ saveCustomSettings()

ilCronDeleteInactivatedUserAccounts::saveCustomSettings ( ilPropertyFormGUI $a_form )

Reimplemented from ilCronJob.

Definition at line 219 of file class.ilCronDeleteInactivatedUserAccounts.php.

                                                                 : bool
    {
        $roles = implode(',', $this->http->wrapper()->post()->retrieve(
            'cron_inactivated_user_delete_include_roles',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                $this->refinery->always([])
            ])
        ));
 
        $period = $this->http->wrapper()->post()->retrieve(
            'cron_inactivated_user_delete_period',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->int(),
                $this->refinery->always(null)
            ])
        );
 
        $this->settings->set('cron_inactivated_user_delete_include_roles', $roles);
        $this->settings->set('cron_inactivated_user_delete_period', (string) ($period ?? self::DEFAULT_INACTIVITY_PERIOD));
 
        return true;
    }