ilSkillNotifications Class Reference

Course/group skill notification. More...

Inheritance diagram for ilSkillNotifications:

Collaboration diagram for ilSkillNotifications:

Public Member Functions
	__construct ()
	Constructor. More...
	getId ()
	Get id. More...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? More...
	run ()
	Run job. More...
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
	sendMail ($a_user_id, array $a_achievements, $a_last_run)
	Send news mail for 1 user and n objects. More...
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Protected Attributes
	$lng
	$user
	$client_ini
	$tree

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

Course/group skill notification.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilSkillNotifications::__construct

(

)

Constructor.

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

    {
        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();
        }
    }

References $DIC, and user().

Here is the call graph for this function:

Member Function Documentation

getDefaultScheduleType()

ilSkillNotifications::getDefaultScheduleType

(

)

Get schedule type.

Returns

int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

getDefaultScheduleValue()

ilSkillNotifications::getDefaultScheduleValue

(

)

Get schedule value.

Returns

int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

getDescription()

ilSkillNotifications::getDescription

(

)

Get description.

Returns

string

Reimplemented from ilCronJob.

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

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

References $lng.

getId()

ilSkillNotifications::getId

(

)

Get id.

Returns

string

Reimplemented from ilCronJob.

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

    {
        return "skll_notification";
    }

getTitle()

ilSkillNotifications::getTitle

(

)

Get title.

Returns

string

Reimplemented from ilCronJob.

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

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

References $lng.

hasAutoActivation()

ilSkillNotifications::hasAutoActivation

(

)

Is to be activated on "installation".

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

hasFlexibleSchedule()

ilSkillNotifications::hasFlexibleSchedule

(

)

Can the schedule be configured?

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

run()

ilSkillNotifications::run

(

)

Run job.

Returns

ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC->language();
 
        $log = ilLoggerFactory::getLogger("skll");
        $log->debug("===Skill Notifications=== start");
 
        $status = ilCronJobResult::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);
 
 
        // $last_run = "2017-07-20 12:00:00";
 
        // 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 = ilCronJobResult::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 ilCronJobResult();
        $result->setStatus($status);
 
        if ($status_details) {
            $result->setMessage($status_details);
        }
 
        $log->debug("===Skill Notifications=== done");
 
        return $result;
    }

References Vendor\Package\$a, $DIC, $lng, $log, $result, ilLoggerFactory\getLogger(), ilBasicSkill\getNewAchievementsPerUser(), sendMail(), ilDatePresentation\setUseRelativeDates(), ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, and ilDatePresentation\useRelativeDates().

Here is the call graph for this function:

sendMail()

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

protected

Send news mail for 1 user and n objects.

Parameters

int	$a_user_id
array	$a_objects
string	$a_last_run

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

    {
        $ilClientIniFile = $this->client_ini;
        $tree = $this->tree;
 
        $ntf = new ilSystemNotification();
        $ntf->setLangModules(array("skll"));
 
        // user specific language
        $lng = $ntf->getUserLanguage($a_user_id);
 
        $tmp = array();
        $txt = "";
        $last_obj_id = 0;
 
        // order skill achievements per virtual skill tree
        $vtree = new ilVirtualSkillTree();
        $a_achievements = $vtree->getOrderedNodeset($a_achievements, "skill_id", "tref_id");
 
        foreach ($a_achievements as $skill_level) {
            $parent = array();
 
            // path
            $path = array();
            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),
            null,
            null,
            $subject,
            $ntf->composeAndGetMessage($a_user_id, null, "read", true),
            []
        );
    }

References $client, $client_ini, $lng, $tree, $txt, $type, ilLink\_getStaticLink(), ilObjUser\_lookupLogin(), ilSkillTreeNode\_lookupTitle(), ANONYMOUS_USER_ID, ilDatePresentation\formatDate(), IL_CAL_DATETIME, IL_CAL_UNIX, and ilBasicSkill\lookupLevelTitle().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$client_ini

ilSkillNotifications::$client_ini

protected

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

Referenced by sendMail().

$lng

ilSkillNotifications::$lng

protected

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

Referenced by getDescription(), getTitle(), run(), and sendMail().

$tree

ilSkillNotifications::$tree

protected

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

Referenced by sendMail().

$user

ilSkillNotifications::$user

protected

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

---

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

• Services/Skill/classes/class.ilSkillNotifications.php