This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilContainerObjectiveGUI:

Collaboration diagram for ilContainerObjectiveGUI:

Public Member Functions
	__construct (ilContainerGUI $a_container_gui)

	getTestAssignments ()

	getSettings ()

	getMainContent ()
	Get content HTML for main column, this one must be overwritten in derived classes. More...

	showStatus ()

	showObjectives (bool $a_is_order=false)

Public Member Functions inherited from ilContainerContentGUI
	getContainerObject ()

	getContainerGUI ()

	setOutput ()
	This method sets the output of the right and main column in the global standard template. More...

	getMainContent ()
	Get content HTML for main column, this one must be overwritten in derived classes. More...

	determinePageEmbeddedBlocks (string $a_container_page_html)
	Determine all blocks that are embedded in the container page. More...

	addEmbeddedBlock (string $block_type, $block_parameter)
	Add embedded block. More...

	getEmbeddedBlocks ()

	renderPageEmbeddedBlocks ()

	renderItem (array $a_item_data, int $a_position=0, bool $a_force_icon=false, string $a_pos_prefix="", string $item_group_list_presentation="")
	Render an item. More...

	renderCard (array $a_item_data, int $a_position=0, bool $a_force_icon=false, string $a_pos_prefix="")

	insertPageEmbeddedBlocks (string $a_output_html)
	Insert blocks into container page. More...

	getSingleTypeBlockAsynch (string $type)
	Render single block. More...

	getGroupedObjTypes ()
	Get grouped repository object types. More...

	getIntroduction ()

	getItemGroupsHTML (int $a_pos=0)

	renderItemGroup (array $a_itgr)

Static Public Member Functions
static	renderProgressBar (int $a_perc_result=null, int $a_perc_limit=null, string $a_css=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)
	Render progress bar(s) More...

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 bar(s) 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

Data Fields inherited from ilContainerContentGUI
const	DETAILS_DEACTIVATED = 0

const	DETAILS_TITLE = 1

const	DETAILS_ALL = 2

const	VIEW_MODE_LIST = 0

const	VIEW_MODE_TILE = 1

ilContainerGUI	$container_gui

ilContainer	$container_obj

bool	$adminCommands = false

Protected Member Functions
	getDetailsLevel (int $a_item_id)

	renderTest (int $a_test_ref_id, int $a_objective_id, bool $a_is_initial=false)

	showMaterials (int $a_mode=null, bool $a_is_manage=false, bool $a_as_accordion=false)

	buildObjectiveMap ()

	addItemDetails (ilObjectListGUI $a_item_list_gui, array $a_item)

	updateResult (array $a_res, int $a_item_ref_id, int $a_objective_id, int $a_user_id)

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

	initTestAssignments ()

	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 Member Functions inherited from ilContainerContentGUI
	getViewMode ()

	getDetailsLevel (int $a_item_id)

	getRightColumnHTML ()

	getCenterColumnHTML ()

	initRenderer ()
	Init container renderer. More...

	clearAdminCommandsDetermination ()

	determineAdminCommands (int $a_ref_id, bool $a_admin_com_included_in_list=false)

	getItemGUI (array $item_data)

	hasForcedOrderByStartDate (string $type)

	handleSessionExpand ()

Protected Attributes
ilTabsGUI	$tabs

array	$objective_map = []

ilToolbarGUI	$toolbar

int	$force_details = 0

ilCourseObjectiveListGUI	$objective_list_gui

array	$rendered_items = []

ilLOSettings	$loc_settings

ILIAS Style Content Object ObjectFacade	$content_style_domain

Protected Attributes inherited from ilContainerContentGUI
ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilObjUser	$user

ilLanguage	$lng

ilAccessHandler	$access

ilDBInterface	$db

ilRbacSystem	$rbacsystem

ilSetting	$settings

ilObjectDefinition	$obj_definition

int	$details_level = self::DETAILS_DEACTIVATED

ilContainerRenderer	$renderer

ilLogger	$log

int	$view_mode

array	$embedded_block = []

array	$items = []

array	$list_gui = []

ClipboardManager	$clipboard

StandardGUIRequest	$request

ItemManager	$item_manager

BlockSessionRepository	$block_repo

Private Attributes
ilLogger	$logger

string	$output_html = ''

ilLOTestAssignments	$test_assignments = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning /** GUI class for course objective view

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerObjectiveGUI::__construct ( ilContainerGUI $a_container_gui )

Definition at line 42 of file class.ilContainerObjectiveGUI.php.

    {
        global $DIC;
 
        $this->tabs = $DIC->tabs();
        $this->access = $DIC->access();
        $this->user = $DIC->user();
        $this->settings = $DIC->settings();
        $this->ctrl = $DIC->ctrl();
        $this->toolbar = $DIC->toolbar();
        $lng = $DIC->language();
        $this->logger = $DIC->logger()->crs();
 
        $this->lng = $lng;
        parent::__construct($a_container_gui);
 
        $this->initTestAssignments();
 
        // ak: note, also in ILIAS <= 7 this page did not
        // use the container style, it could however, but this would be a conceptual change
        $this->content_style_domain = $DIC
            ->contentStyle()
            ->domain()
            ->styleForObjId(0);
    }

References $DIC, ilContainerContentGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), initTestAssignments(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addItemDetails()

ilContainerObjectiveGUI::addItemDetails	(	ilObjectListGUI	$a_item_list_gui,
		array	$a_item
	)

protected

Definition at line 473 of file class.ilContainerObjectiveGUI.php.

                                                                                      : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        $item_ref_id = $a_item["ref_id"];
 
        if (is_array($this->objective_map)) {
            $details = [];
            if (isset($this->objective_map["material"][$item_ref_id])) {
                // #12965
                foreach ($this->objective_map["material"][$item_ref_id] as $objective_id) {
                    $ilCtrl->setParameterByClass('ilcourseobjectivesgui', 'objective_id', $objective_id);
                    $url = $ilCtrl->getLinkTargetByClass(['illoeditorgui', 'ilcourseobjectivesgui'], 'edit');
                    $ilCtrl->setParameterByClass('ilcourseobjectivesgui', 'objective_id', '');
 
                    $details[] = [
                        'desc' => $lng->txt('crs_loc_tab_materials') . ': ',
                        'target' => '_top',
                        'link' => $url,
                        'name' => $this->objective_map["names"][$objective_id]
                    ];
                }
            }
            if (($this->objective_map["test_i"] ?? 0) == $item_ref_id) {
                $ilCtrl->setParameterByClass('illoeditorgui', 'tt', 1);
                $details[] = [
                    'desc' => '',
                    'target' => '_top',
                    'link' => $ilCtrl->getLinkTargetByClass('illoeditorgui', 'testOverview'),
                    'name' => $lng->txt('crs_loc_tab_itest')
                ];
                $ilCtrl->setParameterByClass('illoeditorgui', 'tt', 0);
            }
            if (($this->objective_map["test_q"] ?? 0) == $item_ref_id) {
                $ilCtrl->setParameterByClass('illoeditorgui', 'tt', 2);
                $details[] = [
                    'desc' => '',
                    'target' => '_top',
                    'link' => $ilCtrl->getLinkTargetByClass('illoeditorgui', 'testOverview'),
                    'name' => $lng->txt('crs_loc_tab_qtest')
                ];
                $ilCtrl->setParameterByClass('illoeditorgui', 'tt', 0);
            }
 
            // #15367
            if (is_array($this->objective_map["test_ass"][$item_ref_id] ?? false)) {
                foreach ($this->objective_map["test_ass"][$item_ref_id] as $type => $items) {
                    if ($type == ilLOSettings::TYPE_TEST_INITIAL) {
                        $caption = $lng->txt('crs_loc_tab_itest');
                        $ilCtrl->setParameterByClass('illoeditorgui', 'tt', 1);
                    } else {
                        $caption = $lng->txt('crs_loc_tab_qtest');
                        $ilCtrl->setParameterByClass('illoeditorgui', 'tt', 2);
                    }
                    foreach ($items as $objtv_title) {
                        $details[] = [
                            'desc' => '',
                            'target' => '_top',
                            'link' => $ilCtrl->getLinkTargetByClass('illoeditorgui', 'testsOverview'),
                            'name' => $caption . " (" . $this->lng->txt("crs_loc_learning_objective") . ": " . $objtv_title . ")"
                        ];
                    }
                    $ilCtrl->setParameterByClass('illoeditorgui', 'tt', 0);
                }
            }
 
            if (count($details)) {
                $a_item_list_gui->enableItemDetailLinks(true);
                $a_item_list_gui->setItemDetailLinks($details, $lng->txt('crs_loc_settings_tbl') . ': ');
            } else {
                $a_item_list_gui->enableItemDetailLinks(false);
            }
        }
 
        // order
        if ($this->getContainerGUI()->isActiveOrdering()) {
            $a_item_list_gui->enableCommands(true, true);
            $a_item_list_gui->enableProperties(false);
        }
        // view
        elseif (!$this->getContainerGUI()->isActiveAdministrationPanel()) {
            $a_item_list_gui->enableCommands(true, true);
            $a_item_list_gui->enableProperties(false);
        }
 
        if ($a_item['objective_id'] ?? false) {
            $a_item_list_gui->setDefaultCommandParameters(['objective_id' => $a_item['objective_id']]);
 
 
            if ($this->loc_settings->getQualifiedTest() == $a_item['ref_id']) {
                $a_item_list_gui->setConditionTarget($this->getContainerObject()->getRefId(), (int) $a_item['objective_id'], 'lobj');
                // check conditions of target
                $fullfilled = ilConditionHandler::_checkAllConditionsOfTarget($this->getContainerObject()->getRefId(), (int) $a_item['objective_id'], 'lobj');
                if (!$fullfilled || $a_item['objective_status']) {
                    $a_item_list_gui->disableTitleLink(true);
                }
            }
            $res = ilLOUserResults::lookupResult(
                $this->getContainerObject()->getId(),
                $ilUser->getId(),
                $a_item['objective_id'],
                ilLOUserResults::TYPE_QUALIFIED
            );
 
            $res = $this->updateResult($res, $a_item['ref_id'], $a_item['objective_id'], $ilUser->getId());
 
            if ($res['is_final'] ?? false) {
                $a_item_list_gui->disableTitleLink(true);
                $a_item_list_gui->enableProperties(true);
                $a_item_list_gui->addCustomProperty(
                    $this->lng->txt('crs_loc_passes_reached'),
                    '',
                    true
                );
            } elseif ($this->loc_settings->getQualifiedTest() == $a_item['ref_id']) {
                $poss_pass = ilCourseObjective::lookupMaxPasses($a_item['objective_id']);
 
                if ($poss_pass) {
                    $a_item_list_gui->enableProperties(true);
                    $a_item_list_gui->addCustomProperty(
                        $this->lng->txt('crs_loc_passes_left'),
                        (($poss_pass - $res['tries']) > 0) ? ($poss_pass - $res['tries']) : 1,
                        false
                    );
                }
            }
        }
    }

References ILIAS\LTI\ToolProvider\$details, $ilUser, $lng, $res, $type, $url, ilConditionHandler\_checkAllConditionsOfTarget(), ilObjectListGUI\addCustomProperty(), ilObjectListGUI\disableTitleLink(), ilObjectListGUI\enableCommands(), ilObjectListGUI\enableItemDetailLinks(), ilObjectListGUI\enableProperties(), ILIAS\Survey\Mode\getId(), ILIAS\Repository\lng(), ilCourseObjective\lookupMaxPasses(), ilLOUserResults\lookupResult(), ilObjectListGUI\setConditionTarget(), ilObjectListGUI\setDefaultCommandParameters(), ilObjectListGUI\setItemDetailLinks(), ilLOUserResults\TYPE_QUALIFIED, and ilLOSettings\TYPE_TEST_INITIAL.

Here is the call graph for this function:

◆ buildAccordionContent()

ilContainerObjectiveGUI::buildAccordionContent ( array $a_items )

protected

Definition at line 1327 of file class.ilContainerObjectiveGUI.php.

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

References $tpl.

◆ buildAccordionTitle()

ilContainerObjectiveGUI::buildAccordionTitle	(	ilCourseObjective	$a_objective,
		array	$a_lo_result = `null`
	)

protected

Definition at line 1196 of file class.ilContainerObjectiveGUI.php.

     : string {
        global $DIC;
 
        $renderer = $DIC->ui()->renderer();
        $ui_factory = $DIC->ui()->factory();
 
        $tpl = new ilTemplate("tpl.objective_accordion_title.html", true, true, "Services/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'] ?? 0);
            }
            if (
                $a_lo_result['type'] == ilLOUserResults::TYPE_INITIAL &&
                isset($a_lo_result['result_perc'])
            ) {
                $initial_res = (int) ($a_lo_result['result_perc'] ?? 0);
                $initial_lim = (int) ($a_lo_result['limit_perc'] ?? 0);
            }
        }
 
        if ($initial_res !== null) {
            $link = ilLOUtils::getTestResultLinkForUser(
                $a_lo_result["itest"],
                $a_lo_result["user_id"]
            );
 
            if ($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'] ?? null) == 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 ($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 ($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();
    }

◆ buildObjectiveMap()

ilContainerObjectiveGUI::buildObjectiveMap ( )

protected

Definition at line 431 of file class.ilContainerObjectiveGUI.php.

                                          : array
    {
        $objective_map = [];
        // begin-patch lok
        if (count($objective_ids = ilCourseObjective::_getObjectiveIds($this->getContainerObject()->getId(), true))) {
            // end-patch lok
            foreach ($objective_ids as $objective_id) {
                foreach (ilCourseObjectiveMaterials::_getAssignedMaterials($objective_id) as $mat_ref_id) {
                    $objective_map["material"][$mat_ref_id][] = $objective_id;
 
                    if (!isset($objective_map["names"][$objective_id])) {
                        $objective = new ilCourseObjective($this->getContainerObject(), $objective_id);
                        $objective_map["names"][$objective_id] = $objective->getTitle();
                    }
                }
            }
 
            // initial/qualifying test
            $tst = $this->loc_settings->getInitialTest();
            if ($tst) {
                $objective_map["test_i"] = $tst;
            }
            $tst = $this->loc_settings->getQualifiedTest();
            if ($tst) {
                $objective_map["test_q"] = $tst;
            }
 
            // objective test assignments
            $ass_test = new ilLOTestAssignments($this->getContainerObject()->getId());
            foreach ($ass_test->getAssignmentsByType(ilLOSettings::TYPE_TEST_INITIAL) as $ass) {
                $title = ilCourseObjective::lookupObjectiveTitle($ass->getObjectiveId());
                $objective_map["test_ass"][$ass->getTestRefId()][$ass->getAssignmentType()][] = $title;
            }
            foreach ($ass_test->getAssignmentsByType(ilLOSettings::TYPE_TEST_QUALIFIED) as $ass) {
                $title = ilCourseObjective::lookupObjectiveTitle($ass->getObjectiveId());
                $objective_map["test_ass"][$ass->getTestRefId()][$ass->getAssignmentType()][] = $title;
            }
        }
 
        return $objective_map;
    }

References ilCourseObjectiveMaterials\_getAssignedMaterials(), ilCourseObjective\_getObjectiveIds(), ILIAS\Survey\Mode\getId(), ilCourseObjective\lookupObjectiveTitle(), ilLOSettings\TYPE_TEST_INITIAL, and ilLOSettings\TYPE_TEST_QUALIFIED.

Here is the call graph for this function:

◆ buildObjectiveProgressBar()

static ilContainerObjectiveGUI::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 1086 of file class.ilContainerObjectiveGUI.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
        elseif ($a_lo_result["status"] ?? false) {
            $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')
        );
    }

Referenced by ilTestLearningObjectivesStatusGUI\renderStatus().

Here is the caller graph for this function:

◆ getDetailsLevel()

ilContainerObjectiveGUI::getDetailsLevel ( int $a_item_id )

protected

Reimplemented from ilContainerContentGUI.

Definition at line 78 of file class.ilContainerObjectiveGUI.php.

                                                      : int
    {
        // no details anymore
        return self::DETAILS_ALL;
    }

References ilContainerContentGUI\DETAILS_ALL.

◆ getMainContent()

ilContainerObjectiveGUI::getMainContent ( )

Get content HTML for main column, this one must be overwritten in derived classes.

Reimplemented from ilContainerContentGUI.

Definition at line 84 of file class.ilContainerObjectiveGUI.php.

                                    : string
    {
        $lng = $this->lng;
        $ilAccess = $this->access;
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $has_results = false;
 
        $tpl = new ilTemplate("tpl.container_page.html", true, true, "Services/Container");
 
        if ($ilAccess->checkAccess('write', '', $this->getContainerObject()->getRefId())) {
            // check for results
            if (ilLOUserResults::hasResults($this->getContainerObject()->getId(), $ilUser->getId())) {
                $ilToolbar = new ilToolbarGUI();
                $ilToolbar->addButton(
                    $lng->txt('crs_reset_results'),
                    $ilCtrl->getLinkTargetByClass(get_class($this->getContainerGUI()), 'reset')
                );
            }
        }
 
        // Feedback
        // @todo
        //              $this->__showFeedBack();
 
        $this->items = $this->getContainerObject()->getSubItems($this->getContainerGUI()->isActiveAdministrationPanel());
 
        $is_manage = $this->getContainerGUI()->isActiveAdministrationPanel();
        $is_order = $this->getContainerGUI()->isActiveOrdering();
 
        $this->loc_settings = ilLOSettings::getInstanceByObjId($this->getContainerObject()->getId());
 
        $this->initRenderer();
 
        if (!$is_manage) {
            $this->showObjectives($is_order);
 
            // check for results
            $has_results = ilLOUserResults::hasResults($this->getContainerObject()->getId(), $ilUser->getId());
 
            $tst_obj_id = ilObject::_lookupObjId($this->loc_settings->getInitialTest());
 
            if (
                $this->loc_settings->getInitialTest() &&
                $this->loc_settings->isGeneralInitialTestVisible() &&
                !$this->loc_settings->isInitialTestStart() &&
                !ilObjTestAccess::checkCondition($tst_obj_id, ilConditionHandler::OPERATOR_FINISHED, '', $ilUser->getId())
            ) {
                $this->output_html .= $this->renderTest($this->loc_settings->getInitialTest(), 0, true);
            } elseif (
                $this->loc_settings->getQualifiedTest() &&
                $this->loc_settings->isGeneralQualifiedTestVisible()
            ) {
                $this->output_html .= $this->renderTest($this->loc_settings->getQualifiedTest(), 0, false);
            }
 
            $this->showMaterials(self::MATERIALS_OTHER, false, !$is_order);
        } else {
            $this->showMaterials(null, true);
        }
 
        // reset results by setting or for admins
        if (
            ilLOSettings::getInstanceByObjId($this->getContainerObject()->getId())->isResetResultsEnabled() ||
            $ilAccess->checkAccess('write', '', $this->getContainerObject()->getRefId())
        ) {
            if ($has_results && !$is_manage && !$is_order) {
                $this->showButton('askReset', $lng->txt('crs_reset_results'));
            }
        }
 
        $tpl->setVariable('CONTAINER_PAGE_CONTENT', $this->output_html);
 
        return $tpl->get();
    }

Here is the call graph for this function:

◆ getObjectiveResultSummary()

static ilContainerObjectiveGUI::getObjectiveResultSummary	(	bool	$a_has_initial_test,
		int	$a_objective_id,
		?array	$a_lo_result
	)

static

Get objective result summary.

Definition at line 1035 of file class.ilContainerObjectiveGUI.php.

     : string {
        global $DIC;
 
        if ($a_lo_result === null) {
            $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 =
            (($a_lo_result["status"] ?? 0) == ilLOUserResults::STATUS_COMPLETED);
 
        $next_step = '';
 
        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
        elseif ($a_lo_result["status"] ?? false) {
            $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;
    }

◆ getSettings()

ilContainerObjectiveGUI::getSettings ( )

Definition at line 73 of file class.ilContainerObjectiveGUI.php.

                                 : ilLOSettings
    {
        return $this->loc_settings;
    }

References $loc_settings.

◆ getTestAssignments()

ilContainerObjectiveGUI::getTestAssignments ( )

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

                                        : ilLOTestAssignments
    {
        return $this->test_assignments;
    }

References $test_assignments.

◆ initTestAssignments()

ilContainerObjectiveGUI::initTestAssignments ( )

protected

Definition at line 822 of file class.ilContainerObjectiveGUI.php.

                                            : void
    {
        $this->test_assignments = ilLOTestAssignments::getInstance($this->getContainerObject()->getId());
    }

References ILIAS\Survey\Mode\getId(), and ilLOTestAssignments\getInstance().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseLOUserResults()

ilContainerObjectiveGUI::parseLOUserResults ( )

protected

Definition at line 828 of file class.ilContainerObjectiveGUI.php.

                                           : array
    {
        $ilUser = $this->user;
        $initial_status = null;
 
        $res = [];
 
        $lo_ass = ilLOTestAssignments::getInstance($this->getContainerObject()->getId());
 
        $lur = new ilLOUserResults($this->getContainerObject()->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 $ilUser, $res, ILIAS\Survey\Mode\getId(), ilLOTestAssignments\getInstance(), ilLOUserResults\TYPE_INITIAL, ilLOUserResults\TYPE_QUALIFIED, ilLOSettings\TYPE_TEST_INITIAL, and ilLOSettings\TYPE_TEST_QUALIFIED.

Referenced by showObjectives().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderObjective()

ilContainerObjectiveGUI::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 639 of file class.ilContainerObjectiveGUI.php.

     : string {
        $ilUser = $this->user;
        $lng = $this->lng;
 
        $objective = new ilCourseObjective($this->getContainerObject(), $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 = [];
        foreach ($objectives_lm_obj->getMaterials() as $item) {
            $sort_map[$item["lm_ass_id"]] = $item["position"];
        }
 
        $is_manage = $this->getContainerGUI()->isActiveAdministrationPanel();
        $is_order = $this->getContainerGUI()->isActiveOrdering();
 
        $sort_content = [];
 
        foreach ($items as $item) {
            if ($this->getDetailsLevel($a_objective_id) < self::DETAILS_ALL) {
                continue;
            }
 
            $item_list_gui2 = $this->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([
                        "obj_id" => $chapter['obj_id'],
                        "focus_id" => $chapter['obj_id'],
                        "focus_return" => $this->container_obj->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(
                        $item['ref_id'],
                        $item['obj_id'],
                        $title,
                        $item['description']
                    );
 
                    // #13381 - use materials order
                    $sort_key = str_pad($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($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($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)
            );
        }
 
        $acc_content = $sort_content;
 
        $initial_shown = false;
        $initial_test_ref_id = $this->getTestAssignments()->getTestByObjective($a_objective_id, ilLOSettings::TYPE_TEST_INITIAL);
        $initial_test_obj_id = ilObject::_lookupObjId($initial_test_ref_id);
 
        if (
            $initial_test_obj_id &&
            $this->getSettings()->hasSeparateInitialTests() &&
            !ilObjTestAccess::checkCondition($initial_test_obj_id, ilConditionHandler::OPERATOR_FINISHED, '', $ilUser->getId())
        ) {
            $acc_content[] = $this->renderTest(
                $this->getTestAssignments()->getTestByObjective($a_objective_id, ilLOSettings::TYPE_TEST_INITIAL),
                $a_objective_id,
                true
            );
            $initial_shown = true;
        } elseif ($this->getSettings()->hasSeparateQualifiedTests()) {
            $acc_content[] = $this->renderTest(
                $this->getTestAssignments()->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 showObjectives().

Here is the caller graph for this function:

◆ renderProgressBar()

static ilContainerObjectiveGUI::renderProgressBar	(	int	$a_perc_result = `null`,
		int	$a_perc_limit = `null`,
		string	$a_css = `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`
	)

static

Render progress bar(s)

Parameters

int \| null	$a_perc_result
int \| null	$a_perc_limit
string \| null	$a_css
string \| null	$a_caption
string \| null	$a_url
string \| null	$a_tt_id
string \| null	$a_tt_txt
string \| null	$a_next_step
bool	$a_sub
int	$a_sub_style

Returns: string

Definition at line 879 of file class.ilContainerObjectiveGUI.php.

     : string {
        global $DIC;
 
        $tpl = new ilTemplate("tpl.objective_progressbar.html", true, true, "Services/Container");
 
        if ($a_perc_result !== null) {
            $tpl->setCurrentBlock("statusbar_bl");
            $tpl->setVariable("PERC_STATUS", $a_perc_result);
            $tpl->setVariable("PERC_WIDTH", $a_perc_result);
            $tpl->setVariable("PERC_COLOR", $a_css);
            if ($a_perc_limit) {
                // :TODO: magic?
                $limit_pos = (99 - $a_perc_limit) * -1;
                $tpl->setVariable("LIMIT_POS", $limit_pos);
            }
            if ($a_tt_txt &&
                $a_tt_id) {
                $tpl->setVariable("TT_ID", $a_tt_id);
            }
            $tpl->parseCurrentBlock();
        }
 
        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_tt_id &&
            $a_tt_txt) {
            ilTooltipGUI::addTooltip($a_tt_id, $a_tt_txt);
        }
 
        if ($a_sub) {
            $tpl->setVariable("SUB_STYLE", ' style="padding-left: ' . $a_sub_style . 'px;"');
            $tpl->setVariable("SUB_INIT", $a_sub);
        }
 
        return $tpl->get();
    }

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar().

Here is the caller graph for this function:

◆ renderProgressMeter()

static ilContainerObjectiveGUI::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 bar(s)

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
string \| null	$a_tt_txt
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 962 of file class.ilContainerObjectiveGUI.php.

     : string {
        global $DIC;
 
        $tpl = new ilTemplate("tpl.objective_progressmeter.html", true, true, "Services/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_tt_id &&
            $a_tt_txt) {
            ilTooltipGUI::addTooltip($a_tt_id, $a_tt_txt);
        }
 
        if ($a_sub) {
            $tpl->setVariable("SUB_STYLE", ' style="padding-left: ' . $a_sub_style . 'px;"');
            $tpl->setVariable("SUB_INIT", $a_sub);
        }
 
        return $tpl->get();
    }

◆ renderTest()

ilContainerObjectiveGUI::renderTest	(	int	$a_test_ref_id,
		int	$a_objective_id,
		bool	$a_is_initial = `false`
	)

protected

Definition at line 280 of file class.ilContainerObjectiveGUI.php.

     : string {
        global $DIC;
 
        $tree = $DIC->repositoryTree();
 
        $node_data = [];
        if ($a_test_ref_id) {
            $node_data = $tree->getNodeData($a_test_ref_id);
        }
        if (!($node_data['child'] ?? false)) {
            return '';
        }
 
        // update ti
        if ($a_objective_id) {
            if ($a_is_initial) {
                $title = sprintf($this->lng->txt('crs_loc_itst_for_objective'), ilCourseObjective::lookupObjectiveTitle($a_objective_id));
            } else {
                $title = sprintf($this->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
                            ? $this->lng->txt('crs_loc_itest_info')
                            : $this->lng->txt('crs_loc_qtest_info')
                    ) .
                    ')'
            );
            $node_data['objective_id'] = 0;
        }
 
        $node_data['title'] = $title;
 
        return "<div class='ilContObjectivesViewTestItem'>" . $this->renderItem($node_data) . "</div>";
    }

Referenced by getMainContent().

Here is the caller graph for this function:

◆ showButton()

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

protected

Definition at line 1338 of file class.ilContainerObjectiveGUI.php.

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

Referenced by getMainContent(), and showObjectives().

Here is the caller graph for this function:

◆ showMaterials()

ilContainerObjectiveGUI::showMaterials	(	int	$a_mode = `null`,
		bool	$a_is_manage = `false`,
		bool	$a_as_accordion = `false`
	)

protected

Definition at line 328 of file class.ilContainerObjectiveGUI.php.

     : void {
        $lng = $this->lng;
 
        $this->clearAdminCommandsDetermination();
 
        if (is_array($this->items["_all"] ?? false)) {
            $this->objective_map = $this->buildObjectiveMap();
            // all rows
            $item_r = [];
            $position = 1;
            foreach ($this->items["_all"] as $k => $item_data) {
                if ($a_mode === self::MATERIALS_TESTS && $item_data['type'] !== 'tst') {
                    continue;
                }
                if ($item_data['type'] === 'itgr') {
                    continue;
                }
                if (!$a_is_manage) {
                    // if test object is qualified or initial do not show here
                    $assignments = ilLOTestAssignments::getInstance($this->getContainerObject()->getId());
                    if ($assignments->getTypeByTest($item_data['child']) !== ilLOSettings::TYPE_TEST_UNDEFINED) {
                        continue;
                    }
                }
 
                if (($this->rendered_items[$item_data["child"]] ?? false) !== true &&
                    !$this->renderer->hasItem($item_data["child"] ?? 0)) {
                    $this->rendered_items[$item_data['child']] = true;
 
                    // TODO: Position (DONE ?)
                    $html = $this->renderItem($item_data, $position++, !($a_mode === self::MATERIALS_TESTS));
                    if ($html != "") {
                        $item_r[] = ["html" => $html, "id" => $item_data["child"], "type" => $item_data["type"]];
                    }
                }
            }
 
            // if we have at least one item, output the block
            if (count($item_r) > 0) {
                if (!$a_as_accordion) {
                    $pos = 0;
 
                    switch ($a_mode) {
                        case self::MATERIALS_TESTS:
                            $block_id = "tst";
                            $this->renderer->addTypeBlock($block_id);
                            break;
 
                        case self::MATERIALS_OTHER:
                            $block_id = "oth";
                            $this->renderer->addCustomBlock($block_id, $lng->txt('crs_other_resources'));
                            break;
 
                        // manage
                        default:
                            $block_id = "all";
                            $this->renderer->addCustomBlock($block_id, $lng->txt('content'));
                            break;
                    }
 
                    // :TODO:
                    if ($a_mode !== self::MATERIALS_TESTS) {
                        $pos = $this->getItemGroupsHTML();
                    }
 
                    foreach ($item_r as $h) {
                        if (!$this->renderer->hasItem($h["id"])) {
                            $this->renderer->addItemToBlock($block_id, $h["type"], $h["id"], $h["html"]);
                        }
                    }
 
                    $this->output_html .= $this->renderer->getHTML();
                } else {
                    $txt = "";
                    switch ($a_mode) {
                        case self::MATERIALS_TESTS:
                            $txt = $lng->txt('objs_tst');
                            break;
 
                        case self::MATERIALS_OTHER:
                            $txt = $lng->txt('crs_other_resources');
                            break;
                    }
 
                    $acc = new ilAccordionGUI();
                    $acc->setId("crsobjtvmat" . $a_mode . "_" . $this->container_obj->getId());
 
                    $acc_content = [];
                    foreach ($item_r as $h) {
                        $acc_content[] = $h["html"];
                    }
                    $acc->addItem($txt, $this->buildAccordionContent($acc_content));
 
                    $this->output_html .= $acc->getHTML();
                }
            }
        }
    }

Referenced by getMainContent().

Here is the caller graph for this function:

◆ showObjectives()

ilContainerObjectiveGUI::showObjectives ( bool $a_is_order = false )

Definition at line 178 of file class.ilContainerObjectiveGUI.php.

                                                            : void
    {
        $lng = $this->lng;
        $ilSetting = $this->settings;
        $tpl = $this->tpl;
 
        $this->clearAdminCommandsDetermination();
 
        // get embedded blocks
        $has_container_page = false;
        if (!$a_is_order) {
            $output_html = $this->getContainerGUI()->getContainerPageHTML();
            if ($output_html !== "") {
                $has_container_page = true;
                $this->output_html .= $this->insertPageEmbeddedBlocks($output_html);
            }
            unset($output_html);
        }
 
        // All objectives
        if (!count($objective_ids = ilCourseObjective::_getObjectiveIds($this->getContainerObject()->getId(), true))) {
            return;
        }
 
        $this->objective_list_gui = new ilCourseObjectiveListGUI();
        $this->objective_list_gui->setContainerObject($this->getContainerGUI());
        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_obj->getId());
        } else {
            $this->renderer->addCustomBlock('lobj', $lng->txt('crs_objectives'));
        }
 
        $lur_data = $this->parseLOUserResults();
 
        $has_initial = ilLOSettings::getInstanceByObjId($this->container_obj->getId())->worksWithInitialTest();
 
        $has_lo_page = false;
        $obj_cnt = 0;
        foreach ($objective_ids as $objective_id) {
            if (
                $has_initial &&
                (
                    !isset($lur_data[$objective_id]) ||
                    ilLOUtils::hasActiveRun(
                        $this->container_obj->getId(),
                        ilLOSettings::getInstanceByObjId($this->container_obj->getId())->getInitialTest(),
                        $objective_id
                    )
                )
            ) {
                $lur_data[$objective_id] = ["type" => ilLOSettings::TYPE_TEST_INITIAL];
            }
 
            if ($html = $this->renderObjective($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");
        }
 
        if (!$has_container_page && $has_lo_page) {
            // add core co page css
            $tpl->setVariable(
                "LOCATION_CONTENT_STYLESHEET",
                ilObjStyleSheet::getContentStylePath(0)
            );
            $tpl->setCurrentBlock("SyntaxStyle");
            $tpl->setVariable(
                "LOCATION_SYNTAX_STYLESHEET",
                ilObjStyleSheet::getSyntaxStylePath()
            );
            $tpl->parseCurrentBlock();
        }
 
        // 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>";
        }
    }

References $ilSetting, ilContainerContentGUI\$lng, $output_html, ilContainerContentGUI\$settings, ilContainerContentGUI\$tpl, ilCourseObjective\_getObjectiveIds(), ilContainerContentGUI\clearAdminCommandsDetermination(), ilAccordionGUI\FIRST_OPEN, ilContainerContentGUI\getContainerGUI(), ilContainerContentGUI\getContainerObject(), ilObjStyleSheet\getContentStylePath(), ILIAS\Survey\Mode\getId(), ilLOSettings\getInstanceByObjId(), ilObjStyleSheet\getSyntaxStylePath(), ilLOUtils\hasActiveRun(), ilContainerContentGUI\insertPageEmbeddedBlocks(), ilGlobalTemplateInterface\parseCurrentBlock(), parseLOUserResults(), renderObjective(), ilGlobalTemplateInterface\setCurrentBlock(), ilGlobalTemplateInterface\setVariable(), showButton(), ilLanguage\txt(), and ilLOSettings\TYPE_TEST_INITIAL.

Referenced by getMainContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showStatus()

ilContainerObjectiveGUI::showStatus ( )

Deprecated:: (?)

Definition at line 163 of file class.ilContainerObjectiveGUI.php.

                                : void
    {
        $ilUser = $this->user;
        $lng = $this->lng;
 
        $status = ilCourseObjectiveResultCache::getStatus($ilUser->getId(), $this->getContainerObject()->getId());
        if ($status === ilCourseObjectiveResult::IL_OBJECTIVE_STATUS_EMPTY) {
            return;
        }
        $info_tpl = new ilTemplate('tpl.crs_objectives_view_info_table.html', true, true, 'Modules/Course');
        $info_tpl->setVariable("INFO_STRING", $lng->txt('crs_objectives_info_' . $status));
 
        $this->output_html .= $info_tpl->get();
    }

References $ilUser, ilContainerContentGUI\$lng, ilContainerContentGUI\$user, ilCourseObjectiveResultCache\getStatus(), ilCourseObjectiveResult\IL_OBJECTIVE_STATUS_EMPTY, and ilLanguage\txt().

Here is the call graph for this function:

◆ updateResult()

ilContainerObjectiveGUI::updateResult	(	array	$a_res,
		int	$a_item_ref_id,
		int	$a_objective_id,
		int	$a_user_id
	)

protected

Definition at line 604 of file class.ilContainerObjectiveGUI.php.

     : array {
        if ($this->loc_settings->getQualifiedTest() === $a_item_ref_id) {
            // Check for existing test run, and decrease tries, reset final if run exists
            $active = ilObjTest::isParticipantsLastPassActive(
                $a_item_ref_id,
                $a_user_id
            );
 
            if ($active && ilLOTestRun::lookupRunExistsForObjective(
                ilObject::_lookupObjId($a_item_ref_id),
                $a_objective_id,
                $a_user_id
            )) {
                if ($a_res['tries'] > 0) {
                    --$a_res['tries'];
                }
                $a_res['is_final'] = 0;
            }
        }
        return $a_res;
    }