Course/group skill notification. More...

Inheritance diagram for ilSkillNotifications:

Collaboration diagram for ilSkillNotifications:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	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 Member Functions
	sendMail (int $a_user_id, array $a_achievements, string $a_last_run)
	Send news mail for 1 user and n objects. More...

Protected Attributes
ilLanguage	$lng

ilObjUser	$user

ilIniFile	$client_ini

ilTree	$tree

SkillTreeService	$tree_service

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

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Course/group skill notification.

Author: Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..com

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

Constructor & Destructor Documentation

◆ __construct()

ilSkillNotifications::__construct ( )

Definition at line 39 of file class.ilSkillNotifications.php.

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

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         if (isset($DIC["ilUser"])) {
             $this->user = $DIC->user();
         }
         if (isset($DIC["ilClientIniFile"])) {
             $this->client_ini = $DIC["ilClientIniFile"];
         }
         if (isset($DIC["tree"])) {
             $this->tree = $DIC->repositoryTree();
         }
         $this->tree_service = $DIC->skills()->tree();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilSkillNotifications::getDefaultScheduleType ( )

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

                                             : JobScheduleType
     {
         return JobScheduleType::DAILY;
     }

◆ getDefaultScheduleValue()

ilSkillNotifications::getDefaultScheduleValue ( )

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

References null.

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilSkillNotifications::getDescription ( )

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

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

                                     : string
     {
         $lng = $this->lng;
         $lng->loadLanguageModule("skll");
         return $lng->txt("skll_skill_notification_desc");
     }

Here is the call graph for this function:

◆ getId()

ilSkillNotifications::getId ( )

Definition at line 56 of file class.ilSkillNotifications.php.

                            : string
     {
         return "skll_notification";
     }

◆ getTitle()

ilSkillNotifications::getTitle ( )

Definition at line 61 of file class.ilSkillNotifications.php.

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

                               : string
     {
         $lng = $this->lng;
         $lng->loadLanguageModule("skll");
         return $lng->txt("skll_skill_notification");
     }

Here is the call graph for this function:

◆ hasAutoActivation()

ilSkillNotifications::hasAutoActivation ( )

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

                                        : bool
     {
         return false;
     }

◆ hasFlexibleSchedule()

ilSkillNotifications::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ run()

ilSkillNotifications::run ( )

Definition at line 95 of file class.ilSkillNotifications.php.

References Vendor\Package\$a, $DIC, $lng, $log, $user_id, ilLoggerFactory\getLogger(), ilBasicSkill\getNewAchievementsPerUser(), null, sendMail(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

                          : JobResult
     {
         global $DIC;
 
         $lng = $DIC->language();
 
         $log = ilLoggerFactory::getLogger("skll");
         $log->debug("===Skill Notifications=== start");
 
         $status = JobResult::STATUS_NO_ACTION;
         $status_details = null;
 
         $setting = new ilSetting("cron");
         $last_run = $setting->get(get_class($this));
 
         // no last run?
         if (!$last_run) {
             $last_run = date("Y-m-d H:i:s", strtotime("yesterday"));
 
             $status_details = "No previous run found - starting from yesterday.";
         } // migration: used to be date-only value
         elseif (strlen($last_run) == 10) {
             $last_run .= " 00:00:00";
 
             $status_details = "Switched from daily runs to open schedule.";
         }
 
         // init language/date
         $old_lng = $lng;
         $old_dt = ilDatePresentation::useRelativeDates();
         ilDatePresentation::setUseRelativeDates(false);
 
 
         // get latest course/group skill changes per user
         $achievements = ilBasicSkill::getNewAchievementsPerUser($last_run);
 
         foreach ($achievements as $user_id => $a) {
             $this->sendMail($user_id, $a, $last_run);
         }
 
         // mails were sent - set cron job status accordingly
         $status = JobResult::STATUS_OK;
 
         // reset language/date
         ilDatePresentation::setUseRelativeDates($old_dt);
         $lng = $old_lng;
 
         $log->debug("save run");
 
         // save last run
         $setting->set(get_class($this), date("Y-m-d H:i:s"));
 
         $result = new JobResult();
         $result->setStatus($status);
 
         if ($status_details) {
             $result->setMessage($status_details);
         }
 
         $log->debug("===Skill Notifications=== done");
 
         return $result;
     }

Here is the call graph for this function:

◆ sendMail()

ilSkillNotifications::sendMail	(	int	$a_user_id,
		array	$a_achievements,
		string	$a_last_run
	)

protected

Send news mail for 1 user and n objects.

Definition at line 162 of file class.ilSkillNotifications.php.

References $client, $client_ini, $path, $ref_id, $tree, $txt, ilLink\_getStaticLink(), ilObjUser\_lookupLogin(), ilSkillTreeNode\_lookupTitle(), ANONYMOUS_USER_ID, ilDatePresentation\formatDate(), ilTree\getPathId(), ilLanguage\getUserLanguage(), IL_CAL_DATETIME, IL_CAL_UNIX, ilTree\isInTree(), ilBasicSkill\lookupLevelTitle(), null, and ilLanguage\txt().

Referenced by run().

                                                                                           : void
     {
         $ilClientIniFile = $this->client_ini;
         $tree = $this->tree;
 
         $ntf = new ilSystemNotification();
         $ntf->setLangModules(array("skll"));
 
         // user specific language
         $lng = $ntf->getUserLanguage($a_user_id);
 
         $txt = "";
         $last_obj_id = 0;
 
         // order skill achievements per virtual skill tree
         $vtree = $this->tree_service->getGlobalVirtualSkillTree();
         $a_achievements = $vtree->getOrderedNodeset($a_achievements, "skill_id", "tref_id");
 
         foreach ($a_achievements as $skill_level) {
             // path
             $path = [];
             foreach ($tree->getPathId($skill_level["trigger_ref_id"]) as $node) {
                 $path[] = $node;
             }
             $path = implode("-", $path);
 
             $ref_id = $skill_level["trigger_ref_id"];
             $obj_id = $skill_level["trigger_obj_id"];
             $type = $skill_level["trigger_obj_type"];
             $title = $skill_level["trigger_title"];
 
             if ($skill_level["trigger_obj_id"] != $last_obj_id) {
                 $last_obj_id = $skill_level["trigger_obj_id"];
                 $txt .= "\n\n" . $lng->txt("obj_" . $type) . ": " . $title;
                 if ($tree->isInTree($ref_id)) {
                     $txt .= "\n" . ilLink::_getStaticLink($ref_id);
                 }
             }
 
             $date = ilDatePresentation::formatDate(new ilDateTime($skill_level["status_date"], IL_CAL_DATETIME));
             $txt .= "\n  $date, " . ilBasicSkill::_lookupTitle($skill_level["skill_id"], $skill_level["tref_id"]) . ": " .
                 ilBasicSkill::lookupLevelTitle($skill_level["level_id"]);
         }
 
         $ntf->setIntroductionLangId("skll_intro_skill_notification_for");
 
         // index
         $period = sprintf(
             $lng->txt("skll_new_skill_achievements"),
             ilDatePresentation::formatDate(new ilDateTime($a_last_run, IL_CAL_DATETIME)),
             ilDatePresentation::formatDate(new ilDateTime(time(), IL_CAL_UNIX))
         );
 
         // text
         $ntf->addAdditionalInfo(
             "",
             trim($txt),
             true
         );
 
         // :TODO: does it make sense to add client to subject?
         $client = $ilClientIniFile->readVariable('client', 'name');
         $subject = sprintf($lng->txt("skll_competence_achievements"), $client);
 
         //die($ntf->composeAndGetMessage($a_user_id, null, "read", true));
 
         // #10044
         $mail = new ilMail(ANONYMOUS_USER_ID);
         $mail->enqueue(
             ilObjUser::_lookupLogin($a_user_id),
             "",
             "",
             $subject,
             $ntf->composeAndGetMessage($a_user_id, null, "read", true),
             []
         );
     }