Inheritance diagram for ilTimingsCronReminder:

Collaboration diagram for ilTimingsCronReminder:

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

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	hasCustomSettings ()

	run ()

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...

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

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. 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...

Protected Member Functions
	gatherUsers ()
	Read all active users. More...

	gatherUsersWithExceededTimings ()
	Users with exceeded timings. More...

	getNewExceededObjectForUser ()
	get new exceeded objects for users More...

	getFreshlyStartedObjectsForUser ()
	Get freshly started objects. More...

	buildExceededMails ($users_with_exceeded_objects)

	buildFreshlyStartedMails ($users_with_freshly_started_objects)

	buildTopMailBody ($user_id, $language_variable)

	fillObjectListForMailBody ($objects, $tpl)

	getUserLanguage ($user_id)

	buildMailSalutation ($user_id, $tpl)

	sendExceededMail ($user_id, $ref_ids, $mail_body)

	sendFreshlyStartedMail ($user_id, $ref_ids, $mail_body)

	markExceededInDatabase ($user_id, $ref_ids)

	markFreshlyStartedInDatabase ($user_id, $ref_ids)

	getAlreadySentNotifications ($user_id, $for_exceeded=true)

	getInformationForRefId ($ref_id)

	getExceededObjectsForUser ($user_id)

	getObjectsWithTimingsForUser ($user_id)

	hasUserActivatedNotification ($user_id)

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

Protected Attributes
	$log

	$lng

	$user_lang

	$db

	$obj_data_cache

	$users_with_exceeded_timings

	$users

	$now

Static Protected Attributes
static	$objects_information

static	$coaches_emails

Additional Inherited Members
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

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTimingsCronReminder::__construct ( )

Constructor.

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

References $DIC, $ilDB, and $lng.

     {
         global $DIC;
         global $ilObjDataCache, $lng, $ilDB;
 
         $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 = array();
         self::$coaches_emails = array();
         $this->users_with_exceeded_timings = array();
         $this->users = array();
         $this->now = time();
     }

Member Function Documentation

◆ buildExceededMails()

ilTimingsCronReminder::buildExceededMails ( $users_with_exceeded_objects )

protected

Parameters

array $users_with_exceeded_objects

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

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

Referenced by getNewExceededObjectForUser().

     {
         $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.');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFreshlyStartedMails()

ilTimingsCronReminder::buildFreshlyStartedMails ( $users_with_freshly_started_objects )

protected

Parameters

array $users_with_freshly_started_objects

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

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

Referenced by getFreshlyStartedObjectsForUser().

     {
         $this->log->debug('start.');
         if (is_array($users_with_freshly_started_objects)) {
             $this->log->debug('...found ' . sizeof($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.');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildMailSalutation()

ilTimingsCronReminder::buildMailSalutation	(	$user_id,
		$tpl
	)

protected

Parameters

	$user_id
ilTemplate	$tpl

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

References $name, $tpl, and ilObjUser\_lookupName().

Referenced by buildTopMailBody().

     {
         $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.');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTopMailBody()

ilTimingsCronReminder::buildTopMailBody	(	$user_id,
		$language_variable
	)

protected

Parameters

$user_id
$language_variable

Returns: ilTemplate

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

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

Referenced by buildExceededMails(), and buildFreshlyStartedMails().

     {
         $this->log->debug('start...');
         $tpl = new ilTemplate('tpl.crs_timings_cron_reminder_mail.html', true, true, 'Modules/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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillObjectListForMailBody()

ilTimingsCronReminder::fillObjectListForMailBody	(	$objects,
		$tpl
	)

protected

Parameters

$objects
$tpl

Returns: bool

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

References $tpl, and ilMail\_getInstallationSignature().

Referenced by buildExceededMails(), and buildFreshlyStartedMails().

     {
         $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;
     }

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 163 of file class.ilTimingsCronReminder.php.

References $now, $query, and $row.

Referenced by run().

     {
         $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)',
             array('integer', 'integer'),
             array($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.');
     }

Here is the caller graph for this function:

◆ gatherUsersWithExceededTimings()

ilTimingsCronReminder::gatherUsersWithExceededTimings ( )

protected

Users with exceeded timings.

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

References ilTimingsUser\lookupTimingsExceededByUser().

Referenced by run().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAlreadySentNotifications()

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

protected

Parameters

int	$user_id
bool \| true	$for_exceeded

Returns: array

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

References $result, $table, ilCourseConstants\CRON_TIMINGS_EXCEEDED_TABLE, and ilCourseConstants\CRON_TIMINGS_STARTED_TABLE.

Referenced by getFreshlyStartedObjectsForUser(), and getNewExceededObjectForUser().

     {
         $ref_ids = array();
         $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',
             array('integer'),
             array($user_id)
         );
 
         while ($record = $this->db->fetchAssoc($result)) {
             $ref_ids[$record['ref_id']] = $record['ref_id'];
         }
 
         return $ref_ids;
     }

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilTimingsCronReminder::getDefaultScheduleType ( )

Returns: int

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

     {
         return self::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilTimingsCronReminder::getDefaultScheduleValue ( )

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

     {
         return;
     }

◆ getDescription()

ilTimingsCronReminder::getDescription ( )

Returns: string

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

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

◆ getExceededObjectsForUser()

ilTimingsCronReminder::getExceededObjectsForUser ( $user_id )

protected

Parameters

$user_id

Returns: array

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

References ilTimingsUser\lookupTimings().

Referenced by getNewExceededObjectForUser().

     {
         $exceeded_obj_list = ilTimingsUser::lookupTimings(array($user_id), $arr = array(), true, true);
         return $exceeded_obj_list;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFreshlyStartedObjectsForUser()

ilTimingsCronReminder::getFreshlyStartedObjectsForUser ( )

protected

Get freshly started objects.

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

References $key, buildFreshlyStartedMails(), getAlreadySentNotifications(), getInformationForRefId(), and getObjectsWithTimingsForUser().

Referenced by run().

     {
         $users_with_new_started_object = array();
 
         if (is_array($this->users) && count($this->users) > 0) {
             foreach ($this->users as $key => $user_id) {
                 $objects = $this->getObjectsWithTimingsForUser($user_id);
                 if (is_array($objects) && count($objects) > 0) {
                     $obj_data = array();
                     $already_notified = $this->getAlreadySentNotifications($user_id, false);
                     $this->log->debug('User_id ' . $user_id . ' was already notified for ' . sizeof($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($objects[$ref_id])) {
                             if ((isset($objects[$ref_id]['end']) && isset($objects[$ref_id]['start'])) && $objects[$ref_id]['end'] > $this->now) {
                                 if ($objects[$ref_id]['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);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilTimingsCronReminder::getId ( )

Returns: string

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

     {
         return 'crs_timings_reminder';
     }

◆ getInformationForRefId()

ilTimingsCronReminder::getInformationForRefId ( $ref_id )

protected

Parameters

$ref_id

Returns: mixed

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

References $type, and ilLink\_getLink().

Referenced by getFreshlyStartedObjectsForUser(), and getNewExceededObjectForUser().

     {
         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 = array(     '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];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNewExceededObjectForUser()

ilTimingsCronReminder::getNewExceededObjectForUser ( )

protected

get new exceeded objects for users

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

References $key, buildExceededMails(), getAlreadySentNotifications(), getExceededObjectsForUser(), and getInformationForRefId().

Referenced by run().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjectsWithTimingsForUser()

ilTimingsCronReminder::getObjectsWithTimingsForUser ( $user_id )

protected

Parameters

$user_id

Returns: array

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

References ilTimingsUser\lookupTimings().

Referenced by getFreshlyStartedObjectsForUser().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilTimingsCronReminder::getTitle ( )

Returns: string

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

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

◆ getUserLanguage()

ilTimingsCronReminder::getUserLanguage ( $user_id )

protected

Parameters

$user_id

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

References ilLanguageFactory\_getLanguageOfUser().

Referenced by buildTopMailBody().

     {
         $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.');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAutoActivation()

ilTimingsCronReminder::hasAutoActivation ( )

Returns: bool

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

     {
         return false;
     }

◆ hasCustomSettings()

ilTimingsCronReminder::hasCustomSettings ( )

Returns: bool

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

     {
         return false;
     }

◆ hasFlexibleSchedule()

ilTimingsCronReminder::hasFlexibleSchedule ( )

Returns: bool

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

     {
         return false;
     }

◆ hasUserActivatedNotification()

ilTimingsCronReminder::hasUserActivatedNotification ( $user_id )

protected

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

Referenced by sendExceededMail(), and sendFreshlyStartedMail().

     {
         return true;
     }

Here is the caller graph for this function:

◆ markExceededInDatabase()

ilTimingsCronReminder::markExceededInDatabase	(	$user_id,
		$ref_ids
	)

protected

Parameters

int	$user_id
array	$ref_ids

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

References $data, and ilCourseConstants\CRON_TIMINGS_EXCEEDED_TABLE.

Referenced by sendExceededMail().

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

Here is the caller graph for this function:

◆ markFreshlyStartedInDatabase()

ilTimingsCronReminder::markFreshlyStartedInDatabase	(	$user_id,
		$ref_ids
	)

protected

Parameters

int	$user_id
array	$ref_ids

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

References $data, and ilCourseConstants\CRON_TIMINGS_STARTED_TABLE.

Referenced by sendFreshlyStartedMail().

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

Here is the caller graph for this function:

◆ run()

ilTimingsCronReminder::run ( )

Returns: ilCronJobResult

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

References $result, gatherUsers(), gatherUsersWithExceededTimings(), getFreshlyStartedObjectsForUser(), getNewExceededObjectForUser(), and ilCronJobResult\STATUS_OK.

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

Here is the call graph for this function:

◆ sendExceededMail()

ilTimingsCronReminder::sendExceededMail	(	$user_id,
		$ref_ids,
		$mail_body
	)

protected

Parameters

$user_id
$ref_ids
$mail_body

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

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

Referenced by buildExceededMails().

     {
         $login = \ilObjUser::_lookupLogin($user_id);
         if ($login != '') {
             $mail = new ilMail(ANONYMOUS_USER_ID);
             if ($this->hasUserActivatedNotification($user_id)) {
                 $mail->sendMail(
                     $login,
                     '',
                     '',
                     $this->user_lang->txt('timings_cron_reminder_exceeded_subject'),
                     $mail_body,
                     [],
                     ['normal'],
                     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.');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendFreshlyStartedMail()

ilTimingsCronReminder::sendFreshlyStartedMail	(	$user_id,
		$ref_ids,
		$mail_body
	)

protected

Parameters

$user_id
$ref_ids
$mail_body

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

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

Referenced by buildFreshlyStartedMails().

     {
         $login = \ilObjUser::_lookupLogin($user_id);
 
         if ($login != '' && $this->hasUserActivatedNotification($user_id)) {
             $mail = new ilMail(ANONYMOUS_USER_ID);
             $mail->sendMail(
                 $login,
                 '',
                 '',
                 $this->user_lang->txt('timings_cron_reminder_started_subject'),
                 $mail_body,
                 [],
                 ['normal'],
                 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.');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $coaches_emails

ilTimingsCronReminder::$coaches_emails

staticprotected

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

◆ $db

ilTimingsCronReminder::$db

protected

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

◆ $lng

ilTimingsCronReminder::$lng

protected

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

Referenced by __construct().

◆ $log

ilTimingsCronReminder::$log

protected

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

◆ $now

ilTimingsCronReminder::$now

protected

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

Referenced by gatherUsers().

◆ $obj_data_cache

ilTimingsCronReminder::$obj_data_cache

protected

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

◆ $objects_information

ilTimingsCronReminder::$objects_information

staticprotected

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

◆ $user_lang

ilTimingsCronReminder::$user_lang

protected

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

◆ $users

ilTimingsCronReminder::$users

protected

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

◆ $users_with_exceeded_timings

ilTimingsCronReminder::$users_with_exceeded_timings

protected

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

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

Modules/Course/classes/class.ilTimingsCronReminder.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

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

◆ $coaches_emails

◆ $db

◆ $lng

◆ $log

◆ $now

◆ $obj_data_cache

◆ $objects_information

◆ $user_lang

◆ $users

◆ $users_with_exceeded_timings