class.ilObjPortfolioBaseGUI.php

Go to the documentation of this file.

<?php

use ILIAS\Portfolio\StandardGUIRequest;
use ILIAS\Portfolio\PortfolioPrintViewProviderGUI;

abstract class ilObjPortfolioBaseGUI extends ilObject2GUI
{
    protected \ILIAS\Notes\Service $notes;
    protected \ILIAS\Portfolio\InternalGUIService $gui;
    protected StandardGUIRequest $port_request;
    protected ilHelpGUI $help;
    protected int $user_id = 0;
    protected array $additional = array();
    protected array $perma_link = [];
    protected int $page_id = 0;
    protected string $page_mode; // preview|edit
    protected int $requested_ppage;
    protected int $requested_user_page;
    protected string $requested_back_url = "";
    protected \ILIAS\DI\UIServices $ui;
    protected \ILIAS\Style\Content\GUIService $content_style_gui;
    protected \ILIAS\Style\Content\Object\ObjectFacade $content_style_domain;

    public function __construct(
        int $a_id = 0,
        int $a_id_type = self::REPOSITORY_NODE_ID,
        int $a_parent_node_id = 0
    ) {
        global $DIC;

        $this->user = $DIC->user();
        $this->locator = $DIC["ilLocator"];
        $this->toolbar = $DIC->toolbar();
        $this->settings = $DIC->settings();
        $this->tree = $DIC->repositoryTree();
        $this->help = $DIC["ilHelp"];
        $this->tpl = $DIC["tpl"];
        $ilUser = $DIC->user();
        $this->ui = $DIC->ui();

        $this->port_request = $DIC->portfolio()
            ->internal()
            ->gui()
            ->standardRequest();

        parent::__construct($a_id, $a_id_type, $a_parent_node_id);

        $this->user_id = $ilUser->getId();

        $this->lng->loadLanguageModule("prtf");
        $this->lng->loadLanguageModule("user");
        $this->lng->loadLanguageModule("obj");

        $this->requested_ppage = $this->port_request->getPortfolioPageId();
        $this->requested_user_page = $this->port_request->getUserPage();

        // temp sanitization, should be done smarter in the future
        $back = str_replace("&amp;", ":::", $this->port_request->getBackUrl());
        $back = preg_replace(
            "/[^a-zA-Z0-9_\.\?=:\s]/",
            "",
            $back
        );
        $this->requested_back_url = str_replace(":::", "&amp;", $back);

        $this->ctrl->setParameterByClass("ilobjportfoliogui", "back_url", rawurlencode($this->requested_back_url));
        $cs = $DIC->contentStyle();
        $this->content_style_gui = $cs->gui();
        if ($this->object) {
            $this->content_style_domain = $cs->domain()->styleForObjId($this->object->getId());
        }
        $this->gui = $DIC->portfolio()->internal()->gui();
        $this->notes = $DIC->notes();
    }

    protected function addLocatorItems(): void
    {
        $ilLocator = $this->locator;

        if ($this->object) {
            $ilLocator->addItem(
                strip_tags($this->object->getTitle()),
                $this->ctrl->getLinkTarget($this, "view")
            );
        }

        if ($this->page_id > 0) {
            $page = $this->getPageInstance($this->page_id);
            $title = $page->getTitle();
            $this->ctrl->setParameterByClass($this->getPageGUIClassName(), "ppage", $this->page_id);
            $ilLocator->addItem(
                $title,
                $this->ctrl->getLinkTargetByClass($this->getPageGUIClassName(), "edit")
            );
        }
    }

    protected function determinePageCall(): bool
    {
        // edit
        if ($this->requested_ppage > 0) {
            if (!$this->checkPermissionBool("write")) {
                $this->ctrl->redirect($this, "view");
            }

            $this->page_id = $this->requested_ppage;
            $this->page_mode = "edit";
            $this->ctrl->setParameter($this, "ppage", $this->page_id);
            return true;
        }

        // preview
        $this->page_id = $this->requested_user_page;
        $this->page_mode = "preview";
        $this->ctrl->setParameter($this, "user_page", $this->page_id);
        return false;
    }

    protected function handlePageCall(string $a_cmd): void
    {
        if (!$this->page_id) {
            $this->ctrl->redirect($this, "view");
        }

        $page_gui = $this->getPageGUIInstance($this->page_id);

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "view")
        );

        // needed for editor
        $page_gui->setStyleId($this->content_style_domain->getEffectiveStyleId());

        $ret = $this->ctrl->forwardCommand($page_gui);
        if ($ret != "" && $ret !== true) {
            // preview (fullscreen)
            if ($this->page_mode === "preview") {
                // embedded call which did not generate any output (e.g. calendar month navigation)
                if ($ret != ilPortfolioPageGUI::EMBEDDED_NO_OUTPUT) {
                    // suppress (portfolio) notes for blog postings
                    $this->preview(false, $ret, ($a_cmd !== "previewEmbedded"));
                } else {
                    $this->preview(false);
                }
            }
            // edit
            else {
                $this->setContentStyleSheet();
                if (is_string($ret)) {
                    $this->tpl->setContent($ret);
                }
            }
        }
    }

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

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

    public function setPermaLink(
        int $a_obj_id,
        string $a_type
    ): void {
        $this->perma_link = array("obj_id" => $a_obj_id, "type" => $a_type);
    }


    //
    // CREATE/EDIT
    //

    protected function setSettingsSubTabs(string $a_active): void
    {
        // #17455
        $this->lng->loadLanguageModule($this->getType());

        // general properties
        $this->tabs_gui->addSubTab(
            "properties",
            $this->lng->txt($this->getType() . "_properties"),
            $this->ctrl->getLinkTarget($this, 'edit')
        );

        $this->tabs_gui->addSubTab(
            "style",
            $this->lng->txt("obj_sty"),
            $this->ctrl->getLinkTargetByClass("ilobjectcontentstylesettingsgui", "")
        );

        $this->tabs_gui->activateSubTab($a_active);
    }

    protected function initEditCustomForm(ilPropertyFormGUI $a_form): void
    {
        $this->setSettingsSubTabs("properties");


        // profile picture
        $ppic = new ilCheckboxInputGUI($this->lng->txt("prtf_profile_picture"), "ppic");
        $a_form->addItem($ppic);

        $prfa_set = new ilSetting("prfa");

        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('obj_features'));
        $a_form->addItem($section);

        // comments
        $comments = new ilCheckboxInputGUI($this->lng->txt("prtf_public_comments"), "comments");
        $a_form->addItem($comments);

        /* #15000
        $bg_color = new ilColorPickerInputGUI($this->lng->txt("prtf_background_color"), "bg_color");
        $a_form->addItem($bg_color);

        $font_color = new ilColorPickerInputGUI($this->lng->txt("prtf_font_color"), "font_color");
        $a_form->addItem($font_color);
        */
    }

    protected function getEditFormCustomValues(array &$a_values): void
    {
        $a_values["comments"] = $this->object->hasPublicComments();
        $a_values["ppic"] = $this->object->hasProfilePicture();
        /*
        $a_values["bg_color"] = $this->object->getBackgroundColor();
        $a_values["font_color"] = $this->object->getFontColor();
        */
    }

    protected function updateCustom(ilPropertyFormGUI $form): void
    {
        $this->object->setPublicComments($form->getInput("comments"));
        $this->object->setProfilePicture($form->getInput("ppic"));
        $prfa_set = new ilSetting("prfa");
    }


    //
    // PAGES
    //

    abstract protected function getPageInstance(
        ?int $a_page_id = null,
        ?int $a_portfolio_id = null
    ): ilPortfolioPage;

    abstract protected function getPageGUIInstance(int $a_page_id): ilPortfolioPageGUI;

    abstract public function getPageGUIClassName(): string;

    public function view(): void
    {
        $ilToolbar = $this->toolbar;
        $ilSetting = $this->settings;
        $lng = $this->lng;

        if (!$this->checkPermissionBool("write")) {
            $this->ctrl->redirect($this, "infoScreen");
        }

        $this->tabs_gui->activateTab("pages");

        $pages = ilPortfolioPage::getAllPortfolioPages($this->getObject()->getId());

        $this->gui->button(
            $this->lng->txt("prtf_add_page"),
            $this->ctrl->getLinkTarget($this, "addPage")
        )->toToolbar(true);


        // #16571
        $modal_html = "";
        if ($this->getType() === "prtf" && count($pages) > 0) {
            $ilToolbar->addSeparator();

            $ui = $this->ui;

            if ($this->object->isCommentsExportPossible()) {
                $this->lng->loadLanguageModule("note");
                $comment_export_helper = new \ILIAS\Notes\Export\ExportHelperGUI();
                $comment_modal = $comment_export_helper->getCommentIncludeModalDialog(
                    $this->lng->txt("export_html"),
                    $this->lng->txt("note_html_export_include_comments"),
                    $this->ctrl->getLinkTarget($this, "export"),
                    $this->ctrl->getLinkTarget($this, "exportWithComments")
                );
                $button = $ui->factory()->button()->standard($this->lng->txt("export_html"), '')
                             ->withOnClick($comment_modal->getShowSignal());
                $ilToolbar->addComponent($button);
                $modal_html = $ui->renderer()->render($comment_modal);
            } else {
                $this->gui->button(
                    $this->lng->txt("export_html"),
                    $this->ctrl->getLinkTarget($this, "export")
                )->toToolbar();
            }

            $print_view = $this->getPrintView();
            $modal_elements = $print_view->getModalElements($this->ctrl->getLinkTarget(
                $this,
                "printSelection"
            ));
            $modal_html .= $ui->renderer()->render($modal_elements->modal);
            $ilToolbar->addComponent($modal_elements->button);
        }

        $table = new ilPortfolioPageTableGUI($this, "view");


        $this->tpl->setContent($table->getHTML() . $modal_html);
    }

    public function getPrintView(): \ILIAS\Export\PrintProcessGUI
    {
        $obj_ids = $this->port_request->getObjIds();
        $signature = $this->port_request->getSignature();
        $declaration = $this->port_request->getIncludeDeclaration();
        if (count($obj_ids) === 0) {
            $obj_ids = null;
        }
        $port = $this->object;
        $provider = new PortfolioPrintViewProviderGUI(
            $this->lng,
            $this->ctrl,
            $port,
            $signature,
            $obj_ids,
            $declaration
        );
        $provider = $provider->withDeclarationOfAuthorship(
            new ilPortfolioDeclarationOfAuthorship(),
            $this->user
        );
        return new \ILIAS\Export\PrintProcessGUI(
            $provider,
            $this->http,
            $this->ui,
            $this->lng
        );
    }

    protected function addPage(): void
    {
        $ilHelp = $this->help;

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "view")
        );

        $ilHelp->setScreenIdComponent("prtf");
        $ilHelp->setScreenId("add_page");


        $form = $this->initPageForm("create");
        $this->tpl->setContent($form->getHTML());
    }

    public function initPageForm(string $a_mode = "create"): ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));

        // title
        $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
        $ti->setMaxLength(200);
        $ti->setRequired(true);
        $form->addItem($ti);

        // save and cancel commands
        if ($a_mode === "create") {
            $templates = ilPageLayout::activeLayouts(ilPageLayout::MODULE_PORTFOLIO);
            if ($templates) {
                $use_template = new ilRadioGroupInputGUI($this->lng->txt("prtf_use_page_layout"), "tmpl");
                $use_template->setRequired(true);
                $form->addItem($use_template);

                $opt = new ilRadioOption($this->lng->txt("none"), 0);
                $use_template->addOption($opt);

                foreach ($templates as $templ) {
                    $templ->readObject();

                    $opt = new ilRadioOption($templ->getTitle() . $templ->getPreview(), $templ->getId());
                    $use_template->addOption($opt);
                }
            }

            $form->setTitle($this->lng->txt("prtf_add_page") . ": " .
                $this->object->getTitle());
            $form->addCommandButton("savePage", $this->lng->txt("save"));
            $form->addCommandButton("view", $this->lng->txt("cancel"));
        }

        return $form;
    }

    public function savePage(): void
    {
        $form = $this->initPageForm("create");
        if ($form->checkInput() && $this->checkPermissionBool("write")) {
            $page = $this->getPageInstance();
            $page->setType(ilPortfolioPage::TYPE_PAGE);
            $page->setTitle($form->getInput("title"));

            // use template as basis
            $layout_id = $form->getInput("tmpl");
            if ($layout_id) {
                $layout_obj = new ilPageLayout($layout_id);
                $page->setXMLContent($layout_obj->copyXmlContent(false));
            }

            $page->create();

            $this->tpl->setOnScreenMessage('success', $this->lng->txt("prtf_page_created"), true);
            $this->ctrl->redirect($this, "view");
        }

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "view")
        );

        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

    public function savePortfolioPagesOrdering(): void
    {
        if (!$this->checkPermissionBool("write")) {
            return;
        }

        $title_changes = array();

        $order = $this->port_request->getOrder();
        $titles = $this->port_request->getTitles();
        if (count($order) > 0) {
            foreach ($order as $k => $v) {
                $page = $this->getPageInstance(ilUtil::stripSlashes($k));
                if ($titles[$k] ?? "") {
                    $new_title = $titles[$k] ?? "";
                    if ($page->getTitle() != $new_title) {
                        $title_changes[$page->getId()] = array("old" => $page->getTitle(), "new" => $new_title);
                        $page->setTitle($new_title);
                    }
                }
                $page->setOrderNr(ilUtil::stripSlashes($v));
                $page->update();
            }
            ilPortfolioPage::fixOrdering($this->object->getId());
        }

        $this->object->fixLinksOnTitleChange($title_changes);

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "view");
    }

    public function confirmPortfolioPageDeletion(): void
    {
        $prtf_pages = $this->port_request->getPortfolioPageIds();

        if (count($prtf_pages) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "view");
        } else {
            $this->tabs_gui->activateTab("pages");

            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($this->ctrl->getFormAction($this));
            $cgui->setHeaderText($this->lng->txt("prtf_sure_delete_portfolio_pages"));
            $cgui->setCancel($this->lng->txt("cancel"), "view");
            $cgui->setConfirm($this->lng->txt("delete"), "deletePortfolioPages");

            foreach ($prtf_pages as $id) {
                $page = $this->getPageInstance($id);
                if ($page->getPortfolioId() !== $this->object->getId()) {
                    continue;
                }

                $title = $page->getTitle();
                $cgui->addItem("prtf_pages[]", $id, $title);
            }

            $this->tpl->setContent($cgui->getHTML());
        }
    }

    public function deletePortfolioPages(): void
    {
        if (!$this->checkPermissionBool("write")) {
            return;
        }

        $page_ids = $this->port_request->getPortfolioPageIds();
        foreach ($page_ids as $id) {
            $page = $this->getPageInstance($id);
            $page->delete();
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("prtf_portfolio_page_deleted"), true);
        $this->ctrl->redirect($this, "view");
    }

    public function preview(
        bool $a_return = false,
        $a_content = false,
        bool $a_show_notes = true
    ): string {
        $ilSetting = $this->settings;
        $ilUser = $this->user;
        $portfolio_id = $this->object->getId();
        $user_id = $this->object->getOwner();

        $content = "";

        $this->tabs_gui->clearTargets();

        $pages = ilPortfolioPage::getAllPortfolioPages($portfolio_id);
        $current_page = $this->getCurrentPage();

        // #13788 - keep page after login
        if ($this->user_id === ANONYMOUS_USER_ID &&
            $this->getType() === "prtf") {
            $this->tpl->setLoginTargetPar("prtf_" . $this->object->getId() . "_" . $current_page);
        }

        $back_caption = "";

        // public profile
        if ($this->requested_back_url != "") {
            $back = $this->requested_back_url;
        } elseif (strtolower($this->port_request->getBaseClass()) !== "ilpublicuserprofilegui" &&
            $this->user_id && $this->user_id !== ANONYMOUS_USER_ID) {
            if (!$this->checkPermissionBool("write")) {
                // shared
                if ($this->getType() === "prtf") {
                    $this->ctrl->setParameterByClass("ilportfoliorepositorygui", "shr_id", $this->object->getOwner());
                    $back = $this->ctrl->getLinkTargetByClass(array("ildashboardgui", "ilportfoliorepositorygui"), "showOther");
                    $this->ctrl->setParameterByClass("ilportfoliorepositorygui", "shr_id", "");
                }
                // listgui / parent container
                else {
                    // #12819
                    $tree = $this->tree;
                    $parent_id = $tree->getParentId($this->node_id);
                    $back = ilLink::_getStaticLink($parent_id);
                }
            }
            // owner
            else {
                $back = $this->ctrl->getLinkTarget($this, "view");
                if ($this->getType() === "prtf") {
                    $back_caption = $this->lng->txt("prtf_back_to_portfolio_owner");
                } else {
                    // #19316
                    $this->lng->loadLanguageModule("prtt");
                    $back_caption = $this->lng->txt("prtt_edit");
                }
            }
        }

        // render tabs
        if (count($pages) > 1) {
            foreach ($pages as $p) {
                $this->ctrl->setParameter($this, "user_page", $p["id"]);
                $this->tabs_gui->addTab(
                    "user_page_" . $p["id"],
                    $p["title"],
                    $this->ctrl->getLinkTarget($this, "preview")
                );
            }

            $this->tabs_gui->activateTab("user_page_" . $current_page);
        }

        $this->ctrl->setParameter($this, "user_page", $current_page);


        // blog posting comments are handled within the blog
        // note: notes must be handled before the $this->ctrl->getHTML below, since
        // this messes up the path since ILIAS 8
        $notes = "";
        if ($a_show_notes && $this->object->hasPublicComments() && $current_page) {
            $comment_gui = $this->getCommentGUI();
            $next_class = $this->ctrl->getNextClass($this);
            if ($next_class === "ilcommentgui") {
                $notes = $this->ctrl->forwardCommand($comment_gui);
            } else {
                $notes = $comment_gui->getListHTML();
            }
        }

        if (!$a_content) {
            // #18291
            if ($current_page) {
                // get current page content
                $page_gui = $this->getPageGUIInstance($current_page);
                $page_gui->setEmbedded(true);

                $content = $this->ctrl->getHTML($page_gui);
            }
        } else {
            $content = $a_content;
        }

        if ($a_return && $this->checkPermissionBool("write")) {
            return $content;
        }


        if (count($this->perma_link) === 0) {
            if ($this->getType() === "prtf") {
                $this->tpl->setPermanentLink($this->getType(), $this->object->getId(), "_" . $current_page);
            } else {
                $this->tpl->setPermanentLink($this->getType(), $this->object->getRefId());
            }
        } else {
            $this->tpl->setPermanentLink($this->perma_link["type"] ?? "", $this->perma_link["obj_id"] ?? 0);
        }

        // #18208 - see ilPortfolioTemplatePageGUI::getPageContentUserId()
        if ($this->getType() === "prtt" && !$this->checkPermissionBool("write")) {
            $user_id = $ilUser->getId();
        }

        $obj = $this->object;
        self::renderFullscreenHeader($obj, $this->tpl, $user_id);

        // #13564
        $this->ctrl->setParameter($this, "user_page", "");
        //$this->tpl->setTitleUrl($this->ctrl->getLinkTarget($this, "preview"));
        $this->ctrl->setParameter($this, "user_page", $this->page_id);

        // blog pages do their own (page) style handling
        $content = '<div id="ilCOPageContent" class="ilc_page_cont_PageContainer">' .
            '<div class="ilc_page_Page">' .
                $content .
            '</div></div>';

        $this->setContentStyleSheet($this->tpl);

        $this->showEditButton($current_page);

        // #10717
        $this->tpl->setContent($content .
            '<div class="ilClearFloat">' . $notes . '</div>');
        return "";
    }

    protected function getCurrentPage(): ?int
    {
        $pages = ilPortfolioPage::getAllPortfolioPages($this->object->getId());
        $current_page = (int) $this->requested_user_page;

        // validate current page
        if ($pages && $current_page) {
            $found = false;
            foreach ($pages as $page) {
                if ((int) $page["id"] === $current_page) {
                    $found = true;
                    break;
                }
            }
            if (!$found) {
                $current_page = null;
            }
        }

        // display first page of portfolio if none given
        if (!$current_page && $pages) {
            $current_page = $pages;
            $current_page = array_shift($current_page);
            $current_page = (int) $current_page["id"];
        }
        return $current_page;
    }

    protected function getCommentGUI(): ilCommentGUI
    {
        $gui = $this->notes->gui()->getCommentsGUI(
            $this->object->getId(),
            $this->getCurrentPage(),
            "pfpg"
        );
        $gui->setRepositoryMode(false);
        $gui->enablePublicNotesDeletion(($this->user_id === $this->object->getOwner()) &&
            $this->settings->get("comments_del_tutor", '1'));
        return $gui;
    }

    protected function showEditButton(
        int $page_id
    ): void {
        $page_class = ($this->getType() === "prtt")
            ? "ilPortfolioTemplatePageGUI"
            : "ilportfoliopagegui";
        $button = null;
        if ($this->checkPermissionBool("write") &&
            ($page_id === 0 || ilPortfolioPage::lookupType($page_id) === ilPortfolioPage::TYPE_PAGE)) {
            if ($this->getType() === "prtt") {
                $button = $this->ui->factory()->button()->standard(
                    $this->lng->txt("prtt_edit"),
                    $this->ctrl->getLinkTargetByClass(["ilobjportfoliotemplategui"], "view")
                );
            } else {
                $button = $this->ui->factory()->button()->standard(
                    $this->lng->txt("prtf_edit_portfolio"),
                    $this->ctrl->getLinkTargetByClass(["ilobjportfoliogui"], "view")
                );
            }
            $this->toolbar->addComponent($button);
            $button = null;
        }
        if ($page_id > 0 && ilPortfolioPage::lookupType($page_id) === ilPortfolioPage::TYPE_PAGE) {
            $this->ctrl->setParameterByClass($page_class, "ppage", $page_id);
            $button = $this->ui->factory()->button()->standard(
                $this->lng->txt("edit_page"),
                $this->ctrl->getLinkTargetByClass($page_class, "edit")
            );
            if ($this->checkPermissionBool("write")) {
                $this->toolbar->addComponent($button);
            }
            $button = null;
        }
        if ($button && $this->checkPermissionBool("write")) {
            $this->tpl->setHeaderActionMenu($this->ui->renderer()->render($button));
        }
    }

    public static function renderFullscreenHeader(
        ilObjPortfolioBase $a_portfolio,
        ilGlobalTemplateInterface $a_tpl,
        int $a_user_id,
        bool $a_export = false
    ): void {
        global $DIC;

        $ilUser = $DIC->user();

        if (!$a_export) {
            ilChangeEvent::_recordReadEvent(
                $a_portfolio->getType(),
                ($a_portfolio->getType() === "prtt")
                    ? $a_portfolio->getRefId()
                    : $a_portfolio->getId(),
                $a_portfolio->getId(),
                $ilUser->getId()
            );
        }

        $name = ilObjUser::_lookupName($a_user_id);
        $name = $name["lastname"] . ", " . (($t = $name["title"]) ? $t . " " : "") . $name["firstname"];

        $prfa_set = new ilSetting("prfa");

        // profile picture
        $ppic = null;
        if ($a_portfolio->hasProfilePicture()) {
            $ppic = ilObjUser::_getPersonalPicturePath($a_user_id, "xsmall", true, true);
            if ($a_export) {
                $ppic = basename($ppic);
            }
        }

        $a_tpl->resetHeaderBlock(false);
        // $a_tpl->setBackgroundColor($a_portfolio->getBackgroundColor());
        // @todo fix this
        $a_tpl->setTitleIcon((string) $ppic);
        $a_tpl->setTitle($a_portfolio->getTitle());
        // $a_tpl->setTitleColor($a_portfolio->getFontColor());
        $a_tpl->setDescription($name);

        // to get rid of locator in portfolio template preview
        $a_tpl->setVariable("LOCATOR", "");

        // :TODO: obsolete?
        // $a_tpl->setBodyClass("std ilExternal ilPortfolio");
    }

    public function export(
        bool $a_with_comments = false
    ): void {
        $port_export = new \ILIAS\Portfolio\Export\PortfolioHtmlExport($this);
        $port_export->includeComments($a_with_comments);
        $port_export->exportHtml();
        $port_export->deliver($this->object->getTitle() . ".zip", true);
    }

    public function exportWithComments(): void
    {
        $this->export(true);
    }

    public function copyPageForm(
        ?ilPropertyFormGUI $a_form = null
    ): void {
        $prtf_pages = $this->port_request->getPortfolioPageIds();

        if (count($prtf_pages) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "view");
        } else {
            $this->tabs_gui->activateTab("pages");

            if (!$a_form) {
                $a_form = $this->initCopyPageForm();
            }

            foreach ($prtf_pages as $page_id) {
                $item = new ilHiddenInputGUI("prtf_pages[]");
                $item->setValue($page_id);
                $a_form->addItem($item);
            }

            $this->tpl->setContent($a_form->getHTML());
        }
    }

    public function copyPage(): void
    {
        $form = $this->initCopyPageForm();
        if ($form->checkInput()) {
            // existing
            if ($form->getInput("target") === "old") {
                $portfolio_id = $form->getInput("prtf");
            }
            // new
            else {
                $portfolio = new ilObjPortfolio();
                $portfolio->setTitle($form->getInput("title"));
                $portfolio->create();
                $portfolio_id = $portfolio->getId();
            }

            // copy page(s)
            $page_ids = $this->port_request->getPortfolioPageIds();
            foreach ($page_ids as $page_id) {
                $source = $this->getPageInstance($page_id);
                $target = $this->getPageInstance(null, $portfolio_id);
                $target->setXMLContent($source->copyXmlContent(true)); // copy mobs
                $target->setType($source->getType());
                $target->setTitle($source->getTitle());
                $target->create();
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt("prtf_pages_copied"), true);
            $this->ctrl->redirect($this, "view");
        }

        $form->setValuesByPost();
        $this->copyPageForm($form);
    }

    abstract protected function initCopyPageFormOptions(ilPropertyFormGUI $a_form): void;

    public function initCopyPageForm(): ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("prtf_copy_page"));

        $this->initCopyPageFormOptions($form);

        $form->addCommandButton("copyPage", $this->lng->txt("save"));
        $form->addCommandButton("view", $this->lng->txt("cancel"));

        return $form;
    }



    public function setContentStyleSheet(
        ?ilGlobalTemplateInterface $a_tpl = null
    ): void {
        $tpl = $this->tpl;

        if ($a_tpl) {
            $ctpl = $a_tpl;
        } else {
            $ctpl = $tpl;
        }

        $this->content_style_gui->addCss(
            $ctpl,
            $this->object->getRefId(),
            $this->object->getId()
        );
    }
}