Inheritance diagram for ilCronDeleteInactivatedUserAccounts:

Collaboration diagram for ilCronDeleteInactivatedUserAccounts:

Public Member Functions
	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	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, ?CronJobScheduleType $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 (?CronJobScheduleType $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	$rbac_review

ilObjectDataCache	$objectDataCache

ILIAS HTTP GlobalHttpState	$http

ILIAS Refinery Factory	$refinery

Additional Inherited Members
Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

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

Member Function Documentation

◆ addCustomSettingsToForm()

ilCronDeleteInactivatedUserAccounts::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

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

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

                                                                       : 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->rbac_review->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);
     }

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilCronDeleteInactivatedUserAccounts::getDefaultScheduleType ( )

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

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilCronDeleteInactivatedUserAccounts::getDefaultScheduleValue ( )

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

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilCronDeleteInactivatedUserAccounts::getDescription ( )

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

References $period, and ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ getId()

ilCronDeleteInactivatedUserAccounts::getId ( )

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

                            : string
     {
         return "user_inactivated";
     }

◆ getTitle()

ilCronDeleteInactivatedUserAccounts::getTitle ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilCronDeleteInactivatedUserAccounts::hasAutoActivation ( )

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

                                        : bool
     {
         return false;
     }

◆ hasCustomSettings()

ilCronDeleteInactivatedUserAccounts::hasCustomSettings ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilCronDeleteInactivatedUserAccounts::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ run()

ilCronDeleteInactivatedUserAccounts::run ( )

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

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

                          : ilCronJobResult
     {
         $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;
             }
 
             foreach ($this->include_roles as $role_id) {
                 if ($this->rbac_review->isAssigned($usr_id, $role_id)) {
                     $user = ilObjectFactory::getInstanceByObjId($usr_id);
                     $user->delete();
                     $counter++;
                     break;
                 }
             }
         }
 
         if ($counter > 0) {
             $status = ilCronJobResult::STATUS_OK;
         }
 
         $result = new ilCronJobResult();
         $result->setStatus($status);
 
         return $result;
     }

Here is the call graph for this function:

◆ saveCustomSettings()

ilCronDeleteInactivatedUserAccounts::saveCustomSettings ( ilPropertyFormGUI $a_form )

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

References ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

                                                                  : 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;
     }