ilUserCronCheckAccounts Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilUserCronCheckAccounts:

Collaboration diagram for ilUserCronCheckAccounts:

Public Member Functions
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
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 ()

Protected Member Functions
	txt (string $language, string $key, string $module='common')
	checkNotConfirmedUserAccounts ()

Protected Attributes
int	$counter = 0
Protected Attributes inherited from ilCronJob
int	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_MINUTES = 2
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_HOURS = 3
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_DAYS = 4
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_WEEKLY = 5
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_MONTHLY = 6
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_QUARTERLY = 7
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_YEARLY = 8
	This will be replaced with an ENUM in ILIAS 9 More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 23 of file class.ilUserCronCheckAccounts.php.

Member Function Documentation

checkNotConfirmedUserAccounts()

ilUserCronCheckAccounts::checkNotConfirmedUserAccounts ( )

protected

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

References $DIC, $ilDB, $query, $res, and ilObjectFactory\getInstanceByObjId().

Referenced by hasFlexibleSchedule().

                                                      : void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilLog = $DIC['ilLog'];

        $oRegSettigs = 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 = $ilDB->queryF(
            $query,
            array('text', 'integer', 'timestamp'),
            array('', 0, date('Y-m-d H:i:s', time() - $oRegSettigs->getRegistrationHashLifetime()))
        );
        while ($row = $ilDB->fetchAssoc($res)) {
            $oUser = ilObjectFactory::getInstanceByObjId((int) $row['usr_id']);
            $oUser->delete();
            $ilLog->write('Cron: Deleted ' . $oUser->getLogin() . ' [' . $oUser->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 50 of file class.ilUserCronCheckAccounts.php.

                                            : int
    {
        return self::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilUserCronCheckAccounts::getDefaultScheduleValue

(

)

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

                                             : ?int
    {
        return null;
    }

getDescription()

ilUserCronCheckAccounts::getDescription

(

)

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

References $DIC, and $lng.

                                    : string
    {
        global $DIC;

        $lng = $DIC['lng'];

        return $lng->txt("check_user_accounts_desc");
    }

getId()

ilUserCronCheckAccounts::getId

(

)

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

                           : string
    {
        return "user_check_accounts";
    }

getTitle()

ilUserCronCheckAccounts::getTitle

(

)

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

References $DIC, and $lng.

                              : string
    {
        global $DIC;

        $lng = $DIC['lng'];

        return $lng->txt("check_user_accounts");
    }

hasAutoActivation()

ilUserCronCheckAccounts::hasAutoActivation

(

)

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

                                       : bool
    {
        return false;
    }

hasFlexibleSchedule()

ilUserCronCheckAccounts::hasFlexibleSchedule

(

)

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

References $DIC, $GLOBALS, $ilDB, $lng, $query, $res, ilMail\_getAutoGeneratedMessageString(), ilLanguageFactory\_getLanguageOfUser(), ilObjUser\_lookupEmail(), ANONYMOUS_USER_ID, checkNotConfirmedUserAccounts(), ilMail\getSalutation(), ilCronJob\run(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

                                         : bool
    {
        return false;
    }

Here is the call graph for this function:

txt()

ilUserCronCheckAccounts::txt ( string  $language, string  $key, string  $module = 'common'  )

protected

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

References ilLanguage\_lookupEntry().

     : string {
        return ilLanguage::_lookupEntry($language, $module, $key);
    }

Here is the call graph for this function:

Field Documentation

$counter

int ilUserCronCheckAccounts::$counter = 0

protected

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

---

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

• Services/User/classes/class.ilUserCronCheckAccounts.php