Inheritance diagram for ilTimingsCronReminder:

Collaboration diagram for ilTimingsCronReminder:

Public Member Functions
	__construct ()
	Constructor. More...

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

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

	hasFlexibleSchedule ()

	hasCustomSettings ()

	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 Member Functions
	gatherUsers ()
	Read all active users. More...

	gatherUsersWithExceededTimings ()

	getNewExceededObjectForUser ()

	getFreshlyStartedObjectsForUser ()

	buildExceededMails (array $users_with_exceeded_objects)

	buildFreshlyStartedMails (array $users_with_freshly_started_objects)

	buildTopMailBody (int $user_id, string $language_variable)

	fillObjectListForMailBody (array $objects, ilTemplate $tpl)

	getUserLanguage (int $user_id)

	buildMailSalutation (int $user_id, ilTemplate $tpl)

	sendExceededMail (int $user_id, array $ref_ids, string $mail_body)

	sendFreshlyStartedMail (int $user_id, array $ref_ids, string $mail_body)

	markExceededInDatabase (int $user_id, array $ref_ids)

	markFreshlyStartedInDatabase (int $user_id, array $ref_ids)

	getAlreadySentNotifications (int $user_id, bool $for_exceeded=true)

	getInformationForRefId (int $ref_id)

	getExceededObjectsForUser (int $user_id)

	getObjectsWithTimingsForUser (int $user_id)

	hasUserActivatedNotification (int $user_id)

Protected Attributes
ilLogger	$log

ilLanguage	$lng

ilLanguage	$user_lang

ilDBInterface	$db

ilObjectDataCache	$obj_data_cache

Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
array	$users_with_exceeded_timings

array	$users

int	$now

Static Private Attributes
static array	$objects_information

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTimingsCronReminder::__construct ( )

Constructor.

Definition at line 42 of file class.ilTimingsCronReminder.php.

    {
        global $DIC;
 
        $this->log = $DIC->logger()->crs();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('crs');
        $this->db = $DIC->database();
        $this->obj_data_cache = $DIC['ilObjDataCache'];
 
        self::$objects_information = [];
        $this->users_with_exceeded_timings = [];
        $this->users = [];
        $this->now = time();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ buildExceededMails()

ilTimingsCronReminder::buildExceededMails ( array $users_with_exceeded_objects )

protected

Definition at line 201 of file class.ilTimingsCronReminder.php.

                                                                             : void
    {
        $this->log->debug('Start.');
        if (is_array($users_with_exceeded_objects)) {
            $this->log->debug('...found ' . count($users_with_exceeded_objects));
            foreach ($users_with_exceeded_objects as $user_id => $exceeded_objects) {
                $tpl = $this->buildTopMailBody($user_id, 'timings_cron_reminder_exceeded_start');
                $has_exceeded = $this->fillObjectListForMailBody($exceeded_objects, $tpl);
 
                if ($has_exceeded) {
                    $this->sendExceededMail($user_id, $exceeded_objects, $tpl->get());
                    $this->log->debug('start sending exceeded mail to user: ' . $user_id);
                }
            }
        } else {
            $this->log->warning('no array given.');
        }
 
        $this->log->debug('end.');
    }

References $user_id, buildTopMailBody(), fillObjectListForMailBody(), and sendExceededMail().

Referenced by getNewExceededObjectForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFreshlyStartedMails()

ilTimingsCronReminder::buildFreshlyStartedMails ( array $users_with_freshly_started_objects )

protected

Definition at line 222 of file class.ilTimingsCronReminder.php.

                                                                                          : void
    {
        $this->log->debug('start.');
        if (is_array($users_with_freshly_started_objects)) {
            $this->log->debug('...found ' . count($users_with_freshly_started_objects));
            foreach ($users_with_freshly_started_objects as $user_id => $freshly_started_objects) {
                $tpl = $this->buildTopMailBody($user_id, 'timings_cron_reminder_freshly_start');
                $has_freshly_started = $this->fillObjectListForMailBody($freshly_started_objects, $tpl);
 
                if ($has_freshly_started) {
                    $this->sendFreshlyStartedMail($user_id, $freshly_started_objects, $tpl->get());
                }
            }
        } else {
            $this->log->debug('no array given.');
        }
 
        $this->log->debug('end.');
    }

References $user_id, buildTopMailBody(), fillObjectListForMailBody(), and sendFreshlyStartedMail().

Referenced by getFreshlyStartedObjectsForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildMailSalutation()

ilTimingsCronReminder::buildMailSalutation	(	int	$user_id,
		ilTemplate	$tpl
	)

protected

Definition at line 280 of file class.ilTimingsCronReminder.php.

                                                                         : void
    {
        $name = ilObjUser::_lookupName($user_id);
        if (is_array($name)) {
            $salutation = $this->user_lang->txt('mail_salutation_n') . ' ';
            if (($name['gender'] ?? "") != '') {
                $salutation .= $this->user_lang->txt('salutation_' . $name['gender']) . ' ';
            }
            if ($name['title'] != '') {
                $salutation .= $name['title'] . ' ';
            }
            $tpl->setVariable('SALUTATION', $salutation);
            $tpl->setVariable('FIRSTNAME', $name['firstname']);
            $tpl->setVariable('LASTNAME', $name['lastname']);
            $this->log->debug('Salutation: ' . $salutation . ' Firstname: ' . $name['firstname'] . ' Lastname: ' . $name['lastname']);
        } else {
            $this->log->debug('did not get an array from _lookupName.');
        }
    }

References $user_id, ilObjUser\_lookupName(), and HTML_Template_IT\setVariable().

Referenced by buildTopMailBody().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTopMailBody()

ilTimingsCronReminder::buildTopMailBody	(	int	$user_id,
		string	$language_variable
	)

protected

Definition at line 242 of file class.ilTimingsCronReminder.php.

                                                                                : ilTemplate
    {
        $this->log->debug('start...');
        $tpl = new ilTemplate('tpl.crs_timings_cron_reminder_mail.html', true, true, 'components/ILIAS/Course');
 
        $this->getUserLanguage($user_id);
        $this->buildMailSalutation($user_id, $tpl);
        $tpl->setVariable('START_BODY', $this->user_lang->txt($language_variable));
        $this->log->debug('for user: ' . $user_id . ' end.');
        return $tpl;
    }

References $user_id, buildMailSalutation(), and getUserLanguage().

Referenced by buildExceededMails(), and buildFreshlyStartedMails().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillObjectListForMailBody()

ilTimingsCronReminder::fillObjectListForMailBody	(	array	$objects,
		ilTemplate	$tpl
	)

protected

Definition at line 254 of file class.ilTimingsCronReminder.php.

                                                                                 : bool
    {
        $has_elements = false;
        foreach ($objects as $object_id => $object_details) {
            if ($object_details['type'] != 'fold') {
                $tpl->setCurrentBlock('items');
                $tpl->setVariable('HREF', $object_details['url']);
                $tpl->setVariable('ITEM_TITLE', $object_details['title']);
                $tpl->parseCurrentBlock();
                $has_elements = true;
            }
        }
        $tpl->setVariable('INSTALLATION_SIGNATURE', \ilMail::_getInstallationSignature());
        $this->log->debug('found elements: ' . $has_elements);
        return $has_elements;
    }

References ilMail\_getInstallationSignature(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by buildExceededMails(), and buildFreshlyStartedMails().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherUsers()

ilTimingsCronReminder::gatherUsers ( )

protected

Read all active users.

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

                                    : void
    {
        $now = time();
        $query = $this->db->queryF(
            'SELECT usr_id FROM usr_data WHERE 
                                                                        (active = 1 AND time_limit_unlimited = 1) OR 
                                                                        (active = 1 AND time_limit_unlimited = 0 AND time_limit_from < %s AND time_limit_until > %s)',
            ['integer', 'integer'],
            [$now, $now]
        );
        while ($row = $this->db->fetchAssoc($query)) {
            $usr_id = (int) $row['usr_id'];
            $this->users[$usr_id] = $usr_id;
        }
        $this->log->debug('Found ' . count($this->users) . ' users.');
    }

References $now, and ILIAS\Repository\int().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherUsersWithExceededTimings()

ilTimingsCronReminder::gatherUsersWithExceededTimings ( )

protected

Definition at line 136 of file class.ilTimingsCronReminder.php.

                                                       : void
    {
        $this->users_with_exceeded_timings = ilTimingsUser::lookupTimingsExceededByUser($this->users);
        $this->log->debug('Found ' . count($this->users_with_exceeded_timings) . ' users with exceeded timings.');
    }

References ilTimingsUser\lookupTimingsExceededByUser().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAlreadySentNotifications()

ilTimingsCronReminder::getAlreadySentNotifications	(	int	$user_id,
		bool	$for_exceeded = `true`
	)

protected

Definition at line 375 of file class.ilTimingsCronReminder.php.

                                                                                           : array
    {
        $ref_ids = [];
        $table = ilCourseConstants::CRON_TIMINGS_EXCEEDED_TABLE;
 
        if (!$for_exceeded) {
            $table = ilCourseConstants::CRON_TIMINGS_STARTED_TABLE;
        }
 
        $result = $this->db->queryF(
            'SELECT * FROM ' . $table . ' WHERE ' .
            'user_id = %s',
            ['integer'],
            [$user_id]
        );
 
        while ($record = $this->db->fetchAssoc($result)) {
            $ref_ids[$record['ref_id']] = $record['ref_id'];
        }
        return $ref_ids;
    }

References $user_id, ilCourseConstants\CRON_TIMINGS_EXCEEDED_TABLE, and ilCourseConstants\CRON_TIMINGS_STARTED_TABLE.

Referenced by getFreshlyStartedObjectsForUser(), and getNewExceededObjectForUser().

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilTimingsCronReminder::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

◆ getDefaultScheduleValue()

ilTimingsCronReminder::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                             : ?int
    {
        return null;
    }

◆ getDescription()

ilTimingsCronReminder::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getExceededObjectsForUser()

ilTimingsCronReminder::getExceededObjectsForUser ( int $user_id )

protected

Definition at line 415 of file class.ilTimingsCronReminder.php.

                                                              : array
    {
        $tmp = [];
        return ilTimingsUser::lookupTimings([$user_id], $tmp, true);
    }

References $user_id, and ilTimingsUser\lookupTimings().

Referenced by getNewExceededObjectForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFreshlyStartedObjectsForUser()

ilTimingsCronReminder::getFreshlyStartedObjectsForUser ( )

protected

Definition at line 168 of file class.ilTimingsCronReminder.php.

                                                        : void
    {
        $users_with_new_started_object = [];
 
        if (is_array($this->users) && $this->users !== []) {
            foreach ($this->users as $key => $user_id) {
                $objects = $this->getObjectsWithTimingsForUser($user_id);
                if (is_array($objects) && $objects !== []) {
                    $obj_data = [];
                    $already_notified = $this->getAlreadySentNotifications($user_id, false);
                    $this->log->debug('User_id ' . $user_id . ' was already notified for ' . count($already_notified) . ' elements ');
                    $objects = array_diff_key($objects, $already_notified);
                    foreach ($objects as $ref_id => $v) {
                        $obj_data[$ref_id] = $this->getInformationForRefId($ref_id);
 
                        if (is_array($v)) {
                            if ((isset($v['end']) && isset($v['start'])) && $v['end'] > $this->now) {
                                if ($v['start'] < $this->now) {
                                    $users_with_new_started_object[$user_id][$ref_id] = $obj_data[$ref_id];
                                }
                            } else {
                                $this->log->debug('End is already older than today no notification send for user_id ' . $user_id . ' on ref_id ' . $ref_id);
                            }
                        }
                    }
                }
            }
            $this->log->debug('Found ' . count($users_with_new_started_object) . ' users with freshly started timings.');
 
            $this->buildFreshlyStartedMails($users_with_new_started_object);
        }
    }

References $ref_id, $user_id, buildFreshlyStartedMails(), getAlreadySentNotifications(), getInformationForRefId(), and getObjectsWithTimingsForUser().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilTimingsCronReminder::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                           : string
    {
        return 'crs_timings_reminder';
    }

◆ getInformationForRefId()

ilTimingsCronReminder::getInformationForRefId ( int $ref_id )

protected

Definition at line 397 of file class.ilTimingsCronReminder.php.

                                                          : array
    {
        if (!array_key_exists($ref_id, self::$objects_information)) {
            $obj_id = $this->obj_data_cache->lookupObjId($ref_id);
            $type = $this->obj_data_cache->lookupType($obj_id);
            $value = [
                'title' => $this->obj_data_cache->lookupTitle($obj_id),
                'type' => $type,
                'url' => ilLink::_getLink($ref_id, $type),
                'obj_id' => $obj_id
            ];
            self::$objects_information[$ref_id] = $value;
 
            $this->log->debug('ilTimingsCronReminder->getInformationForRefId: ...cached object information for => ' . $value['type'] . ' => ' . $value['title']);
        }
        return self::$objects_information[$ref_id];
    }

References $ref_id.

Referenced by getFreshlyStartedObjectsForUser(), and getNewExceededObjectForUser().

Here is the caller graph for this function:

◆ getNewExceededObjectForUser()

ilTimingsCronReminder::getNewExceededObjectForUser ( )

protected

Definition at line 142 of file class.ilTimingsCronReminder.php.

                                                    : void
    {
        $users_with_exceeded_objects = [];
 
        if (is_array($this->users_with_exceeded_timings) && $this->users_with_exceeded_timings !== []) {
            foreach ($this->users_with_exceeded_timings as $key => $user_id) {
                $objects = $this->getExceededObjectsForUser($user_id);
                if (is_array($objects) && $objects !== []) {
                    $obj_data = [];
                    $already_notified = $this->getAlreadySentNotifications($user_id);
                    $objects = array_diff_key($objects, $already_notified);
                    foreach (array_keys($objects) as $ref_id) {
                        $detail_data = $this->getInformationForRefId($ref_id);
                        $obj_data[$ref_id] = $detail_data;
                    }
                    if ($obj_data !== []) {
                        $users_with_exceeded_objects[$user_id] = $obj_data;
                    }
                }
            }
            $this->log->debug('Found ' . count($users_with_exceeded_objects) . ' users with new exceeded timings.');
 
            $this->buildExceededMails($users_with_exceeded_objects);
        }
    }

References $ref_id, $user_id, buildExceededMails(), getAlreadySentNotifications(), getExceededObjectsForUser(), and getInformationForRefId().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjectsWithTimingsForUser()

ilTimingsCronReminder::getObjectsWithTimingsForUser ( int $user_id )

protected

Definition at line 421 of file class.ilTimingsCronReminder.php.

                                                                 : array
    {
        $meta = [];
        $timings_obj_list = ilTimingsUser::lookupTimings([$user_id], $meta, false);
        return $meta[$user_id] ?? [];
    }

References $user_id, and ilTimingsUser\lookupTimings().

Referenced by getFreshlyStartedObjectsForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilTimingsCronReminder::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getUserLanguage()

ilTimingsCronReminder::getUserLanguage ( int $user_id )

protected

Definition at line 271 of file class.ilTimingsCronReminder.php.

                                                    : void
    {
        $this->log->debug('start...');
        $this->user_lang = ilLanguageFactory::_getLanguageOfUser($user_id);
        $this->user_lang->loadLanguageModule('crs');
        $this->user_lang->loadLanguageModule('mail');
        $this->log->debug('user language for user ' . $user_id . ' is ' . $this->user_lang->getLangKey() . ' end.');
    }

References $user_id, and ilLanguageFactory\_getLanguageOfUser().

Referenced by buildTopMailBody().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAutoActivation()

ilTimingsCronReminder::hasAutoActivation ( )

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

Reimplemented from ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return false;
    }

◆ hasCustomSettings()

ilTimingsCronReminder::hasCustomSettings ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 93 of file class.ilTimingsCronReminder.php.

                                       : bool
    {
        return false;
    }

◆ hasFlexibleSchedule()

ilTimingsCronReminder::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                         : bool
    {
        return false;
    }

◆ hasUserActivatedNotification()

ilTimingsCronReminder::hasUserActivatedNotification ( int $user_id )

protected

Definition at line 428 of file class.ilTimingsCronReminder.php.

                                                                 : bool
    {
        return true;
    }

Referenced by sendExceededMail(), and sendFreshlyStartedMail().

Here is the caller graph for this function:

◆ markExceededInDatabase()

ilTimingsCronReminder::markExceededInDatabase	(	int	$user_id,
		array	$ref_ids
	)

protected

Definition at line 347 of file class.ilTimingsCronReminder.php.

                                                                           : void
    {
        foreach (array_keys($ref_ids) as $ref_id) {
            $this->db->manipulateF(
                'INSERT INTO ' . ilCourseConstants::CRON_TIMINGS_EXCEEDED_TABLE . ' (user_id, ref_id, sent) VALUES ' .
                ' (%s,%s,%s)',
                ['integer', 'integer', 'integer'],
                [$user_id, $ref_id, $this->now]
            );
 
            $this->log->debug('ilTimingsCronReminder->markExceededInDatabase: Marked exceeded in Database. User ' . $user_id . ' ref_id ' . $ref_id);
        }
    }

References $ref_id, $user_id, and ilCourseConstants\CRON_TIMINGS_EXCEEDED_TABLE.

Referenced by sendExceededMail().

Here is the caller graph for this function:

◆ markFreshlyStartedInDatabase()

ilTimingsCronReminder::markFreshlyStartedInDatabase	(	int	$user_id,
		array	$ref_ids
	)

protected

Definition at line 361 of file class.ilTimingsCronReminder.php.

                                                                                 : void
    {
        foreach (array_keys($ref_ids) as $ref_id) {
            $this->db->manipulateF(
                'INSERT INTO ' . ilCourseConstants::CRON_TIMINGS_STARTED_TABLE . ' (user_id, ref_id, sent) VALUES ' .
                ' (%s,%s,%s)',
                ['integer', 'integer', 'integer'],
                [$user_id, $ref_id, $this->now]
            );
 
            $this->log->debug('ilTimingsCronReminder->markFreshlyStartedInDatabase: Marked freshly started in Database. User ' . $user_id . ' ref_id ' . $ref_id);
        }
    }

References $ref_id, $user_id, and ilCourseConstants\CRON_TIMINGS_STARTED_TABLE.

Referenced by sendFreshlyStartedMail().

Here is the caller graph for this function:

◆ run()

ilTimingsCronReminder::run ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 98 of file class.ilTimingsCronReminder.php.

                         : JobResult
    {
        $this->log->debug('Start.');
 
        $result = new JobResult();
 
        $this->gatherUsers();
        $this->gatherUsersWithExceededTimings();
        $this->getNewExceededObjectForUser();
        $this->getFreshlyStartedObjectsForUser();
 
        $result->setStatus(JobResult::STATUS_OK);
 
        $this->log->debug('End');
 
        return $result;
    }

References gatherUsers(), gatherUsersWithExceededTimings(), getFreshlyStartedObjectsForUser(), and getNewExceededObjectForUser().

Here is the call graph for this function:

◆ sendExceededMail()

ilTimingsCronReminder::sendExceededMail	(	int	$user_id,
		array	$ref_ids,
		string	$mail_body
	)

protected

Definition at line 300 of file class.ilTimingsCronReminder.php.

                                                                                        : void
    {
        $login = \ilObjUser::_lookupLogin($user_id);
        if ($login != '') {
            $mail = new ilMail(ANONYMOUS_USER_ID);
            if ($this->hasUserActivatedNotification($user_id)) {
                $mail->enqueue(
                    $login,
                    '',
                    '',
                    $this->user_lang->txt('timings_cron_reminder_exceeded_subject'),
                    $mail_body,
                    [],
                    true
                );
                $this->log->debug('...mail send for user ' . $user_id . ' to mail ' . $login . ' has exceeded timings for ' . $mail_body);
                $this->markExceededInDatabase($user_id, $ref_ids);
            } else {
                $this->log->debug('... no mail was sent because user ' . $user_id . ' has deactivated their notifications and has no coaches assigned.');
            }
        } else {
            $this->log->debug('Not send. User ' . $user_id . ' has no email.');
        }
    }

References $user_id, ilObjUser\_lookupLogin(), ANONYMOUS_USER_ID, hasUserActivatedNotification(), and markExceededInDatabase().

Referenced by buildExceededMails().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendFreshlyStartedMail()

ilTimingsCronReminder::sendFreshlyStartedMail	(	int	$user_id,
		array	$ref_ids,
		string	$mail_body
	)

protected

Definition at line 325 of file class.ilTimingsCronReminder.php.

                                                                                              : void
    {
        $login = \ilObjUser::_lookupLogin($user_id);
 
        if ($login != '' && $this->hasUserActivatedNotification($user_id)) {
            $mail = new ilMail(ANONYMOUS_USER_ID);
            $mail->enqueue(
                $login,
                '',
                '',
                $this->user_lang->txt('timings_cron_reminder_started_subject'),
                $mail_body,
                [],
                true
            );
            $this->log->debug('...mail send for user ' . $user_id . ' to mail ' . $login . ' has freshly started timings for ' . $mail_body);
            $this->markFreshlyStartedInDatabase($user_id, $ref_ids);
        } else {
            $this->log->debug('Not send. User ' . $user_id . ' has no email.');
        }
    }

References $user_id, ilObjUser\_lookupLogin(), ANONYMOUS_USER_ID, hasUserActivatedNotification(), and markFreshlyStartedInDatabase().

Referenced by buildFreshlyStartedMails().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $db

ilDBInterface ilTimingsCronReminder::$db

protected

Definition at line 36 of file class.ilTimingsCronReminder.php.

◆ $lng

ilLanguage ilTimingsCronReminder::$lng

protected

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

◆ $log

ilLogger ilTimingsCronReminder::$log

protected

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

◆ $now

int ilTimingsCronReminder::$now

private

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

Referenced by gatherUsers().

◆ $obj_data_cache

ilObjectDataCache ilTimingsCronReminder::$obj_data_cache

protected

Definition at line 37 of file class.ilTimingsCronReminder.php.

◆ $objects_information

array ilTimingsCronReminder::$objects_information

staticprivate

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

◆ $user_lang

ilLanguage ilTimingsCronReminder::$user_lang

protected

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

◆ $users

array ilTimingsCronReminder::$users

private

Definition at line 30 of file class.ilTimingsCronReminder.php.

◆ $users_with_exceeded_timings

array ilTimingsCronReminder::$users_with_exceeded_timings

private

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

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

components/ILIAS/Course/classes/class.ilTimingsCronReminder.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildExceededMails()

◆ buildFreshlyStartedMails()

◆ buildMailSalutation()

◆ buildTopMailBody()

◆ fillObjectListForMailBody()

◆ gatherUsers()

◆ gatherUsersWithExceededTimings()

◆ getAlreadySentNotifications()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getExceededObjectsForUser()

◆ getFreshlyStartedObjectsForUser()

◆ getId()

◆ getInformationForRefId()

◆ getNewExceededObjectForUser()

◆ getObjectsWithTimingsForUser()

◆ getTitle()

◆ getUserLanguage()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ hasUserActivatedNotification()

◆ markExceededInDatabase()

◆ markFreshlyStartedInDatabase()

◆ run()

◆ sendExceededMail()

◆ sendFreshlyStartedMail()

Field Documentation

◆ $db

◆ $lng

◆ $log

◆ $now

◆ $obj_data_cache

◆ $objects_information

◆ $user_lang

◆ $users

◆ $users_with_exceeded_timings