Inheritance diagram for ilCronDeleteInactivatedUserAccounts:

Collaboration diagram for ilCronDeleteInactivatedUserAccounts:

Public Member Functions
	__construct ()

	getId ()
	Get id. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	run ()
	Run job. More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

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

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

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

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

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Data Fields
const	DEFAULT_INACTIVITY_PERIOD = 365

Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Private Attributes
	$period = null

	$include_roles = null

Additional Inherited Members
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilCronDeleteInactivatedUserAccounts::__construct ( )

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

    {
        global $ilSetting;
 
        if (is_object($ilSetting)) {
            $this->include_roles = $ilSetting->get(
                'cron_inactivated_user_delete_include_roles',
                null
            );
            if ($this->include_roles === null) {
                $this->include_roles = array();
            } else {
                $this->include_roles = explode(',', $this->include_roles);
            }
 
            $this->period = $ilSetting->get(
                'cron_inactivated_user_delete_period',
                self::DEFAULT_INACTIVITY_PERIOD
            );
        }
    }

References $ilSetting.

Member Function Documentation

◆ addCustomSettingsToForm()

ilCronDeleteInactivatedUserAccounts::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Add custom settings to form.

Parameters

ilPropertyFormGUI $a_form

Reimplemented from ilCronJob.

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

    {
        global $lng, $rbacreview, $ilObjDataCache, $ilSetting;
 
        include_once('Services/Form/classes/class.ilMultiSelectInputGUI.php');
        $sub_mlist = new ilMultiSelectInputGUI(
            $lng->txt('delete_inactivated_user_accounts_include_roles'),
            'cron_inactivated_user_delete_include_roles'
        );
        $sub_mlist->setInfo($lng->txt('delete_inactivated_user_accounts_include_roles_desc'));
        $roles = array();
        foreach ($rbacreview->getGlobalRoles() as $role_id) {
            if ($role_id != ANONYMOUS_ROLE_ID) {
                $roles[$role_id] = $ilObjDataCache->lookupTitle($role_id);
            }
        }
        $sub_mlist->setOptions($roles);
        $setting = $ilSetting->get('cron_inactivated_user_delete_include_roles', null);
        if ($setting === null) {
            $setting = array();
        } else {
            $setting = explode(',', $setting);
        }
        $sub_mlist->setValue($setting);
        $sub_mlist->setWidth(300);
        #$sub_mlist->setHeight(100);
        $a_form->addItem($sub_mlist);
 
        $default_setting = self::DEFAULT_INACTIVITY_PERIOD;
        $sub_text = new ilNumberInputGUI(
            $lng->txt('delete_inactivated_user_accounts_period'),
            'cron_inactivated_user_delete_period'
        );
        $sub_text->allowDecimals(false);
        $sub_text->setInfo($lng->txt('delete_inactivated_user_accounts_period_desc'));
        $sub_text->setValue($ilSetting->get("cron_inactivated_user_delete_period", $default_setting));
        $sub_text->setSize(4);
        $sub_text->setMaxLength(4);
        $sub_text->setRequired(true);
        $a_form->addItem($sub_text);
        
        /*
        $default_setting = ilCronDeleteInactiveUserAccounts::DEFAULT_SETTING_INCLUDE_ADMINS;
        $sub_cb = new ilCheckboxInputGUI($lng->txt('delete_inactivated_user_accounts_include_admins'),'cron_inactivated_user_delete_include_admins');
        $sub_cb->setChecked($ilSetting->get("cron_inactivated_user_delete_include_admins", $default_setting) ? 1 : 0 );
        //$sub_cb->setOptionTitle($lng->txt('delete_inactivated_user_accounts_include_admins'));
        $sub_cb->setInfo($lng->txt('delete_inactivated_user_accounts_include_admins_desc'));
        $a_form->addItem($sub_cb);
        */
    }

References $ilSetting, $lng, ilPropertyFormGUI\addItem(), and DEFAULT_INACTIVITY_PERIOD.

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilCronDeleteInactivatedUserAccounts::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilCronDeleteInactivatedUserAccounts::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

◆ getDescription()

ilCronDeleteInactivatedUserAccounts::getDescription ( )

Get description.

Returns: string

Reimplemented from ilCronJob.

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

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

References $lng, and sprintf.

◆ getId()

ilCronDeleteInactivatedUserAccounts::getId ( )

Get id.

Returns: string

Reimplemented from ilCronJob.

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

    {
        return "user_inactivated";
    }

◆ getTitle()

ilCronDeleteInactivatedUserAccounts::getTitle ( )

Get title.

Returns: string

Reimplemented from ilCronJob.

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

    {
        global $lng;
        
        return $lng->txt("delete_inactivated_user_accounts");
    }

References $lng.

◆ hasAutoActivation()

ilCronDeleteInactivatedUserAccounts::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

◆ hasCustomSettings()

ilCronDeleteInactivatedUserAccounts::hasCustomSettings ( )

Has cron job any custom setting which can be edited?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ hasFlexibleSchedule()

ilCronDeleteInactivatedUserAccounts::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ run()

ilCronDeleteInactivatedUserAccounts::run ( )

Run job.

Returns: ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        global $rbacreview;
        
        $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) {
            $status = ilCronJobResult::STATUS_OK;
        }
        $result = new ilCronJobResult();
        $result->setStatus($status);
        return $result;
    }

References $counter, $result, ilObjUser\_getUserIdsByInactivationPeriod(), ilObjectFactory\getInstanceByObjId(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

Here is the call graph for this function:

◆ saveCustomSettings()

ilCronDeleteInactivatedUserAccounts::saveCustomSettings ( ilPropertyFormGUI $a_form )

Save custom settings.

Parameters

ilPropertyFormGUI $a_form

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        global $ilSetting;
 
        $setting = implode(',', $_POST['cron_inactivated_user_delete_include_roles']);
        if (!strlen($setting)) {
            $setting = null;
        }
        $ilSetting->set('cron_inactivated_user_delete_include_roles', $setting);
        $ilSetting->set('cron_inactivated_user_delete_period', $_POST['cron_inactivated_user_delete_period']);
        
        return true;
    }

References $_POST, and $ilSetting.

Field Documentation

◆ $include_roles

ilCronDeleteInactivatedUserAccounts::$include_roles = null

private

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

◆ $period

ilCronDeleteInactivatedUserAccounts::$period = null

private

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

◆ DEFAULT_INACTIVITY_PERIOD

const ilCronDeleteInactivatedUserAccounts::DEFAULT_INACTIVITY_PERIOD = 365

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

Referenced by addCustomSettingsToForm().

The documentation for this class was generated from the following file:

Services/User/classes/class.ilCronDeleteInactivatedUserAccounts.php

Public Member Functions

Data Fields

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomSettingsToForm()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ run()

◆ saveCustomSettings()

Field Documentation

◆ $include_roles

◆ $period

◆ DEFAULT_INACTIVITY_PERIOD