class.ilPortfolioPageGUI.php

Go to the documentation of this file.

<?php

class ilPortfolioPageGUI extends ilPageObjectGUI
{
    public const EMBEDDED_NO_OUTPUT = -99;
    protected bool $enable_comments;
    protected int $portfolio_id;
    protected \ILIAS\Portfolio\StandardGUIRequest $port_request;

    protected bool $embedded = false;
    protected ilObjectDefinition $obj_definition;
    protected ilTree $tree;
    protected array $js_onload_code = array();
    protected array $additional = array();
    protected array $export_material = array("js" => array(), "images" => array(), "files" => array());
    protected static int $initialized = 0;
    protected static bool $calender_initialized = false;
    protected int $requested_ppage;

    public function __construct(
        int $a_portfolio_id,
        int $a_id = 0,
        int $a_old_nr = 0,
        bool $a_enable_comments = true
    ) {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->obj_definition = $DIC["objDefinition"];
        $this->access = $DIC->access();
        $this->tree = $DIC->repositoryTree();
        $this->lng = $DIC->language();
        $tpl = $DIC["tpl"];
        $this->port_request = $DIC->portfolio()
            ->internal()
            ->gui()
            ->standardRequest();

        $this->portfolio_id = $a_portfolio_id;
        $this->enable_comments = $a_enable_comments;

        parent::__construct($this->getParentType(), $a_id, $a_old_nr);
        $this->getPageObject()->setPortfolioId($this->portfolio_id);

        // content style

        $tpl->setCurrentBlock("SyntaxStyle");
        $tpl->setVariable(
            "LOCATION_SYNTAX_STYLESHEET",
            ilObjStyleSheet::getSyntaxStylePath()
        );
        $tpl->parseCurrentBlock();

        $tpl->setCurrentBlock("ContentStyle");
        $tpl->setVariable(
            "LOCATION_CONTENT_STYLESHEET",
            ilObjStyleSheet::getContentStylePath(0)
        );
        $tpl->parseCurrentBlock();

        $this->requested_ppage = $this->port_request->getPortfolioPageId();
    }

    public function getParentType(): string
    {
        return "prtf";
    }

    protected function getPageContentUserId(int $a_user_id): int
    {
        // user id from content-xml
        return $a_user_id;
    }

    protected function getPortfolioPage(): ilPortfolioPage
    {
        $page = $this->getPageObject();
        return $page;
    }

    public function executeCommand(): string
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            case "ilobjbloggui":
                // #12879 - we need the wsp-id for the keywords
                $wsp_tree = new ilWorkspaceTree($ilUser->getId());
                $blog_obj_id = (int) $this->getPageObject()->getTitle();
                $blog_node_id = $wsp_tree->lookupNodeId($blog_obj_id);

                $blog_gui = new ilObjBlogGUI($blog_node_id, ilObject2GUI::WORKSPACE_NODE_ID);
                $blog_gui->disableNotes(!$this->enable_comments);
                $blog_gui->prtf_embed = true; // disables prepareOutput()/getStandardTemplate() in blog
                $ilCtrl->forwardCommand($blog_gui);
                return $blog_gui->getRenderedContent();

            case "ilcalendarmonthgui":
                $this->ctrl->saveParameter($this, "chuid");
                // booking action
                if ($cmd && $cmd !== "preview") {
                    $categories = ilCalendarCategories::_getInstance();
                    if ($categories->getMode() === 0) {
                        $chuid = $this->port_request->getConsultationHourUserId();
                        if ($chuid > 0) {
                            $categories->setCHUserId($chuid);
                        }
                        $categories->initialize(ilCalendarCategories::MODE_PORTFOLIO_CONSULTATION, 0, true);
                    }

                    $req_seed = $this->port_request->getCalendarSeed();
                    if ($req_seed !== "") {
                        $seed = new ilDate($req_seed, IL_CAL_DATE);
                    } else {
                        $seed = new ilDate(time(), IL_CAL_UNIX);
                    }

                    $month_gui = new ilCalendarMonthGUI($seed);
                    return (string) $ilCtrl->forwardCommand($month_gui);
                }

                // calendar month navigation
                //$ilCtrl->setParameter($this, "cmd", "preview");
                return (string) self::EMBEDDED_NO_OUTPUT;
            default:
                $this->setPresentationTitle($this->getPageObject()->getTitle());
                return (string) parent::executeCommand();
        }
    }

    public function showPage(): string
    {
        $ilUser = $this->user;

        if (!$this->getPageObject()) {
            return "";
        }

        if ($this->getPageObject()->getType() === ilPortfolioPage::TYPE_BLOG) {
            return $this->renderBlog($ilUser->getId(), (int) $this->getPageObject()->getTitle());
        }

        $this->setTemplateOutput(false);
        // $this->setPresentationTitle($this->getPageObject()->getTitle());
        return parent::showPage();
    }

    public function getTabs(string $a_activate = ""): void
    {
        if (!$this->embedded) {
            parent::getTabs($a_activate);
        }
    }

    public function setEmbedded(bool $a_value): void
    {
        $this->embedded = $a_value;
    }

    public function setAdditional(array $a_additional): void
    {
        $this->additional = $a_additional;
    }

    public function getAdditional(): array
    {
        return $this->additional;
    }

    public function getJsOnloadCode(): array
    {
        return $this->js_onload_code;
    }

    public function postOutputProcessing(string $a_output): string
    {
        $parts = array(
            "Profile" => array("0-9", "a-z", "0-9a-z_;\W"), // user, mode, fields
            "Verification" => array("0-9", "a-z", "0-9"), // user, type, id
            "Blog" => array("0-9", "0-9", "0-9;\W"),  // user, blog id, posting ids
            "BlogTeaser" => array("0-9", "0-9", "0-9;\W"),  // user, blog id, posting ids
            "Skills" => array("0-9", "0-9"),  // user, skill id
            "SkillsTeaser" => array("0-9", "0-9"),  // user, skill id
            "ConsultationHours" => array("0-9", "a-z", "0-9;\W"),  // user, mode, group ids
            "ConsultationHoursTeaser" => array("0-9", "a-z", "0-9;\W"),  // user, mode, group ids
            "MyCourses" => array("0-9", "a-z*"),  // user, sort
            "MyCoursesTeaser" => array("0-9", "a-z*")  // user, sort
            );

        foreach ($parts as $type => $def) {
            // #15732 - allow optional parts
            $def_parts = array();
            foreach ($def as $part) {
                $is_opt = (substr($part, -1) === "*");
                if (!$is_opt) {
                    $def_parts[] = "#";
                    $end_marker = "+";
                } else {
                    $def_parts[] = "#*";
                    $end_marker = "*";
                    $part = substr($part, 0, -1);
                }
                $def_parts[] = "([" . $part . "]" . $end_marker . ")";
            }
            $def = implode("", $def_parts);

            if (preg_match_all(
                "/" . $this->pl_start . $type . $def . $this->pl_end . "/",
                $a_output,
                $blocks
            )) {
                foreach ($blocks[0] as $idx => $block) {
                    switch ($type) {
                        case "Profile":
                        case "Blog":
                        case "BlogTeaser":
                        case "Skills":
                        case "SkillsTeaser":
                        case "ConsultationHours":
                        case "ConsultationHoursTeaser":
                        case "MyCourses":
                        case "MyCoursesTeaser":
                            $subs = null;
                            if (trim(($blocks[3][$idx] ?? ""))) {
                                foreach (explode(";", $blocks[3][$idx]) as $sub) {
                                    if (trim($sub)) {
                                        $subs[] = trim($sub);
                                    }
                                }
                            }
                            $snippet = $this->{"render" . $type}(
                                $blocks[1][$idx],
                                $blocks[2][$idx],
                                $subs
                            );
                            break;

                        default:
                            $snippet = $this->{"render" . $type}(
                                $blocks[1][$idx],
                                $blocks[2][$idx],
                                $blocks[3][$idx]
                            );
                            break;
                    }

                    $snippet = $this->renderPageElement($type, $snippet);
                    $a_output = str_replace($block, $snippet, $a_output);
                }
            }
        }

        $a_output = $this->makePlaceHoldersClickable($a_output);

        return $a_output;
    }

    protected function renderPageElement(
        string $a_type,
        string $a_html
    ): string {
        return trim($a_html);
    }

    protected function renderTeaser(
        string $a_type,
        string $a_title,
        string $a_options = ""
    ): string {
        $options = "";
        if ($a_options) {
            $options = '<div class="il_Footer">' . $this->lng->txt("prtf_page_element_teaser_settings") .
                ": " . $a_options . '</div>';
        }

        return '<div style="margin:5px" class="ilBox"><h3>' . $a_title . '</h3>' .
            '<div class="il_Description_no_margin">' . $this->lng->txt("prtf_page_element_teaser_" . $a_type) . '</div>' .
            $options . '</div>';
    }

    protected function renderProfile(
        int $a_user_id,
        string $a_type,
        array $a_fields = null
    ): string {
        $ilCtrl = $this->ctrl;

        $user_id = $this->getPageContentUserId($a_user_id);

        $pub_profile = new ilPublicUserProfileGUI($user_id);
        $pub_profile->setEmbedded(true, ($this->getOutputMode() === "offline"));

        // full circle: additional was set in the original public user profile call
        $pub_profile->setAdditional($this->getAdditional());

        if ($a_type === "manual" && is_array($a_fields) && count($a_fields) > 0) {
            $prefs = array();
            foreach ($a_fields as $field) {
                $field = trim($field);
                if ($field) {
                    $prefs["public_" . $field] = "y";
                }
            }

            $pub_profile->setCustomPrefs($prefs);
        }

        if ($this->getOutputMode() !== "offline") {
            return $ilCtrl->getHTML($pub_profile);
        }

        return $pub_profile->getEmbeddable();
    }

    protected function renderVerification(
        int $a_user_id,
        string $a_type,
        int $a_id
    ): string {
        $objDefinition = $this->obj_definition;

        $outputMode = $this->getOutputMode();

        // not used
        // $user_id = $this->getPageContentUserId($a_user_id);
        if ($a_type === 'crta' && $outputMode === 'offline') {
            $fileService = new ilPortfolioCertificateFileService();

            $certificatePdfFile = $fileService->createCertificateFilePath($a_user_id, $a_id);
            $this->export_material["files"][] = $certificatePdfFile;

            $url = 'files/' . basename($certificatePdfFile);

            $userCertificateRepository = new ilUserCertificateRepository();

            return $this->createPersistentCertificateUrl($a_id, $userCertificateRepository, $url);
        }

        if ($a_type === 'crta' && $outputMode === 'print') {
            $userCertificateRepository = new ilUserCertificateRepository();
            $url = $this->getPagePermaLink();

            return $this->createPersistentCertificateUrl($a_id, $userCertificateRepository, $url);
        }

        if ($a_type === 'crta') {
            $this->ctrl->setParameter($this, "dlid", $a_id);
            $url = $this->ctrl->getLinkTarget($this, "dl" . $a_type);
            $this->ctrl->setParameter($this, "dlid", "");

            $userCertificateRepository = new ilUserCertificateRepository();

            return $this->createPersistentCertificateUrl($a_id, $userCertificateRepository, $url);
        }

        if (!ilObject::_exists($a_id)) {
            return $this->lng->txt('deleted');
        }

        $class = "ilObj" . $objDefinition->getClassName($a_type) . "GUI";
        $verification = new $class($a_id, ilObject2GUI::WORKSPACE_OBJECT_ID);

        if ($outputMode === "print") {
            $url = $this->getPagePermaLink();
        } elseif ($outputMode !== "offline") {
            // direct download link
            $this->ctrl->setParameter($this, "dlid", $a_id);
            $url = $this->ctrl->getLinkTarget($this, "dl" . $a_type);
            $this->ctrl->setParameter($this, "dlid", "");
        } else {
            $file = $verification->getObject()->getFilePath();
            $url = "files/" . basename($file);

            $this->export_material["files"][] = $file;
        }

        return $verification->render(true, $url);
    }

    protected function dltstv(): void
    {
        $id = $this->port_request->getVerificationId();
        if ($id) {
            $verification = new ilObjTestVerificationGUI($id, ilObject2GUI::WORKSPACE_OBJECT_ID);
            $verification->downloadFromPortfolioPage($this->getPortfolioPage());
        }
    }

    protected function dlexcv(): void
    {
        $id = $this->port_request->getVerificationId();
        if ($id) {
            $verification = new ilObjExerciseVerificationGUI($id, ilObject2GUI::WORKSPACE_OBJECT_ID);
            $verification->downloadFromPortfolioPage($this->getPortfolioPage());
        }
    }

    protected function dlcrsv(): void
    {
        $id = $this->port_request->getVerificationId();
        if ($id) {
            $verification = new ilObjCourseVerificationGUI($id, ilObject2GUI::WORKSPACE_OBJECT_ID);
            $verification->downloadFromPortfolioPage($this->getPortfolioPage());
        }
    }

    protected function dlcmxv(): void
    {
        $id = $this->port_request->getVerificationId();
        if ($id) {
            $verification = new ilObjCmiXapiVerificationGUI($id, ilObject2GUI::WORKSPACE_OBJECT_ID);
            $verification->downloadFromPortfolioPage($this->getPortfolioPage());
        }
    }

    protected function dlltiv(): void
    {
        $id = $this->port_request->getVerificationId();
        if ($id) {
            $verification = new ilObjLTIConsumerVerificationGUI($id, ilObject2GUI::WORKSPACE_OBJECT_ID);
            $verification->downloadFromPortfolioPage($this->getPortfolioPage());
        }
    }

    protected function dlscov(): void
    {
        $id = $this->port_request->getVerificationId();
        if ($id) {
            $verification = new ilObjSCORMVerificationGUI($id, ilObject2GUI::WORKSPACE_OBJECT_ID);
            $verification->downloadFromPortfolioPage($this->getPortfolioPage());
        }
    }

    protected function dlcrta(): void
    {
        $objectId = $this->port_request->getVerificationId();
        if ($objectId) {
            $object = new ilObjPersistentCertificateVerificationGUI();
            $object->downloadFromPortfolioPage($this->getPortfolioPage(), $objectId, $this->user->getId());
        }
    }

    protected function renderBlog(
        int $a_user_id,
        int $a_blog_id,
        array $a_posting_ids = null
    ): string {
        $ilCtrl = $this->ctrl;

        // not used
        // $user_id = $this->getPageContentUserId($a_user_id);

        // full blog (separate tab/page)
        if (!$a_posting_ids) {
            if (ilObject::_lookupType($a_blog_id) !== "blog") {
                return "";
            }
            $blog = new ilObjBlogGUI($a_blog_id, ilObject2GUI::WORKSPACE_OBJECT_ID);
            $blog->disableNotes(!$this->enable_comments);
            $blog->setContentStyleSheet();

            if ($this->getOutputMode() !== "offline") {
                return $ilCtrl->getHTML($blog);
            }
        }
        // embedded postings
        else {
            $html = array();

            $html[] = ilObjBlog::_lookupTitle($a_blog_id);

            foreach ($a_posting_ids as $post) {
                $page = new ilBlogPostingGUI(0, null, $post);
                if ($this->getOutputMode() !== "offline") {
                    $page->setOutputMode(ilPageObjectGUI::PREVIEW);
                } else {
                    $page->setOutputMode("offline");
                }
                $html[] = $page->showPage();
            }

            return implode("\n", $html);
        }
        return "";
    }

    protected function renderBlogTeaser(
        int $a_user_id,
        int $a_blog_id,
        array $a_posting_ids = null
    ): string {
        // not used
        // $user_id = $this->getPageContentUserId($a_user_id);

        $postings = "";
        if ($a_posting_ids) {
            $postings = array("<ul>");
            foreach ($a_posting_ids as $post) {
                $post = new ilBlogPosting($post);
                $postings[] = "<li>" . $post->getTitle() . " - " .
                    ilDatePresentation::formatDate($post->getCreated()) . "</li>";
            }
            $postings[] = "</ul>";
            $postings = implode("\n", $postings);
        }

        return $this->renderTeaser("blog", $this->lng->txt("obj_blog") . ' "' .
            ilObject::_lookupTitle($a_blog_id) . '"', $postings);
    }

    protected function renderSkills(
        int $a_user_id,
        int $a_skills_id
    ): string {
        if ($this->getOutputMode() === "preview") {
            return $this->renderSkillsTeaser($a_user_id, $a_skills_id);
        }

        $user_id = $this->getPageContentUserId($a_user_id);

        $gui = new ilPersonalSkillsGUI();
        if ($this->getOutputMode() === "offline") {
            $gui->setOfflineMode("./files/");
        }
        return $gui->getSkillHTML($a_skills_id, $user_id);
    }

    protected function renderSkillsTeaser(
        int $a_user_id,
        int $a_skills_id
    ): string {
        // not used
        // $user_id = $this->getPageContentUserId($a_user_id);

        return $this->renderTeaser("skills", $this->lng->txt("skills") . ' "' .
            ilSkillTreeNode::_lookupTitle($a_skills_id) . '"');
    }

    protected function renderConsultationHoursTeaser(
        int $a_user_id,
        string $a_mode,
        ?array $a_group_ids = null
    ): string {
        // not used
        // $user_id = $this->getPageContentUserId($a_user_id);
        if ($a_mode === "auto") {
            $mode = $this->lng->txt("cont_cach_mode_automatic");
            $groups = null;
        } else {
            $mode = $this->lng->txt("cont_cach_mode_manual");

            $groups = array();
            foreach ($a_group_ids as $grp_id) {
                $groups[] = ilConsultationHourGroups::lookupTitle($grp_id);
            }
            $groups = " (" . implode(", ", $groups) . ")";
        }

        $this->lng->loadLanguageModule("dateplaner");
        return $this->renderTeaser(
            "consultation_hours",
            $this->lng->txt("app_consultation_hours"),
            $mode . $groups
        );
    }

    protected function renderConsultationHours(
        int $a_user_id,
        string $a_mode,
        ?array $a_group_ids = null
    ): string {
        $ilUser = $this->user;
        if ($this->getOutputMode() === "preview") {
            return $this->renderConsultationHoursTeaser($a_user_id, $a_mode, $a_group_ids);
        }

        if ($this->getOutputMode() === "offline") {
            return "";
        }

        if ($this->getOutputMode() === "print") {
            return "";
        }

        $user_id = $this->getPageContentUserId($a_user_id);

        // only if not owner
        $bkid = 0;
        if ($ilUser->getId() !== $user_id) {
            $bkid = $user_id;
        }
        $this->ctrl->setParameter($this, "chuid", $user_id);

        if ($a_mode !== "manual") {
            $a_group_ids = null;
        }
        ilCalendarCategories::_getInstance()->setCHUserId($user_id);
        if (!self::$calender_initialized) {
            ilCalendarCategories::_getInstance()->initialize(
                ilCalendarCategories::MODE_PORTFOLIO_CONSULTATION,
                0,
                true
            );
            self::$calender_initialized = true;
        }

        $seed = $this->port_request->getCalendarSeed();
        if ($seed === "") {
            $seed = new ilDate(time(), IL_CAL_UNIX);
        } else {
            $seed = new ilDate($seed, IL_CAL_DATE);
        }

        $month_gui = new ilCalendarMonthGUI($seed);
        if ($bkid > 0) {
            $month_gui->setBkId($bkid);
        }
        $month_gui->setConsulationHoursUserId($user_id);

        // custom schedule filter: handle booking group ids
        $filter = new ilCalendarScheduleFilterBookings($user_id, $a_group_ids);
        $month_gui->addScheduleFilter($filter);

        $this->tpl->addCss(ilUtil::getStyleSheetLocation('filesystem', 'delos.css', 'Services/Calendar'));

        $this->lng->loadLanguageModule("dateplaner");
        return '<h3>' . $this->lng->txt("app_consultation_hours") . '</h3>' .
            $this->ctrl->getHTML($month_gui);
    }

    protected function isMyCoursesActive(): bool
    {
        $prfa_set = new ilSetting("prfa");
        return (bool) $prfa_set->get("mycrs", true);
    }

    protected function renderMyCoursesTeaser(
        int $a_user_id,
        $a_default_sorting
    ): string {
        // not used
        // $user_id = $this->getPageContentUserId($a_user_id);

        $title = $this->isMyCoursesActive()
            ? "my_courses"
            : "my_courses_inactive";

        return $this->renderTeaser(
            $title,
            $this->lng->txt("prtf_page_element_my_courses_title")
        );
    }

    protected function renderMyCourses(
        int $a_user_id,
        string $a_default_sorting
    ): string {
        $ilAccess = $this->access;
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;

        if ($this->getOutputMode() === "preview") {
            return $this->renderMyCoursesTeaser($a_user_id, $a_default_sorting);
        }

        if (!$this->isMyCoursesActive()) {
            return "";
        }

        $img_path = null;
        $lp_icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);

        $user_id = $this->getPageContentUserId($a_user_id);

        // sorting pref
        $req_sorting = $this->port_request->getCourseSorting();
        if (in_array($req_sorting, array("alpha", "loc"))) {
            $ilUser->writePref("prtf_mcrs_sort", $req_sorting);
        }
        $sorting = $ilUser->getPref("prtf_mcrs_sort");
        if (!$sorting) {
            $sorting = $a_default_sorting;
        }

        $data = $this->getCoursesOfUser($user_id, ($sorting === "loc"));
        if (count($data)) {
            if ($sorting !== "loc") {
                $data = ilArrayUtil::sortArray($data, "title", "ASC");
            } else {
                $data = ilArrayUtil::sortArray($data, "path_sort", "ASC");
            }

            $tpl = new ilTemplate("tpl.pc_my_courses.html", true, true, "Modules/Portfolio");
            $tpl->setVariable("TITLE", $this->lng->txt("prtf_page_element_my_courses_title"));
            $tpl->setVariable("INFO", $this->lng->txt("prtf_page_element_my_courses_info")); // #14464

            $this->lng->loadLanguageModule("trac");
            $this->lng->loadLanguageModule("crs");

            // sorting
            if ($this->getOutputMode() !== "print") {
                $options = array(
                    "alpha" => $this->lng->txt("cont_mycourses_sortorder_alphabetical"),
                    "loc" => $this->lng->txt("cont_mycourses_sortorder_location")
                );
                $tpl->setVariable(
                    "SORT_SELECT",
                    ilLegacyFormElementsUtil::formSelect(
                        $sorting,
                        "srt",
                        $options,
                        false,
                        true,
                        0,
                        "",
                        ["onchange" => "form.submit()"]
                    )
                );
                $tpl->setVariable("SORT_FORM", $this->getCourseSortAction($ilCtrl));
            }

            $old_path = null;

            foreach ($data as $course) {
                if (($sorting === "loc") && $course["path"] != $old_path) {
                    $tpl->setCurrentBlock("path_bl");
                    $tpl->setVariable("PATH", $course["path"]);
                    $tpl->parseCurrentBlock();

                    $old_path = $course["path"];
                }

                if (isset($course["lp_status"])) {
                    $lp_icon_rendered = $lp_icons->renderIconForStatus($course["lp_status"]);

                    $tpl->setCurrentBlock("lp_bl");
                    $tpl->setVariable("LP_ICON", $lp_icon_rendered);
                    $tpl->parseCurrentBlock();
                }

                $do_links = false;
                if ($ilUser->getId() !== ANONYMOUS_USER_ID) {
                    $do_links = $ilAccess->checkAccessOfUser($ilUser->getId(), "read", "", $course["ref_id"], "crs") ||
                        ($ilAccess->checkAccessOfUser($ilUser->getId(), "visible", "", $course["ref_id"], "crs") &&
                        $ilAccess->checkAccessOfUser($ilUser->getId(), "join", "", $course["ref_id"], "crs"));
                }

                if (isset($course["objectives"])) {
                    $loc_settings = ilLOSettings::getInstanceByObjId($course["obj_id"]);
                    $has_initial_test = (bool) $loc_settings->getInitialTest();

                    foreach ($course["objectives"] as $objtv) {
                        if ($do_links) {
                            $params = array("oobj" => $objtv["id"]);
                            $url = ilLink::_getLink($course["ref_id"], "crs", $params);

                            // #15510
                            $url .= "#objtv_acc_" . $objtv["id"];

                            if ($this->getOutputMode() !== "print") {
                                $tpl->touchBlock("objective_dnone");
                            }

                            $tpl->setCurrentBlock("objective_link_bl");

                            if (trim($objtv["desc"] ?? "") !== "") {
                                $desc = nl2br($objtv["desc"]);
                                $tt_id = "objtvtt_" . $objtv["id"] . "_" . (self::$initialized);

                                ilTooltipGUI::addTooltip($tt_id, $desc, "", "bottom center", "top center", false);

                                $tpl->setVariable("OBJECTIVE_LINK_ID", $tt_id);
                            }

                            $tpl->setVariable("OBJECTIVE_LINK_URL", $url);
                            $tpl->setVariable("OBJECTIVE_LINK_TITLE", $objtv["title"]);
                        } else {
                            $tpl->setCurrentBlock("objective_nolink_bl");
                            $tpl->setVariable("OBJECTIVE_NOLINK_TITLE", $objtv["title"]);
                        }
                        $tpl->parseCurrentBlock();

                        $objtv_icon = ilObject::_getIcon($objtv["id"], 'big', "lobj");
                        if ($img_path) {
                            $objtv_icon = $img_path . basename($objtv_icon);
                        }

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

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

                        $tpl->parseCurrentBlock();
                    }

                    $tpl->setCurrentBlock("objectives_bl");
                    $tpl->setVariable("OBJTV_LIST_CRS_ID", $course["obj_id"]);
                    $tpl->parseCurrentBlock();
                }

                // always check against current user
                if ($do_links) {
                    $tpl->setCurrentBlock("course_link_bl");
                    $tpl->setVariable("COURSE_LINK_TITLE", $course["title"]);
                    $tpl->setVariable("COURSE_LINK_URL", ilLink::_getLink($course["ref_id"]));
                } else {
                    $tpl->setCurrentBlock("course_nolink_bl");
                    $tpl->setVariable("COURSE_NOLINK_TITLE", $course["title"]);
                }
                $tpl->parseCurrentBlock();

                $crs_icon = ilObject::_getIcon($course["obj_id"], 'small', 'crs');
                if ($img_path) {
                    $crs_icon = $img_path . basename($crs_icon);
                }

                $tpl->setCurrentBlock("course_bl");

                if (isset($course["objectives"])) {
                    $tpl->setVariable("TOGGLE_CLASS", "ilPCMyCoursesToggle");
                } else {
                    $tpl->setVariable("NO_TOGGLE", ' style="visibility:hidden;"');
                }

                $tpl->setVariable("CRS_ICON_URL", $crs_icon);
                $tpl->setVariable("CRS_ICON_ALT", $this->lng->txt("obj_crs"));
                $tpl->parseCurrentBlock();
            }

            // #15508
            if (!self::$initialized) {
                $GLOBALS["tpl"]->addJavaScript("Modules/Portfolio/js/ilPortfolio.js");
                $GLOBALS["tpl"]->addOnLoadCode("ilPortfolio.init()");
            }
            self::$initialized++;

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

    protected function getCourseSortAction(ilCtrl $ctrl): string
    {
        return $ctrl->getFormActionByClass("ilobjportfoliogui", "preview");
    }

    protected function getCoursesOfUser(
        int $a_user_id,
        bool $a_add_path = false
    ): array {
        $tree = $this->tree;

        // see ilPDSelectedItemsBlockGUI

        $items = ilParticipants::_getMembershipByType($a_user_id, ['crs']);

        $repo_title = $tree->getNodeData(ROOT_FOLDER_ID);
        $repo_title = $repo_title["title"];
        if ($repo_title == "ILIAS") {
            $repo_title = $this->lng->txt("repository");
        }

        $references = $lp_obj_refs = array();
        foreach ($items as $obj_id) {
            $ref_id = ilObject::_getAllReferences($obj_id);
            if (is_array($ref_id) && count($ref_id)) {
                $ref_id = array_pop($ref_id);
                if (!$tree->isDeleted($ref_id)) {
                    $visible = false;
                    $active = ilObjCourseAccess::_isActivated($obj_id, $visible, false);
                    if ($active && $visible) {
                        $references[$ref_id] = array(
                            'ref_id' => $ref_id,
                            'obj_id' => $obj_id,
                            'title' => ilObject::_lookupTitle($obj_id)
                        );

                        if ($a_add_path) {
                            $path = array();
                            foreach ($tree->getPathFull($ref_id) as $item) {
                                $path[] = $item["title"];
                            }
                            // top level comes first
                            if (count($path) === 2) {
                                $path[0] = 0;
                            } else {
                                $path[0] = 1;
                            }
                            $references[$ref_id]["path_sort"] = implode("__", $path);
                            array_shift($path);
                            array_pop($path);
                            if (!count($path)) {
                                array_unshift($path, $repo_title);
                            }
                            $references[$ref_id]["path"] = implode(" &rsaquo; ", $path);
                        }

                        $lp_obj_refs[$obj_id] = $ref_id;
                    }
                }
            }
        }

        // get lp data for valid courses

        if (count($lp_obj_refs)) {
            // listing the objectives should NOT depend on any LP status / setting
            foreach ($lp_obj_refs as $obj_id => $ref_id) {
                // only if set in DB (default mode is not relevant
                if (ilObjCourse::_lookupViewMode($obj_id) === ilCourseConstants::IL_CRS_VIEW_OBJECTIVE) {
                    $references[$ref_id]["objectives"] = $this->parseObjectives($obj_id, $a_user_id);
                }
            }

            // LP must be active, personal and not anonymized
            if (ilObjUserTracking::_enabledLearningProgress() &&
                ilObjUserTracking::_enabledUserRelatedData() &&
                ilObjUserTracking::_hasLearningProgressLearner()) {
                // see ilLPProgressTableGUI
                $lp_data = ilTrQuery::getObjectsStatusForUser($a_user_id, $lp_obj_refs);
                foreach ($lp_data as $item) {
                    $ref_id = $item["ref_ids"];
                    $references[$ref_id]["lp_status"] = $item["status"];
                }
            }
        }

        return $references;
    }

    protected function parseObjectives(
        int $a_obj_id,
        int $a_user_id
    ): array {
        $res = array();

        // we need the collection for the correct order
        $coll_objtv = new ilLPCollectionOfObjectives($a_obj_id, ilLPObjSettings::LP_MODE_OBJECTIVES);
        $coll_objtv = $coll_objtv->getItems();
        if ($coll_objtv) {
            // #13373
            $lo_results = $this->parseLOUserResults($a_obj_id, $a_user_id);

            $lo_ass = ilLOTestAssignments::getInstance($a_obj_id);

            $tmp = array();

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

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

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

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

        return $res;
    }

    // see ilContainerObjectiveGUI::parseLOUserResults()
    protected function parseLOUserResults(
        int $a_course_obj_id,
        int $a_user_id
    ): array {
        $res = array();
        $initial_status = "";

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

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

            $result["initial_status"] = $initial_status;

            $res[$objective_id] = $result;
        }

        return $res;
    }

    public function getExportMaterial(): array
    {
        return $this->export_material;
    }

    public function makePlaceHoldersClickable(string $a_html): string
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;

        $end = 0;
        $start = strpos($a_html, "{{{{{PlaceHolder#");
        if (is_int($start)) {
            $end = strpos($a_html, "}}}}}", $start);
        }
        while ($end > 0) {
            $param = substr($a_html, $start + 17, $end - $start - 17);
            $param = explode("#", $param);

            $html = $param[2];
            switch ($param[2]) {
                case "Text":
                    $html = $lng->txt("cont_text_placeh");
                    break;

                case "Media":
                    $html = $lng->txt("cont_media_placeh");
                    break;

                case "Question":
                    $html = $lng->txt("cont_question_placeh");
                    break;

                case "Verification":
                    $html = $lng->txt("cont_verification_placeh");
                    break;
            }

            // only if not owner
            if ($ilUser->getId() === ilObjPortfolio::_lookupOwner($this->portfolio_id)
                && $this->getOutputMode() === "presentation") {
                switch ($param[2]) {
                    case "Text":
                        $ilCtrl->setParameterByClass("ilportfoliopagegui", "prt_id", $this->port_request->getPortfolioId());
                        $ilCtrl->setParameterByClass("ilportfoliopagegui", "ppage", $this->getId());
                        $ilCtrl->setParameterByClass("ilportfoliopagegui", "pl_pc_id", $param[0]);
                        $ilCtrl->setParameterByClass("ilportfoliopagegui", "pl_hier_id", $param[1]);
                        $href = $ilCtrl->getLinkTargetByClass("ilportfoliopagegui", "insertJSAtPlaceholder");
                        $html = "<a href='" . $href . "'>" . $html . "</a>";
                        break;

                    case "Media":
                        $ilCtrl->setParameterByClass("ilpcmediaobjectgui", "prt_id", $this->port_request->getPortfolioId());
                        $ilCtrl->setParameterByClass("ilpcmediaobjectgui", "ppage", $this->getId());
                        $ilCtrl->setParameterByClass("ilpcmediaobjectgui", "pl_pc_id", $param[0]);
                        $ilCtrl->setParameterByClass("ilpcmediaobjectgui", "pl_hier_id", $param[1]);
                        $ilCtrl->setParameterByClass("ilpcmediaobjectgui", "subCmd", "insertNew");
                        $href = $ilCtrl->getLinkTargetByClass(array("ilPortfolioPageGUI", "ilPageEditorGUI", "ilPCPlaceHolderGUI", "ilpcmediaobjectgui"), "insert");
                        $html = "<a href='" . $href . "'>" . $html . "</a>";
                        break;

                        /* see #34170, may need a different change, keep code to monitor
                    case "Verification":
                        $ilCtrl->setParameterByClass("ilPCVerificationGUI", "prt_id", $this->port_request->getPortfolioId());
                        $ilCtrl->setParameterByClass("ilPCVerificationGUI", "ppage", $this->getId());
                        $ilCtrl->setParameterByClass("ilPCVerificationGUI", "pl_pc_id", $param[0]);
                        $ilCtrl->setParameterByClass("ilPCVerificationGUI", "pl_hier_id", $param[1]);
                        $ilCtrl->setParameterByClass("ilPCVerificationGUI", "subCmd", "insertNew");
                        $href = $ilCtrl->getLinkTargetByClass(array("ilPortfolioPageGUI", "ilPageEditorGUI", "ilPCPlaceHolderGUI", "ilPCVerificationGUI"), "insert");
                        $html = "<a href='" . $href . "'>" . $html . "</a>";
                        break;
                        */
                }
            }

            $h2 = substr($a_html, 0, $start) .
                $html .
                substr($a_html, $end + 5);
            $a_html = $h2;

            $start = strpos($a_html, "{{{{{PlaceHolder#", $start + 5);
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_html, "}}}}}", $start);
            }
        }
        return $a_html;
    }

    public function getViewPageLink(): string
    {
        global $DIC;

        $ctrl = $DIC->ctrl();

        $ctrl->setParameterByClass("ilobjportfoliogui", "user_page", $this->requested_ppage);
        return $ctrl->getLinkTargetByClass("ilobjportfoliogui", "preview");
    }

    public function getViewPageText(): string
    {
        return $this->lng->txt("preview");
    }

    public function getPagePermaLink(): string
    {
        $pid = ilPortfolioPage::findPortfolioForPage($this->getId());
        return ilLink::_getStaticLink($pid, "prtf", true, "_" . $this->getId());
    }

    private function createPersistentCertificateUrl(
        int $a_id,
        ilUserCertificateRepository $userCertificateRepository,
        string $url
    ): string {
        try {
            $presentation = $userCertificateRepository->fetchActiveCertificateForPresentation($this->user->getId(), $a_id);
        } catch (Exception $e) {
            return "";
        }
        $caption = $this->lng->txt('certificate') . ': ';
        $caption .= $this->lng->txt($presentation->getUserCertificate()->getObjType()) . ' ';
        $caption .= '"' . $presentation->getObjectTitle() . '"';

        return '<div><a href="' . $url . '">' . $caption . '</a></div>';
    }

    public function getCommentsHTMLExport(): string
    {
        $notes_gui = new ilCommentGUI(
            $this->portfolio_id,
            $this->getPageObject()->getId(),
            "pfpg"
        );
        $notes_gui->enablePublicNotes(true);
        $notes_gui->setRepositoryMode(false);
        $notes_gui->setExportMode();
        return  $notes_gui->getListHTML();
    }

    public function finishEditing(): void
    {
        $this->ctrl->redirectByClass("ilObjPortfolioGUI", "view");
    }
}