class.ilCourseObjectiveListGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=0);
class ilCourseObjectiveListGUI extends ilObjectListGUI
{
    public function init(): void
    {
        $this->static_link_enabled = true;
        $this->delete_enabled = false;
        $this->cut_enabled = false;
        $this->subscribe_enabled = false;
        $this->link_enabled = false;
        $this->info_screen_enabled = false;
        $this->progress_enabled = true;
        $this->type = "lobj";
        //$this->gui_class_name = "ilobjcoursegui";

        // general commands array
        $this->commands = array();
    }

    public function getObjectiveListItemHTML(
        int $a_ref_id,
        int $a_obj_id,
        string $a_title,
        string $a_description,
        bool $a_manage = false
    ): string {
        $this->tpl = new ilTemplate(
            "tpl.container_list_item.html",
            true,
            true,
            "components/ILIAS/Container"
        );

        /*
         * Previously, ilObjectListGUI::initItem was called here, but changes were made
         * to that method with the assumption that only repository objects would be referenced,
         * breaking it here for objectives.
         * Currently, we have to initialize what we need manually, and cross
         * our fingers that no changes are made to e.g. ilObjectListGUI::insertDescription
         * or ilObjectListGUI::insertIconsAndCheckboxes that break things again.
         */
        $this->ref_id = $a_ref_id;
        $this->obj_id = $a_obj_id;
        $this->setTitle($a_title);
        $this->setDescription($a_description);

        $this->insertIconsAndCheckboxes();
        $this->insertTitle();
        $this->insertDescription();

        if (!$a_manage) {
            $this->insertProgressInfo();
        }
        $this->insertPositionField();

        // subitems
        $this->insertSubItems();

        // reset properties and commands
        $this->cust_prop = array();
        $this->cust_commands = array();
        $this->sub_item_html = array();
        $this->position_enabled = false;

        return $this->tpl->get();
    }

    public function insertTitle(): void
    {
        if (
            ilCourseObjectiveResultCache::getStatus(
                $this->user->getId(),
                $this->getContainerObject()->getObject()->getId()
            ) != ilCourseObjectiveResult::IL_OBJECTIVE_STATUS_NONE && ilCourseObjectiveResultCache::isSuggested(
                $this->user->getId(),
                $this->getContainerObject()->getObject()->getId(),
                $this->obj_id
            )
        ) {
            $this->tpl->setVariable('DIV_CLASS', 'ilContainerListItemOuterHighlight');
        } else {
            $this->tpl->setVariable('DIV_CLASS', 'ilContainerListItemOuter');
        }

        if (!$this->getCommandsStatus()) {
            $this->tpl->setCurrentBlock("item_title");
            $this->tpl->setVariable("TXT_TITLE", $this->getTitle());
            $this->tpl->parseCurrentBlock();
            return;
        }
        $this->tpl->setCurrentBlock("item_title_linked");
        $this->tpl->setVariable("TXT_TITLE_LINKED", $this->getTitle());

        $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $this->getContainerObject()->getObject()->getRefId());
        $this->ctrl->setParameterByClass("ilrepositorygui", "objective_details", $this->obj_id);
        $link = $this->ctrl->getLinkTargetByClass("ilrepositorygui", "");
        $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $this->ref_id);

        $this->tpl->setVariable("HREF_TITLE_LINKED", $link);
        $this->tpl->parseCurrentBlock();
    }

    public function insertProgressInfo(): void
    {
        $this->lng->loadLanguageModule('trac');
        $this->tpl->setCurrentBlock('item_progress');

        $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);

        switch (ilCourseObjectiveResultCache::getStatus(
            $this->user->getId(),
            $this->getContainerObject()->getObject()->getId()
        )) {
            case ilCourseObjectiveResult::IL_OBJECTIVE_STATUS_NONE:
                $this->tpl->setVariable('TXT_PROGRESS_INFO', $this->lng->txt('crs_objective_status'));
                $this->tpl->setVariable(
                    'PROGRESS_ICON',
                    $icons->renderIconForStatus(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM)
                );
                break;

            case ilCourseObjectiveResult::IL_OBJECTIVE_STATUS_PRETEST_NON_SUGGEST:
            case ilCourseObjectiveResult::IL_OBJECTIVE_STATUS_PRETEST:
                $this->tpl->setVariable('TXT_PROGRESS_INFO', $this->lng->txt('crs_objective_pretest'));
                if (ilCourseObjectiveResultCache::isSuggested(
                    $this->user->getId(),
                    $this->getContainerObject()->getObject()->getId(),
                    $this->obj_id
                )) {
                    $this->tpl->setVariable(
                        'PROGRESS_ICON',
                        $icons->renderIconForStatus(ilLPStatus::LP_STATUS_FAILED_NUM)
                    );
                } else {
                    $this->tpl->setVariable(
                        'PROGRESS_ICON',
                        $icons->renderIconForStatus(ilLPStatus::LP_STATUS_COMPLETED_NUM)
                    );
                }
                break;

            case ilCourseObjectiveResult::IL_OBJECTIVE_STATUS_FINISHED:
            case ilCourseObjectiveResult::IL_OBJECTIVE_STATUS_FINAL:
                $this->tpl->setVariable('TXT_PROGRESS_INFO', $this->lng->txt('crs_objective_result'));
                if (ilCourseObjectiveResultCache::isSuggested(
                    $this->user->getId(),
                    $this->getContainerObject()->getObject()->getId(),
                    $this->obj_id
                )) {
                    $this->tpl->setVariable(
                        'PROGRESS_ICON',
                        $icons->renderIconForStatus(ilLPStatus::LP_STATUS_FAILED_NUM)
                    );
                } else {
                    $this->tpl->setVariable(
                        'PROGRESS_ICON',
                        $icons->renderIconForStatus(ilLPStatus::LP_STATUS_COMPLETED_NUM)
                    );
                }
                break;
        }
        $this->tpl->parseCurrentBlock();
    }
}