ilUserCronCheckAccounts Class Reference

This cron send notifications about expiring user accounts. More...

Inheritance diagram for ilUserCronCheckAccounts:

Collaboration diagram for ilUserCronCheckAccounts:

Public Member Functions
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
	hasFlexibleSchedule ()
	run ()
Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)
	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $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 (?JobScheduleType $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 ()
	usesLegacyForms ()
	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)
	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)
	saveCustomConfiguration (mixed $form_data)
	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 ()

Protected Attributes
int	$counter = 0
Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Private Attributes
ilDBInterface	$db
ilLanguage	$lng
ilComponentLogger	$log

Detailed Description

This cron send notifications about expiring user accounts.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 29 of file class.ilUserCronCheckAccounts.php.

Member Function Documentation

getDefaultScheduleType()

ilUserCronCheckAccounts::getDefaultScheduleType

(

)

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 70 of file class.ilUserCronCheckAccounts.php.

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

getDefaultScheduleValue()

ilUserCronCheckAccounts::getDefaultScheduleValue

(

)

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 75 of file class.ilUserCronCheckAccounts.php.

                                             : ?int
    {
        return null;
    }

getDescription()

ilUserCronCheckAccounts::getDescription

(

)

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 65 of file class.ilUserCronCheckAccounts.php.

                                    : string
    {
        return $this->lng->txt('check_user_accounts_desc');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getId()

ilUserCronCheckAccounts::getId

(

)

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 55 of file class.ilUserCronCheckAccounts.php.

                           : string
    {
        return 'user_check_accounts';
    }

getTitle()

ilUserCronCheckAccounts::getTitle

(

)

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 60 of file class.ilUserCronCheckAccounts.php.

                              : string
    {
        return $this->lng->txt('check_user_accounts');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

hasAutoActivation()

ilUserCronCheckAccounts::hasAutoActivation

(

)

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

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 80 of file class.ilUserCronCheckAccounts.php.

                                       : bool
    {
        return false;
    }

hasFlexibleSchedule()

ilUserCronCheckAccounts::hasFlexibleSchedule

(

)

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 85 of file class.ilUserCronCheckAccounts.php.

                                         : bool
    {
        return false;
    }

run()

ilUserCronCheckAccounts::run

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                         : JobResult
    {
        $status = JobResult::STATUS_NO_ACTION;
 
        $now = time();
        $two_weeks_in_seconds = $now + (60 * 60 * 24 * 14); // #14630
 
        // all users who are currently active and expire in the next 2 weeks
        $query = 'SELECT usr_id, login, time_limit_until ' .
            'FROM usr_data ' .
            'WHERE expiration_reminder_sent = 0 ' .
            'AND time_limit_unlimited = 0 ' .
            'AND time_limit_from < ' . $this->db->quote($now, 'integer') . ' ' .
            'AND time_limit_until > ' . $this->db->quote($now, 'integer') . ' ' .
            'AND time_limit_until < ' . $this->db->quote($two_weeks_in_seconds, 'integer');
 
        $res = $this->db->query($query);
 
        while ($row = $this->db->fetchObject($res)) {
            $expires = $row->time_limit_until;
            $login = $row->login;
            $usr_id = $row->usr_id;
 
            $lng = ilLanguageFactory::_getLanguageOfUser($usr_id);
            $lng->loadLanguageModule('mail');
 
            $salutation = ilMail::getSalutation($usr_id, $lng);
 
            $body = $salutation . "\n\n";
            $body .= sprintf(
                $lng->txt('account_expires_body'),
                $login,
                ILIAS_HTTP_PATH,
                date('Y-m-d H:i', $expires)
            );
 
            $body .= "\n\n" . ilMail::_getAutoGeneratedMessageString($lng);
 
            // force email
            $mail = new ilMail(ANONYMOUS_USER_ID);
            $mail->enqueue(
                ilObjUser::_lookupEmail($usr_id),
                '',
                '',
                $lng->txt('account_expires_subject'),
                $body,
                []
            );
 
            // set status 'mail sent'
            $query = 'UPDATE usr_data SET expiration_reminder_sent = 1' . PHP_EOL
                . "WHERE usr_id = {$this->db->quote($usr_id, ilDBConstants::T_INTEGER)}";
            $this->db->query($query);
 
            // Send log message
            $this->log->write('Cron: (checkUserAccounts()) sent message to ' . $login . '.');
 
            $this->counter++;
        }
 
        if ($this->counter) {
            $status = JobResult::STATUS_OK;
        }
        $result = new JobResult();
        $result->setStatus($status);
        return $result;
    }

References $lng, $res, ilMail\_getAutoGeneratedMessageString(), ilLanguageFactory\_getLanguageOfUser(), ilObjUser\_lookupEmail(), ANONYMOUS_USER_ID, ilMail\getSalutation(), ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Here is the call graph for this function:

Field Documentation

$counter

int ilUserCronCheckAccounts::$counter = 0

protected

Definition at line 31 of file class.ilUserCronCheckAccounts.php.

$db

ilDBInterface ilUserCronCheckAccounts::$db

private

Definition at line 33 of file class.ilUserCronCheckAccounts.php.

$lng

ilLanguage ilUserCronCheckAccounts::$lng

private

Definition at line 34 of file class.ilUserCronCheckAccounts.php.

Referenced by run().

$log

ilComponentLogger ilUserCronCheckAccounts::$log

private

Definition at line 35 of file class.ilUserCronCheckAccounts.php.

---

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

• components/ILIAS/User/classes/Cron/class.ilUserCronCheckAccounts.php