ilTestLearningObjectivesStatusGUI Class Reference

Collaboration diagram for ilTestLearningObjectivesStatusGUI:

Public Member Functions
	__construct (private ilLanguage $lng, private ilCtrlInterface $ctrl, private UIFactory $ui_factory, private UIRenderer $ui_renderer, private RequestDataCollector $testrequest)
	getCrsObjId ()
	setCrsObjId ($crs_obj_id)
	getUsrId ()
	setUsrId ($usr_id)
	getHTML (?int $objective_id=null)

Private Member Functions
	getHeaderLangVar (?int $objective_id)
	buildStatusItems (?int $objective_id, array $lo_status_data)
	getUsersObjectivesStatus ($crs_obj_id, $usr_id)
	getUsersObjectivesResults (int $crs_obj_id, int $usr_id)

Private Attributes
int	$crs_obj_id = null
int	$usr_id = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilTestLearningObjectivesStatusGUI::__construct	(	private ilLanguage	$lng,
		private ilCtrlInterface	$ctrl,
		private UIFactory	$ui_factory,
		private UIRenderer	$ui_renderer,
		private RequestDataCollector	$testrequest
	)

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

      {
    }

Member Function Documentation

buildStatusItems()

ilTestLearningObjectivesStatusGUI::buildStatusItems ( ?int  $objective_id, array  $lo_status_data  )

private

Parameters

type

$lo_status_data

Returns

array

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

References ilObject\_getIcon(), ILIAS\Repository\ctrl(), getCrsObjId(), ilLOSettings\getInstanceByObjId(), ILIAS\Repository\lng(), null, and ilLOUserResults\TYPE_QUALIFIED.

Referenced by getHTML().

                                                                                : array
    {
        $items = [];

        foreach ($lo_status_data as $objtv) {
            if ($objective_id !== null && $objtv['id'] !== $objective_id) {
                continue;
            }

            $loc_settings = ilLOSettings::getInstanceByObjId($this->getCrsObjId());
            $compare_value = null;
            if ($objtv["type"] === ilLOUserResults::TYPE_QUALIFIED
                && $loc_settings->getInitialTest() === 1
                && isset($objtv['initial']['result_perc'])) {
                $compare_value = $objtv['initial']['result_perc'];
            }

            $items[] = $this->ui_factory->item()->standard($objtv["title"])
                ->withLeadIcon(
                    $this->ui_factory->symbol()->icon()->custom(
                        ilObject::_getIcon($objtv["id"], "small", "lobj"),
                        $this->lng->txt("crs_objectives")
                    )
                )->withProgress(
                    $this->ui_factory->chart()->progressMeter()->standard(
                        100,
                        $objtv['result_perc'],
                        $objtv['limit_perc'],
                        $compare_value
                    )
                );

            // 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 (!)
            $this->ctrl->setParameterByClass('ilObjTestGUI', 'ref_id', $this->testrequest->getRefId());
        }

        return $items;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCrsObjId()

ilTestLearningObjectivesStatusGUI::getCrsObjId

(

)

Returns

integer

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

References $crs_obj_id.

Referenced by buildStatusItems(), and getHTML().

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

Here is the caller graph for this function:

getHeaderLangVar()

ilTestLearningObjectivesStatusGUI::getHeaderLangVar ( ?int  $objective_id )

private

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

References null.

                                                         : string
    {
        if ($objective_id !== null) {
            return 'tst_objective_progress_header';
        }

        return 'tst_objectives_progress_header';
    }

getHTML()

ilTestLearningObjectivesStatusGUI::getHTML

(

?int

$objective_id = null

)

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

References buildStatusItems(), getCrsObjId(), getUsersObjectivesStatus(), getUsrId(), and ILIAS\Repository\lng().

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

        $items = $this->buildStatusItems(
            $objective_id,
            $this->getUsersObjectivesStatus(
                $this->getCrsObjId(),
                $this->getUsrId()
            )
        );

        $panel = $this->ui_factory->panel()->standard(
            $this->lng->txt($this->getHeaderLangVar($objective_id)),
            $items
        );

        return $this->ui_renderer->render($panel);
    }

Here is the call graph for this function:

getUsersObjectivesResults()

ilTestLearningObjectivesStatusGUI::getUsersObjectivesResults ( int  $crs_obj_id, int  $usr_id  )

private

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

References $res, null, ilLOUserResults\TYPE_INITIAL, and ilLOUserResults\TYPE_QUALIFIED.

Referenced by getUsersObjectivesStatus().

                                                                            : array
    {
        $res = [];
        $initial_status = null;
        $lur = new ilLOUserResults($crs_obj_id, $usr_id);

        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 (   $crs_obj_id,   $usr_id  )

private

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

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

Referenced by getHTML().

                                                                   : array
    {
        $collection_of_objectives = new ilLPCollectionOfObjectives($crs_obj_id, ilLPObjSettings::LP_MODE_OBJECTIVES);
        $objective_items = $collection_of_objectives->getItems();

        if ($objective_items === []) {
            return [];
        }

        $lo_results = $this->getUsersObjectivesResults($crs_obj_id, $usr_id);
        $lo_ass = ilLOTestAssignments::getInstance($crs_obj_id);

        $res = [];
        $tmp = [];
        foreach ($objective_items as $objective_id) {
            $title = ilCourseObjective::lookupObjectiveTitle($objective_id, true);

            $tmp[$objective_id] = [
                "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 ($objective_items 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 64 of file class.ilTestLearningObjectivesStatusGUI.php.

References $usr_id.

Referenced by getHTML().

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

Here is the caller graph for this function:

setCrsObjId()

ilTestLearningObjectivesStatusGUI::setCrsObjId

(

$crs_obj_id

)

Parameters

integer

$crs_obj_id

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

References $crs_obj_id.

    {
        $this->crs_obj_id = $crs_obj_id;
    }

setUsrId()

ilTestLearningObjectivesStatusGUI::setUsrId

(

$usr_id

)

Parameters

integer

$usr_id

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

References $usr_id.

    {
        $this->usr_id = $usr_id;
    }

Field Documentation

$crs_obj_id

int ilTestLearningObjectivesStatusGUI::$crs_obj_id = null

private

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

Referenced by getCrsObjId(), and setCrsObjId().

$usr_id

int ilTestLearningObjectivesStatusGUI::$usr_id = null

private

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

Referenced by getUsrId(), and setUsrId().

---

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

• components/ILIAS/Test/classes/class.ilTestLearningObjectivesStatusGUI.php