Collaboration diagram for ILIAS\Containter\Content\ObjectiveRenderer:

Public Member Functions
	renderObjectives ()

	getContent ()

	showObjectives (bool $a_is_order=false)

Static Public Member Functions
static	renderProgressMeter (?int $a_perc_result=null, ?int $a_perc_limit=null, ?int $a_compare_value=null, ?string $a_caption=null, ?string $a_url=null, ?string $a_tt_id=null, ?string $a_tt_txt=null, ?string $a_next_step=null, bool $a_sub=false, int $a_sub_style=30, string $a_main_text='', string $a_required_text='')
	Render progress meter. More...

static	getObjectiveResultSummary (bool $a_has_initial_test, int $a_objective_id, array $a_lo_result)
	Get objective result summary. More...

static	buildObjectiveProgressBar (bool $a_has_initial_test, int $a_objective_id, array $a_lo_result, bool $a_list_mode=false, bool $a_sub=false, ?string $a_tt_suffix=null)
	Render progressbar(s) for given objective and result data. More...

Data Fields
const	MATERIALS_TESTS = 1

const	MATERIALS_OTHER = 2

const	CHECKBOX_NONE = 0

const	CHECKBOX_ADMIN = 1

const	CHECKBOX_DOWNLOAD = 2

Protected Member Functions
	renderTest (int $a_test_ref_id, ?int $a_objective_id, bool $a_is_initial=false)

	renderObjective (int $a_objective_id, bool &$a_has_lo_page, ?\ilAccordionGUI $a_accordion=null, ?array $a_lo_result=null)

	parseLOUserResults ()

	buildAccordionTitle (\ilCourseObjective $a_objective, ?array $a_lo_result=null)

	buildAccordionContent (array $a_items)

	showButton (string $a_cmd, string $a_text, string $a_target='', string $a_id="")

Protected Attributes
array	$rendered_items

ilCourseObjectiveListGUI	$objective_list_gui

ilLanguage	$lng

ILIAS Container StandardGUIRequest	$request

ILIAS Style Content Object ObjectFacade	$content_style_domain

ilLOTestAssignments	$test_assignments

ilContainerRenderer	$renderer

ilLOSettings	$loc_settings

ilContainerGUI	$container_gui

ilContainer	$container

string	$view_mode

InternalGUIService	$gui

InternalDomainService	$domain

array	$list_gui = []

string	$output_html = ""

Detailed Description

Todo:: currently too fat for a renderer, more a GUI class

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ buildAccordionContent()

ILIAS\Containter\Content\ObjectiveRenderer::buildAccordionContent ( array $a_items )

protected

Definition at line 1025 of file class.ObjectiveRenderer.php.

                                                            : string
    {
        $tpl = new \ilTemplate("tpl.objective_accordion_content.html", true, true, "components/ILIAS/Container");
        foreach ($a_items as $item) {
            $tpl->setCurrentBlock("items_bl");
            $tpl->setVariable("ITEM", $item);
            $tpl->parseCurrentBlock();
        }
        return $tpl->get();
    }

◆ buildAccordionTitle()

ILIAS\Containter\Content\ObjectiveRenderer::buildAccordionTitle	(	\ilCourseObjective	$a_objective,
		?array	$a_lo_result = `null`
	)

protected

Definition at line 894 of file class.ObjectiveRenderer.php.

     : string {
        global $DIC;
 
        $renderer = $DIC->ui()->renderer();
        $ui_factory = $DIC->ui()->factory();
 
        $tpl = new \ilTemplate("tpl.objective_accordion_title.html", true, true, "components/ILIAS/Container");
 
        if ($a_lo_result) {
            $tpl->setVariable(
                "PROGRESS_BAR",
                self::buildObjectiveProgressBar(
                    $this->loc_settings->worksWithInitialTest(),
                    $a_objective->getObjectiveId(),
                    $a_lo_result
                )
            );
        }
 
        $tpl->setVariable("TITLE", $this->lng->txt("crs_loc_learning_objective") . ": " . trim($a_objective->getTitle()));
        $tpl->setVariable("DESCRIPTION", nl2br(trim($a_objective->getDescription())));
 
        $initial_res = null;
        $initial_lim = null;
        if ($this->loc_settings->worksWithInitialTest()) {
            if (array_key_exists('initial', $a_lo_result)) {
                $initial_res = (int) ($a_lo_result['initial']['result_perc'] ?? 0);
                $initial_lim = (int) ($a_lo_result['initial']['limit_perc'] ?? 100);
            }
            if (
                ($a_lo_result['type'] ?? \ilLOUserResults::TYPE_UNDEFINED) == \ilLOUserResults::TYPE_INITIAL &&
                isset($a_lo_result['result_perc'])
            ) {
                $initial_res = (int) $a_lo_result['result_perc'];
                $initial_lim = (int) $a_lo_result['limit_perc'];
            }
        }
 
        if ($initial_res !== null) {
            $link = \ilLOUtils::getTestResultLinkForUser(
                $a_lo_result["itest"],
                $a_lo_result["user_id"]
            );
 
            if (strlen($link)) {
                $tpl->setCurrentBlock('i_with_link');
                $tpl->setVariable(
                    'IBTN',
                    $renderer->render(
                        $ui_factory->button()->shy(
                            $this->lng->txt('crs_objective_result_details'),
                            $link
                        )
                    )
                );
                $tpl->parseCurrentBlock();
            }
 
            $tpl->setCurrentBlock('res_initial');
            $tpl->setVariable(
                'IRESULT',
                sprintf(
                    $this->lng->txt('crs_objective_result_summary_initial'),
                    $initial_res . '%',
                    (int) $initial_lim . '%'
                )
            );
            $tpl->parseCurrentBlock();
        }
 
        $qual_res = null;
        $qual_lim = null;
 
        if (($a_lo_result['type'] ?? \ilLOUserResults::TYPE_UNDEFINED) == \ilLOUserResults::TYPE_QUALIFIED) {
            $qual_res = (int) $a_lo_result['result_perc'];
            $qual_lim = (int) $a_lo_result['limit_perc'];
        }
 
        if ($qual_res !== null) {
            $link = \ilLOUtils::getTestResultLinkForUser(
                $a_lo_result["qtest"],
                $a_lo_result["user_id"]
            );
 
            if (strlen($link)) {
                $tpl->setCurrentBlock('q_with_link');
                $tpl->setVariable(
                    'QBTN',
                    $renderer->render(
                        $ui_factory->button()->shy(
                            $this->lng->txt('crs_objective_result_details'),
                            $link
                        )
                    )
                );
                $tpl->parseCurrentBlock();
            }
            $tpl->setCurrentBlock('res_qualifying');
            $tpl->setVariable(
                'QRESULT',
                sprintf(
                    $this->lng->txt('crs_objective_result_summary_qualifying'),
                    $qual_res . '%',
                    (int) $qual_lim . '%'
                )
            );
            $tpl->parseCurrentBlock();
        }
 
        //$this->logger->dump($a_lo_result);
 
        $summary = self::getObjectiveResultSummary(
            $this->loc_settings->worksWithInitialTest(),
            $a_objective->getObjectiveId(),
            $a_lo_result ?? []
        );
        if (strlen($summary)) {
            $tpl->setCurrentBlock('objective_summary');
            $tpl->setVariable('SUMMARY_TXT', $summary);
            $tpl->parseCurrentBlock();
        }
 
        // #15510
        $tpl->setVariable("ANCHOR_ID", "objtv_acc_" . $a_objective->getObjectiveId());
 
        return $tpl->get();
    }

◆ buildObjectiveProgressBar()

static ILIAS\Containter\Content\ObjectiveRenderer::buildObjectiveProgressBar	(	bool	$a_has_initial_test,
		int	$a_objective_id,
		array	$a_lo_result,
		bool	$a_list_mode = `false`,
		bool	$a_sub = `false`,
		?string	$a_tt_suffix = `null`
	)

static

Render progressbar(s) for given objective and result data.

Definition at line 782 of file class.ObjectiveRenderer.php.

     : string {
        global $DIC;
 
        $lng = $DIC->language();
        $lng->loadLanguageModule('crs');
 
        // tooltip (has to be unique!)
 
        $tooltip_id = "crsobjtvusr_" . $a_objective_id . "_" . $a_lo_result["type"] . "_" . ((int) $a_sub);
        if ($a_tt_suffix !== null) {
            $tooltip_id .= "_" . $a_tt_suffix;
        }
 
        $tt_txt = sprintf(
            $lng->txt("crs_loc_tt_info"),
            $a_lo_result["result_perc"] ?? '0',
            $a_lo_result["limit_perc"] ?? '0'
        );
 
 
        $is_qualified = ($a_lo_result["type"] == \ilLOUserResults::TYPE_QUALIFIED);
        $is_qualified_initial = ($a_lo_result['type'] == \ilLOUserResults::TYPE_INITIAL &&
            \ilLOSettings::getInstanceByObjId($a_lo_result['course_id'] ?? 0)->isInitialTestQualifying());
        $has_completed = (($a_lo_result["status"] ?? 0) == \ilLOUserResults::STATUS_COMPLETED);
 
        $next_step = $progress_txt = $bar_color = $test_url = $initial_sub = null;
        $compare_value = null;
 
        if ($is_qualified ||
            $is_qualified_initial) {
            $progress_txt = $lng->txt("crs_loc_progress_result_qtest");
            $tt_txt = $lng->txt("crs_loc_tab_qtest") . ": " . $tt_txt;
 
            if ($has_completed) {
                $next_step = $lng->txt("crs_loc_progress_objective_complete");
                $bar_color = "ilCourseObjectiveProgressBarCompleted";
 
                // render 2nd progressbar if there is also an initial test
                if ($is_qualified &&
                    $a_has_initial_test &&
                    is_array($a_lo_result["initial"])) {
                    $a_lo_result["initial"]["itest"] = $a_lo_result["itest"];
 
                    // force list mode to get rid of next step
                    #$initial_sub = self::buildObjectiveProgressBar(true, $a_objective_id, $a_lo_result["initial"], true, true, $a_tt_suffix);
                    $compare_value = $a_lo_result['initial']['result_perc'];
                }
            } else {
                $next_step = $lng->txt("crs_loc_progress_do_qualifying_again");
                $bar_color = "ilCourseObjectiveProgressBarFailed";
            }
        }
        // initial test
        else {
            if ($a_lo_result["status"] ?? 0) {
                $progress_txt = $lng->txt("crs_loc_progress_result_itest");
                $tt_txt = $lng->txt("crs_loc_tab_itest") . ": " . $tt_txt;
 
                $bar_color = "ilCourseObjectiveProgressBarNeutral";
                $next_step = $has_completed
                    ? $lng->txt("crs_loc_progress_do_qualifying")
                    : $lng->txt("crs_loc_suggested");
            }
            // not attempted: no progress bar
            else {
                $next_step = $a_has_initial_test
                    ? $lng->txt("crs_loc_progress_no_result_do_initial")
                    : $lng->txt("crs_loc_progress_no_result_no_initial");
            }
        }
 
        // link to test statistics
        $relevant_test_id = ($a_lo_result["qtest"] ?? 0)
            ?: ($a_lo_result["itest"] ?? 0);
        if ($relevant_test_id) {
            $test_url = \ilLOUtils::getTestResultLinkForUser($relevant_test_id, $a_lo_result["user_id"] ?? 0);
        }
 
        $main_text = $lng->txt('crs_loc_itest_info');
        if ($a_lo_result['type'] == \ilLOSettings::TYPE_TEST_QUALIFIED) {
            $main_text = $lng->txt('crs_loc_qtest_info');
        }
 
 
 
        return self::renderProgressMeter(
            $a_lo_result["result_perc"] ?? null,
            $a_lo_result["limit_perc"] ?? null,
            $compare_value,
            $progress_txt,
            $test_url,
            $tooltip_id,
            $tt_txt,
            $a_list_mode
                ? null
                : $next_step,
            (bool) $initial_sub,
            $a_list_mode
                ? 30
                : 10,
            $main_text,
            $lng->txt('crs_lobj_pm_min_goal')
        );
    }

◆ getContent()

ILIAS\Containter\Content\ObjectiveRenderer::getContent ( )

Definition at line 149 of file class.ObjectiveRenderer.php.

                                : string
    {
        return $this->output_html;
    }

References ILIAS\Containter\Content\ObjectiveRenderer\$output_html.

◆ getObjectiveResultSummary()

static ILIAS\Containter\Content\ObjectiveRenderer::getObjectiveResultSummary	(	bool	$a_has_initial_test,
		int	$a_objective_id,
		array	$a_lo_result
	)

static

Get objective result summary.

Definition at line 727 of file class.ObjectiveRenderer.php.

     : string {
        global $DIC;
 
        if ($a_lo_result === null) {
            $a_lo_result["type"] = null;
        }
        if (!isset($a_lo_result["type"])) {
            $a_lo_result["type"] = null;
        }
 
        $lng = $DIC->language();
        $lng->loadLanguageModule('crs');
 
        $is_qualified =
            ($a_lo_result["type"] == \ilLOUserResults::TYPE_QUALIFIED);
        $is_qualified_initial =
            (
                $a_lo_result['type'] == \ilLOUserResults::TYPE_INITIAL &&
                \ilLOSettings::getInstanceByObjId($a_lo_result['course_id'] ?? 0)->isInitialTestQualifying()
            );
        $has_completed = (int) ($a_lo_result["status"] ?? 0) === \ilLOUserResults::STATUS_COMPLETED;
 
        $next_step = $progress_txt = $bar_color = $test_url = $initial_sub = null;
 
        if (
            $is_qualified ||
            $is_qualified_initial) {
            if ($has_completed) {
                $next_step = $lng->txt("crs_loc_progress_objective_complete");
            } else {
                $next_step = $lng->txt("crs_loc_progress_do_qualifying_again");
            }
        } // initial test
        else {
            if ($a_lo_result["status"] ?? 0) {
                $next_step =
                    $has_completed ?
                        $lng->txt("crs_loc_progress_do_qualifying") :
                        $lng->txt("crs_loc_suggested");
            } else {
                $next_step = $a_has_initial_test ?
                    $lng->txt("crs_loc_progress_no_result_do_initial") :
                    $lng->txt("crs_loc_progress_no_result_no_initial");
            }
        }
        return $next_step;
    }

◆ parseLOUserResults()

ILIAS\Containter\Content\ObjectiveRenderer::parseLOUserResults ( )

protected

Definition at line 605 of file class.ObjectiveRenderer.php.

                                           : array
    {
        $ilUser = $this->domain->user();
        $initial_status = null;
 
        $res = array();
 
        $lo_ass = \ilLOTestAssignments::getInstance($this->container->getId());
 
        $lur = new \ilLOUserResults($this->container->getId(), $ilUser->getId());
        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;
 
            $result["itest"] = $lo_ass->getTestByObjective($objective_id, \ilLOSettings::TYPE_TEST_INITIAL);
            $result["qtest"] = $lo_ass->getTestByObjective($objective_id, \ilLOSettings::TYPE_TEST_QUALIFIED);
 
            $res[$objective_id] = $result;
        }
 
        return $res;
    }

References $res, ilLOTestAssignments\getInstance(), ilLOUserResults\TYPE_INITIAL, ilLOUserResults\TYPE_QUALIFIED, ilLOSettings\TYPE_TEST_INITIAL, and ilLOSettings\TYPE_TEST_QUALIFIED.

Referenced by ILIAS\Containter\Content\ObjectiveRenderer\showObjectives().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderObjective()

ILIAS\Containter\Content\ObjectiveRenderer::renderObjective	(	int	$a_objective_id,
		bool &	$a_has_lo_page,
		?\ilAccordionGUI	$a_accordion = `null`,
		?array	$a_lo_result = `null`
	)

protected

Parameters

int	$a_objective_id
bool	$a_has_lo_page
\ilAccordionGUI \| null	$a_accordion	if not given, returned as string
array \| null	$a_lo_result

Returns: string

Exceptions

ilTemplateException

Definition at line 412 of file class.ObjectiveRenderer.php.

     : string {
        $ilUser = $this->domain->user();
        $lng = $this->domain->lng();
 
        $objective = new \ilCourseObjective($this->container, $a_objective_id);
 
        $items = \ilObjectActivation::getItemsByObjective($a_objective_id);
 
        // sorting is handled by ilCourseObjectiveMaterials
        // $items = ilContainerSorting::_getInstance($this->getContainerObject()->getId())->sortSubItems('lobj',$a_objective_id,$items);
 
        $objectives_lm_obj = new \ilCourseObjectiveMaterials($a_objective_id);
 
        // #13381 - map material assignment to position
        $sort_map = array();
        foreach ($objectives_lm_obj->getMaterials() as $item) {
            $sort_map[$item["lm_ass_id"]] = $item["position"];
        }
 
        $is_manage = $this->container_gui->isActiveAdministrationPanel();
        $is_order = $this->container_gui->isActiveOrdering();
 
        $sort_content = array();
 
        $access = $this->domain->access();
        foreach ($items as $item) {
 
            if (!$access->checkAccess('visible', '', $item["ref_id"])) {
                continue;
            }
            /*
            if ($this->getDetailsLevel($a_objective_id) < self::DETAILS_ALL) {
                continue;
            }*/
 
            $item_list_gui2 = $this->renderer->getItemRenderer()->getItemGUI($item);
            $item_list_gui2->enableIcon(true);
 
            if ($is_order || $a_accordion) {
                $item_list_gui2->enableCommands(true, true);
                $item_list_gui2->enableProperties(false);
            }
 
            $chapters = $objectives_lm_obj->getChapters();
            if (count($chapters)) {
                $has_sections = false;
                foreach ($chapters as $chapter) {
                    if ($chapter['ref_id'] != $item['child']) {
                        continue;
                    }
                    $has_sections = true;
 
                    $title = $item['title'] .
                        " &rsaquo; " . \ilLMObject::_lookupTitle($chapter['obj_id']) .
                        " (" . $lng->txt('obj_' . $chapter['type']) . ")";
 
                    $item_list_gui2->setDefaultCommandParameters(array(
                        "obj_id" => $chapter['obj_id'],
                        "focus_id" => $chapter['obj_id'],
                        "focus_return" => $this->container->getRefId()));
 
                    if ($is_order) {
                        $item_list_gui2->setPositionInputField(
                            "[lobj][" . $a_objective_id . "][" . $chapter['lm_ass_id'] . "]",
                            sprintf('%d', $chapter['position'] * 10)
                        );
                    }
 
                    $sub_item_html = $item_list_gui2->getListItemHTML(
                        (int) $item['ref_id'],
                        (int) $item['obj_id'],
                        $title,
                        $item['description']
                    );
 
                    // #13381 - use materials order
                    $sort_key = str_pad(
                        (string) $chapter['position'],
                        5,
                        "0",
                        STR_PAD_LEFT
                    ) . "_" . strtolower($title) . "_" . $chapter['lm_ass_id'];
                    $sort_content[$sort_key] = $sub_item_html;
                }
            }
 
            $this->rendered_items[$item['child']] = true;
 
            if ($lm_ass_id = $objectives_lm_obj->isAssigned((int) $item['ref_id'], true)) {
                if ($is_order) {
                    $item_list_gui2->setPositionInputField(
                        "[lobj][" . $a_objective_id . "][" . $lm_ass_id . "]",
                        sprintf('%d', $sort_map[$lm_ass_id] * 10)
                    );
                }
 
                $sub_item_html = $item_list_gui2->getListItemHTML(
                    $item['ref_id'],
                    $item['obj_id'],
                    $item['title'],
                    $item['description']
                );
 
                // #13381 - use materials order
                $sort_key = str_pad((string) $sort_map[$lm_ass_id], 5, "0", STR_PAD_LEFT) . "_" . strtolower($item['title']) . "_" . $lm_ass_id;
                $sort_content[$sort_key] = $sub_item_html;
            }
        }
 
        //if ($this->getDetailsLevel($a_objective_id) == self::DETAILS_ALL) {
        $this->objective_list_gui->enableCommands(false);
        //} else {
        //    $this->objective_list_gui->enableCommands(true);
        //}
 
        if ($is_order) {
            $this->objective_list_gui->setPositionInputField(
                "[lobj][" . $a_objective_id . "][0]",
                (string) ($objective->__getPosition() * 10)
            );
        }
 
        ksort($sort_content);
        if (!$a_accordion) {
            foreach ($sort_content as $sub_item_html) {
                $this->objective_list_gui->addSubItemHTML($sub_item_html);
            }
 
            return $this->objective_list_gui->getObjectiveListItemHTML(
                0,
                $a_objective_id,
                $objective->getTitle(),
                $objective->getDescription(),
                ($is_manage || $is_order)
            );
        } else {
            $acc_content = $sort_content;
 
            $initial_shown = false;
            $initial_test_ref_id = $this->test_assignments->getTestByObjective($a_objective_id, \ilLOSettings::TYPE_TEST_INITIAL);
            $initial_test_obj_id = \ilObject::_lookupObjId($initial_test_ref_id);
 
            if (
                $initial_test_obj_id &&
                $this->loc_settings->hasSeparateInitialTests() &&
                !\ilObjTestAccess::checkCondition($initial_test_obj_id, \ilConditionHandler::OPERATOR_FINISHED, '', $ilUser->getId())
            ) {
                $acc_content[] = $this->renderTest(
                    $this->test_assignments->getTestByObjective($a_objective_id, \ilLOSettings::TYPE_TEST_INITIAL),
                    $a_objective_id,
                    true
                );
                $initial_shown = true;
            } elseif ($this->loc_settings->hasSeparateQualifiedTests()) {
                $acc_content[] = $this->renderTest(
                    $this->test_assignments->getTestByObjective($a_objective_id, \ilLOSettings::TYPE_TEST_QUALIFIED),
                    $a_objective_id,
                    false
                );
            }
 
            $co_page = null;
            if (\ilPageUtil::_existsAndNotEmpty("lobj", $objective->getObjectiveId())) {
                $a_has_lo_page = true;
 
                $page_gui = new \ilLOPageGUI($objective->getObjectiveId());
 
                $page_gui->setStyleId(
                    $this->content_style_domain->getEffectiveStyleId()
                );
                $page_gui->setPresentationTitle("");
                $page_gui->setTemplateOutput(false);
                $page_gui->setHeader("");
 
                $co_page = "<div class='ilContObjectiveIntro'>" . $page_gui->showPage() . "</div>";
            }
 
            $a_accordion->addItem(
                $this->buildAccordionTitle($objective, $a_lo_result),
                $co_page .
                $this->buildAccordionContent($acc_content),
                ($this->request->getObjectiveId() == $objective->getObjectiveId())
            );
        }
        return "";
    }

Referenced by ILIAS\Containter\Content\ObjectiveRenderer\showObjectives().

Here is the caller graph for this function:

◆ renderObjectives()

ILIAS\Containter\Content\ObjectiveRenderer::renderObjectives ( )

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

                                      : string
    {
        $mode = $this->domain->content()->mode($this->container);
        $user = $this->domain->user();
        $access = $this->domain->access();
        $lng = $this->domain->lng();
 
        $is_manage = $mode->isAdminMode();
        $is_order = $mode->isOrderingMode();
 
        if (!$is_manage) {
 
            // render objectives
            $this->showObjectives($is_order);
 
            // check for results
            $has_results = \ilLOUserResults::hasResults($this->container->getId(), $user->getId());
 
            $tst_obj_id = \ilObject::_lookupObjId($this->loc_settings->getInitialTest());
 
            // render initial/qualified test
            if (
                $this->loc_settings->getInitialTest() &&
                $this->loc_settings->isGeneralInitialTestVisible() &&
                !$this->loc_settings->isInitialTestStart() &&
                !\ilObjTestAccess::checkCondition(
                    $tst_obj_id,
                    \ilConditionHandler::OPERATOR_FINISHED,
                    '',
                    $user->getId()
                )
            ) {
                $this->output_html .= $this->renderTest($this->loc_settings->getInitialTest(), null, true);
            } elseif (
                $this->loc_settings->getQualifiedTest() &&
                $this->loc_settings->isGeneralQualifiedTestVisible()
            ) {
                $this->output_html .= $this->renderTest($this->loc_settings->getQualifiedTest(), null, false);
            }
 
            // render other materials
            //$this->showMaterials(self::MATERIALS_OTHER, false, !$is_order);
        } else {
 
            // render all materials
            // not needed anymore
            //$this->showMaterials(null, true);
        }
 
        // reset results by setting or for admins
        if (
            \ilLOSettings::getInstanceByObjId($this->container->getId())->isResetResultsEnabled() or
            $access->checkAccess('write', '', $this->container->getRefId())
        ) {
            if ($has_results) {
                if (!$is_manage && !$is_order) {
                    $this->showButton('askReset', $lng->txt('crs_reset_results'));
                }
            }
        }
        return $this->output_html;
    }

References ILIAS\Containter\Content\ObjectiveRenderer\$lng, ILIAS\Containter\Content\ObjectiveRenderer\$output_html, ilObject\_lookupObjId(), ilConditionHandling\checkCondition(), ilLOSettings\getInstanceByObjId(), ilLOUserResults\hasResults(), ilConditionHandler\OPERATOR_FINISHED, ILIAS\Containter\Content\ObjectiveRenderer\renderTest(), ILIAS\Containter\Content\ObjectiveRenderer\showButton(), and ILIAS\Containter\Content\ObjectiveRenderer\showObjectives().

Here is the call graph for this function:

◆ renderProgressMeter()

static ILIAS\Containter\Content\ObjectiveRenderer::renderProgressMeter	(	?int	$a_perc_result = `null`,
		?int	$a_perc_limit = `null`,
		?int	$a_compare_value = `null`,
		?string	$a_caption = `null`,
		?string	$a_url = `null`,
		?string	$a_tt_id = `null`,
		?string	$a_tt_txt = `null`,
		?string	$a_next_step = `null`,
		bool	$a_sub = `false`,
		int	$a_sub_style = `30`,
		string	$a_main_text = `''`,
		string	$a_required_text = `''`
	)

static

Render progress meter.

Parameters

int \| null	$a_perc_result
int \| null	$a_perc_limit
int \| null	$a_compare_value
string \| null	$a_caption
string \| null	$a_url
string \| null	$a_tt_id	(deprecated, does not seem to be used)
string \| null	$a_tt_txt	(deprecated, does not seem to be used)
string \| null	$a_next_step
bool	$a_sub
int	$a_sub_style
string	$a_main_text
string	$a_required_text

Returns: string

Definition at line 659 of file class.ObjectiveRenderer.php.

     : string {
        global $DIC;
 
        $tpl = new \ilTemplate("tpl.objective_progressmeter.html", true, true, "components/ILIAS/Container");
 
        $lng = $DIC->language();
        $lng->loadLanguageModule('crs');
 
 
 
        if (is_numeric($a_perc_result)) {
            $uiFactory = $DIC->ui()->factory();
            $uiRenderer = $DIC->ui()->renderer();
 
            $pMeter = $uiFactory->chart()->progressMeter()->standard(
                100,
                (int) $a_perc_result,
                (int) $a_perc_limit,
                (int) $a_compare_value
            );
            $tpl->setVariable('PROGRESS_METER', $uiRenderer->render($pMeter));
        }
 
        if ($a_caption) {
            if ($a_url) {
                $button = \ilLinkButton::getInstance();
                $button->setCaption($a_caption, false);
                $button->setUrl($a_url);
 
                $tpl->setCurrentBlock("statustxt_bl");
                $tpl->setVariable("TXT_PROGRESS_STATUS", $button->render());
            } else {
                $tpl->setCurrentBlock("statustxt_no_link_bl");
                $tpl->setVariable("TXT_PROGRESS_STATUS_NO_LINK", $a_caption);
            }
            $tpl->parseCurrentBlock();
        }
 
        if ($a_next_step) {
            //$tpl->setCurrentBlock("nstep_bl");
            $tpl->setVariable("TXT_NEXT_STEP", $a_next_step);
            //$tpl->parseCurrentBlock();
        }
 
        if ($a_sub) {
            $tpl->setVariable("SUB_STYLE", ' style="padding-left: ' . $a_sub_style . 'px;"');
            $tpl->setVariable("SUB_INIT", $a_sub);
        }
 
        return $tpl->get();
    }

◆ renderTest()

ILIAS\Containter\Content\ObjectiveRenderer::renderTest	(	int	$a_test_ref_id,
		?int	$a_objective_id,
		bool	$a_is_initial = `false`
	)

protected

Definition at line 223 of file class.ObjectiveRenderer.php.

     : string {
        $tree = $this->domain->repositoryTree();
        $lng = $this->domain->lng();
 
        $node_data = [];
        if ($a_test_ref_id) {
            $node_data = $tree->getNodeData($a_test_ref_id);
        }
        if (!isset($node_data['child']) || !$node_data['child']) {
            return '';
        }
 
        // update ti
        if ($a_objective_id) {
            if ($a_is_initial) {
                $title = sprintf($lng->txt('crs_loc_itst_for_objective'), \ilCourseObjective::lookupObjectiveTitle($a_objective_id));
            } else {
                $title = sprintf($lng->txt('crs_loc_qtst_for_objective'), \ilCourseObjective::lookupObjectiveTitle($a_objective_id));
            }
            $node_data['objective_id'] = $a_objective_id;
            $node_data['objective_status'] = false;
        } else {
            $obj_id = \ilObject::_lookupObjId($a_test_ref_id);
            $title = \ilObject::_lookupTitle($obj_id);
 
            $title .= (
                ' (' .
                (
                    $a_is_initial
                    ? $lng->txt('crs_loc_itest_info')
                    : $lng->txt('crs_loc_qtest_info')
                ) .
                ')'
            );
            $node_data['objective_id'] = 0;
        }
 
        $node_data['title'] = $title;
        return "<div class='ilContObjectivesViewTestItem'>" . $this->renderer->getItemRenderer()->renderItem($node_data) . "</div>";
    }

Referenced by ILIAS\Containter\Content\ObjectiveRenderer\renderObjectives().

Here is the caller graph for this function:

◆ showButton()

ILIAS\Containter\Content\ObjectiveRenderer::showButton	(	string	$a_cmd,
		string	$a_text,
		string	$a_target = `''`,
		string	$a_id = `""`
	)

protected

Definition at line 1036 of file class.ObjectiveRenderer.php.

     : void {
        $ilToolbar = $this->gui->toolbar();
        $ilCtrl = $this->gui->ctrl();
 
        // #11842
        $ilToolbar->addButton(
            $a_text,
            $ilCtrl->getLinkTarget($this->container_gui, $a_cmd),
            $a_target,
            null,
            '',
            $a_id
        );
    }

Referenced by ILIAS\Containter\Content\ObjectiveRenderer\renderObjectives(), and ILIAS\Containter\Content\ObjectiveRenderer\showObjectives().

Here is the caller graph for this function:

◆ showObjectives()

ILIAS\Containter\Content\ObjectiveRenderer::showObjectives ( bool $a_is_order = false )

Definition at line 154 of file class.ObjectiveRenderer.php.

                                                            : void
    {
        $lng = $this->domain->lng();
        $ilSetting = $this->domain->settings();
        // All objectives
        if (!count($objective_ids = \ilCourseObjective::_getObjectiveIds($this->container->getId(), true))) {
            return;
        }
        $this->objective_list_gui = new \ilCourseObjectiveListGUI();
        $this->objective_list_gui->setContainerObject($this->container_gui);
        if ($ilSetting->get("icon_position_in_lists") === "item_rows") {
            $this->objective_list_gui->enableIcon(true);
        }
 
        $acc = null;
        if (!$a_is_order) {
            $acc = new \ilAccordionGUI();
            $acc->setUseSessionStorage(true);
            $acc->setAllowMultiOpened(true);
            $acc->setBehaviour(\ilAccordionGUI::FIRST_OPEN);
            $acc->setId("crsobjtv_" . $this->container->getId());
        } else {
            $this->renderer->addCustomBlock('lobj', $lng->txt('crs_objectives'));
        }
 
        $lur_data = $this->parseLOUserResults();
        $has_initial = \ilLOSettings::getInstanceByObjId($this->container->getId())->worksWithInitialTest();
        $has_lo_page = false;
        $obj_cnt = 0;
        foreach ($objective_ids as $objective_id) {
            if (
                $has_initial &&
                (
                    !isset($lur_data[$objective_id]) or
                    \ilLOUtils::hasActiveRun(
                        $this->container->getId(),
                        \ilLOSettings::getInstanceByObjId($this->container->getId())->getInitialTest(),
                        $objective_id
                    )
                )
            ) {
                $lur_data[$objective_id] = array("type" => \ilLOSettings::TYPE_TEST_INITIAL);
            }
            if ($html = $this->renderObjective((int) $objective_id, $has_lo_page, $acc, $lur_data[$objective_id] ?? null)) {
                $this->renderer->addItemToBlock('lobj', 'lobj', $objective_id, $html);
            }
            $obj_cnt++;
        }
 
        // buttons for showing/hiding all objectives
        if (!$a_is_order && $obj_cnt > 1) {
            $this->showButton("", $lng->txt("crs_show_all_obj"), "", "crs_show_all_obj_btn");
            $this->showButton("", $lng->txt("crs_hide_all_obj"), "", "crs_hide_all_obj_btn");
            $acc->setShowAllElement("crs_show_all_obj_btn");
            $acc->setHideAllElement("crs_hide_all_obj_btn");
        }
 
        // order/block
        if ($a_is_order) {
            $this->output_html .= $this->renderer->getHTML();
 
            $this->renderer->resetDetails();
        }
        // view/accordion
        else {
            $this->output_html .= "<div class='ilCrsObjAcc'>" . $acc->getHTML() . "</div>";
        }
    }