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 ()
	hasFlexibleSchedule ()
	run ()
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 ()

Protected Member Functions
	checkNotConfirmedUserAccounts ()

Protected Attributes
int	$counter = 0
Protected Attributes inherited from ilCronJob
CronJobScheduleType	$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 27 of file class.ilUserCronCheckAccounts.php.

Member Function Documentation

checkNotConfirmedUserAccounts()

ilUserCronCheckAccounts::checkNotConfirmedUserAccounts ( )

protected

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

References $res, and ilObjectFactory\getInstanceByObjId().

Referenced by run().

                                                      : void
    {
        $registration_settings = new ilRegistrationSettings();

        $query = 'SELECT usr_id FROM usr_data '
               . 'WHERE (reg_hash IS NOT NULL AND reg_hash != %s)'
               . 'AND active = %s '
               . 'AND create_date < %s';
        $res = $this->db->queryF(
            $query,
            ['text', 'integer', 'timestamp'],
            ['', 0, date('Y-m-d H:i:s', time() - $registration_settings->getRegistrationHashLifetime())]
        );
        while ($row = $this->db->fetchAssoc($res)) {
            $user = ilObjectFactory::getInstanceByObjId((int) $row['usr_id']);
            $user->delete();
            $this->log->write('Cron: Deleted ' . $user->getLogin() . ' [' . $user->getId() . '] ' . __METHOD__);

            $this->counter++;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultScheduleType()

ilUserCronCheckAccounts::getDefaultScheduleType

(

)

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

                                            : CronJobScheduleType
    {
        return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilUserCronCheckAccounts::getDefaultScheduleValue

(

)

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

                                             : ?int
    {
        return null;
    }

getDescription()

ilUserCronCheckAccounts::getDescription

(

)

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

getId()

ilUserCronCheckAccounts::getId

(

)

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

                           : string
    {
        return 'user_check_accounts';
    }

getTitle()

ilUserCronCheckAccounts::getTitle

(

)

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

hasAutoActivation()

ilUserCronCheckAccounts::hasAutoActivation

(

)

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

                                       : bool
    {
        return false;
    }

hasFlexibleSchedule()

ilUserCronCheckAccounts::hasFlexibleSchedule

(

)

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

                                         : bool
    {
        return false;
    }

run()

ilUserCronCheckAccounts::run

(

)

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

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

                         : ilCronJobResult
    {
        $status = ilCronJobResult::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 time_limit_message = "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 time_limit_message = "1" WHERE usr_id = "' . $usr_id . '"';
            $this->db->query($query);

            // Send log message
            $this->log->write('Cron: (checkUserAccounts()) sent message to ' . $login . '.');

            $this->counter++;
        }

        $this->checkNotConfirmedUserAccounts();

        if ($this->counter) {
            $status = ilCronJobResult::STATUS_OK;
        }
        $result = new ilCronJobResult();
        $result->setStatus($status);
        return $result;
    }

Here is the call graph for this function:

Field Documentation

$counter

int ilUserCronCheckAccounts::$counter = 0

protected

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

$db

ilDBInterface ilUserCronCheckAccounts::$db

private

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

$lng

ilLanguage ilUserCronCheckAccounts::$lng

private

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

$log

ilComponentLogger ilUserCronCheckAccounts::$log

private

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

---

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

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