ilTestLearningObjectivesStatusGUI Class Reference

Collaboration diagram for ilTestLearningObjectivesStatusGUI:

Public Member Functions
	__construct (ilLanguage $lng)
	getCrsObjId ()
	setCrsObjId ($crsObjId)
	getUsrId ()
	setUsrId ($usrId)
	getHTML ($objectiveId=null)

Protected Attributes
	$lng = null

Private Member Functions
	getHeaderLangVar ($objectiveId)
	renderStatus ($tpl, $objectiveId, $loStatusData)
	getUsersObjectivesStatus ($crsObjId, $usrId)
	getUsersObjectivesResults ($crsObjId, $usrId)

Private Attributes
ILIAS Test InternalRequestService	$testrequest
	$crsObjId = null
	$usrId = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilTestLearningObjectivesStatusGUI::__construct

(

ilLanguage

$lng

)

Definition at line 43 of file class.ilTestLearningObjectivesStatusGUI.php.

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

    {
        global $DIC;
        $this->testrequest = $DIC->test()->internal()->request();
        $this->lng = $lng;
    }

Here is the call graph for this function:

Member Function Documentation

getCrsObjId()

ilTestLearningObjectivesStatusGUI::getCrsObjId

(

)

Returns

integer

Definition at line 53 of file class.ilTestLearningObjectivesStatusGUI.php.

References $crsObjId.

Referenced by getHTML(), and renderStatus().

                                 : ?int
    {
        return $this->crsObjId;
    }

Here is the caller graph for this function:

getHeaderLangVar()

ilTestLearningObjectivesStatusGUI::getHeaderLangVar (   $objectiveId )

private

Definition at line 100 of file class.ilTestLearningObjectivesStatusGUI.php.

                                                   : string
    {
        if ($objectiveId) {
            return 'tst_objective_progress_header';
        }

        return 'tst_objectives_progress_header';
    }

getHTML()

ilTestLearningObjectivesStatusGUI::getHTML

(

$objectiveId = null

)

Definition at line 82 of file class.ilTestLearningObjectivesStatusGUI.php.

References $tpl, getCrsObjId(), getUsersObjectivesStatus(), getUsrId(), ILIAS\Repository\lng(), and renderStatus().

                                                : string
    {
        $this->lng->loadLanguageModule('crs');

        $tpl = new ilTemplate('tpl.tst_lo_status.html', true, true, 'Modules/Test');

        $tpl->setCurrentBlock('objectives_progress_header');
        $tpl->setVariable('OBJECTIVES_PROGRESS_HEADER', $this->lng->txt($this->getHeaderLangVar($objectiveId)));
        $tpl->parseCurrentBlock();

        $this->renderStatus($tpl, $objectiveId, $this->getUsersObjectivesStatus(
            $this->getCrsObjId(),
            $this->getUsrId()
        ));

        return $tpl->get();
    }

Here is the call graph for this function:

getUsersObjectivesResults()

ilTestLearningObjectivesStatusGUI::getUsersObjectivesResults (   $crsObjId,   $usrId  )

private

Definition at line 196 of file class.ilTestLearningObjectivesStatusGUI.php.

References $crsObjId, $res, $usrId, ilLOUserResults\TYPE_INITIAL, and ilLOUserResults\TYPE_QUALIFIED.

Referenced by getUsersObjectivesStatus().

                                                                 : array
    {
        $res = array();
        $initial_status = null;
        $lur = new ilLOUserResults($crsObjId, $usrId);

        foreach ($lur->getCourseResultsForUserPresentation() as $objective_id => $types) {
            // show either initial or qualified for objective
            if (isset($types[ilLOUserResults::TYPE_INITIAL])) {
                $initial_status = $types[ilLOUserResults::TYPE_INITIAL]["status"];
            }

            // qualified test has priority
            if (isset($types[ilLOUserResults::TYPE_QUALIFIED])) {
                $result = $types[ilLOUserResults::TYPE_QUALIFIED];
                $result["type"] = ilLOUserResults::TYPE_QUALIFIED;
                $result["initial"] = $types[ilLOUserResults::TYPE_INITIAL] ?? null;
            } else {
                $result = $types[ilLOUserResults::TYPE_INITIAL];
                $result["type"] = ilLOUserResults::TYPE_INITIAL;
            }

            $result["initial_status"] = $initial_status;

            $res[$objective_id] = $result;
        }

        return $res;
    }

Here is the caller graph for this function:

getUsersObjectivesStatus()

ilTestLearningObjectivesStatusGUI::getUsersObjectivesStatus (   $crsObjId,   $usrId  )

private

Definition at line 151 of file class.ilTestLearningObjectivesStatusGUI.php.

References $crsObjId, $res, $usrId, ilLOTestAssignments\getInstance(), getUsersObjectivesResults(), ilCourseObjective\lookupObjectiveTitle(), ilLPObjSettings\LP_MODE_OBJECTIVES, ilLOSettings\TYPE_TEST_INITIAL, and ilLOSettings\TYPE_TEST_QUALIFIED.

Referenced by getHTML().

                                                                : array
    {
        $res = array();

        $coll_objtv = new ilLPCollectionOfObjectives($crsObjId, ilLPObjSettings::LP_MODE_OBJECTIVES);
        $coll_objtv = $coll_objtv->getItems();
        if ($coll_objtv) {
            // #13373
            $lo_results = $this->getUsersObjectivesResults($crsObjId, $usrId);
            $lo_ass = ilLOTestAssignments::getInstance($crsObjId);

            $tmp = array();
            foreach ($coll_objtv as $objective_id) {
                $title = ilCourseObjective::lookupObjectiveTitle($objective_id, true);

                $tmp[$objective_id] = array(
                    "id" => $objective_id,
                    "title" => $title["title"],
                    "desc" => $title["description"],
                    "itest" => $lo_ass->getTestByObjective($objective_id, ilLOSettings::TYPE_TEST_INITIAL),
                    "qtest" => $lo_ass->getTestByObjective($objective_id, ilLOSettings::TYPE_TEST_QUALIFIED)
                );

                // patch optes end

                if (array_key_exists($objective_id, $lo_results)) {
                    $lo_result = $lo_results[$objective_id];
                    $tmp[$objective_id]["user_id"] = $lo_result["user_id"];
                    $tmp[$objective_id]["result_perc"] = $lo_result["result_perc"];
                    $tmp[$objective_id]["limit_perc"] = $lo_result["limit_perc"];
                    $tmp[$objective_id]["status"] = $lo_result["status"];
                    $tmp[$objective_id]["type"] = $lo_result["type"];
                    $tmp[$objective_id]["initial"] = $lo_result["initial"] ?? null;
                }
            }

            // order
            foreach ($coll_objtv as $objtv_id) {
                $res[] = $tmp[$objtv_id];
            }
        }

        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUsrId()

ilTestLearningObjectivesStatusGUI::getUsrId

(

)

Returns

integer

Definition at line 69 of file class.ilTestLearningObjectivesStatusGUI.php.

References $usrId.

Referenced by getHTML().

                              : ?int
    {
        return $this->usrId;
    }

Here is the caller graph for this function:

renderStatus()

ilTestLearningObjectivesStatusGUI::renderStatus (   $tpl,   $objectiveId,   $loStatusData  )

private

Definition at line 109 of file class.ilTestLearningObjectivesStatusGUI.php.

References $DIC, $tpl, ilObject\_getIcon(), ilContainerObjectiveGUI\buildObjectiveProgressBar(), getCrsObjId(), ilLOSettings\getInstanceByObjId(), and ILIAS\Repository\lng().

Referenced by getHTML().

    {
        $loc_settings = ilLOSettings::getInstanceByObjId($this->getCrsObjId());
        $has_initial_test = (bool) $loc_settings->getInitialTest();

        foreach ($loStatusData as $objtv) {
            if ($objectiveId && $objtv['id'] != $objectiveId) {
                continue;
            }

            $tpl->setCurrentBlock("objective_nolink_bl");
            $tpl->setVariable("OBJECTIVE_NOLINK_TITLE", $objtv["title"]);
            $tpl->parseCurrentBlock();

            $objtv_icon = ilObject::_getIcon($objtv["id"], "small", "lobj");

            $tpl->setCurrentBlock("objective_bl");
            $tpl->setVariable("OBJTV_ICON_URL", $objtv_icon);
            $tpl->setVariable("OBJTV_ICON_ALT", $this->lng->txt("crs_objectives"));

            if ($objtv["type"]) {
                $tpl->setVariable(
                    "LP_OBJTV_PROGRESS",
                    ilContainerObjectiveGUI::buildObjectiveProgressBar($has_initial_test, $objtv["id"], $objtv, true)
                );

                // since ilContainerObjectiveGUI::buildObjectiveProgressBar() "sets an empty ref_id" for ilObjTestGUI,
                // after creating links for different test refs, the "saved ref_id param" for ilObjTestGUI gets overwritten.
                // (!) we need to set an explicit ref_id param for ilObjTestGUI again to keep the things running (!)

                global $DIC; /* @var \ILIAS\DI\Container $DIC */
                $DIC->ctrl()->setParameterByClass('ilObjTestGUI', 'ref_id', $this->testrequest->getRefId());
            }

            $tpl->parseCurrentBlock();
        }

        $tpl->setCurrentBlock("objectives_bl");
        $tpl->setVariable("OBJTV_LIST_CRS_ID", $this->getCrsObjId());
        $tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCrsObjId()

ilTestLearningObjectivesStatusGUI::setCrsObjId

(

$crsObjId

)

Parameters

integer

$crsObjId

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

References $crsObjId.

    {
        $this->crsObjId = $crsObjId;
    }

setUsrId()

ilTestLearningObjectivesStatusGUI::setUsrId

(

$usrId

)

Parameters

integer

$usrId

Definition at line 77 of file class.ilTestLearningObjectivesStatusGUI.php.

References $usrId.

    {
        $this->usrId = $usrId;
    }

Field Documentation

$crsObjId

ilTestLearningObjectivesStatusGUI::$crsObjId = null

private

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

Referenced by getCrsObjId(), getUsersObjectivesResults(), getUsersObjectivesStatus(), and setCrsObjId().

$lng

ilTestLearningObjectivesStatusGUI::$lng = null

protected

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

Referenced by __construct().

$testrequest

ILIAS Test InternalRequestService ilTestLearningObjectivesStatusGUI::$testrequest

private

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

$usrId

ilTestLearningObjectivesStatusGUI::$usrId = null

private

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

Referenced by getUsersObjectivesResults(), getUsersObjectivesStatus(), getUsrId(), and setUsrId().

---

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

• Modules/Test/classes/class.ilTestLearningObjectivesStatusGUI.php