ILIAS\Portfolio\PortfolioPrintViewProviderGUI Class Reference

Inheritance diagram for ILIAS\Portfolio\PortfolioPrintViewProviderGUI:

Collaboration diagram for ILIAS\Portfolio\PortfolioPrintViewProviderGUI:

Public Member Functions
	__construct (\ilLanguage $lng, \ilCtrl $ctrl, \ilObjPortfolio $portfolio, bool $include_signature=false, ?array $selected_pages=null, bool $include_declaration=false)
	withDeclarationOfAuthorship (\ilPortfolioDeclarationOfAuthorship $decl, \ilObjUser $user)
	getSelectionForm ()
	form which is featured in the modal form target is modified to open in new window (not yet possible with ks forms) the print/pdf message is added automatically More...
	getTemplateInjectors ()
	getPages ()
Public Member Functions inherited from ILIAS\Export\AbstractPrintViewProvider
	setOffline (bool $offline)
	Set output mode. More...
	getOnSubmitCode ()
	autoPageBreak ()
	getSelectionForm ()
	getPages ()
	getTemplateInjectors ()

Protected Attributes
bool	$include_declaration = false
StandardGUIRequest	$port_request
ilLanguage	$lng
ilObjPortfolio	$portfolio
array	$selected_pages = null
bool	$include_signature
ilPortfolioDeclarationOfAuthorship	$declaration_of_authorship = null
ilObjUser	$user
ilCtrl	$ctrl
Protected Attributes inherited from ILIAS\Export\AbstractPrintViewProvider
	$offline = false

Additional Inherited Members
Data Fields inherited from ILIAS\Export\AbstractPrintViewProvider
const	PRINT = "print"
const	OFFLINE = "offline"
Protected Member Functions inherited from ILIAS\Export\AbstractPrintViewProvider
	getOutputMode ()
	Get output mode. More...

Detailed Description

Author

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

Definition at line 28 of file class.PortfolioPrintViewProviderGUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Portfolio\PortfolioPrintViewProviderGUI::__construct	(	\ilLanguage	$lng,
		\ilCtrl	$ctrl,
		\ilObjPortfolio	$portfolio,
		bool	$include_signature = false,
		?array	$selected_pages = null,
		bool	$include_declaration = false
	)

Definition at line 40 of file class.PortfolioPrintViewProviderGUI.php.

References ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$ctrl, $DIC, ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$include_declaration, ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$include_signature, ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$lng, ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$portfolio, ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$selected_pages, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

      {
        global $DIC;

        $this->lng = $lng;
        $this->ctrl = $ctrl;
        $this->portfolio = $portfolio;
        $this->selected_pages = $selected_pages;
        $this->include_signature = $include_signature;
        $this->include_declaration = $include_declaration;
        $this->port_request = $DIC->portfolio()
            ->internal()
            ->gui()
            ->standardRequest();
    }

Here is the call graph for this function:

Member Function Documentation

getPages()

ILIAS\Portfolio\PortfolioPrintViewProviderGUI::getPages

(

)

Returns

string[]

Implements ILIAS\Export\PrintViewProvider.

Definition at line 151 of file class.PortfolioPrintViewProviderGUI.php.

References ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$lng, ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$portfolio, ilLink\_getStaticLink(), ilObjUser\_lookupName(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilPortfolioPage\getAllPortfolioPages(), ilUtil\getImagePath(), ILIAS\Export\AbstractPrintViewProvider\getOutputMode(), IL_CAL_DATE, and ilDatePresentation\setUseRelativeDates().

                              : array
    {
        $lng = $this->lng;
        $portfolio = $this->portfolio;

        $pages = \ilPortfolioPage::getAllPortfolioPages(
            $portfolio->getId()
        );

        $print_pages = [];

        // cover page
        $cover_tpl = new \ilTemplate(
            "tpl.prtf_cover.html",
            true,
            true,
            "components/ILIAS/Portfolio"
        );
        foreach ($pages as $page) {
            if (is_array($this->selected_pages) &&
                !in_array($page["id"], $this->selected_pages)) {
                continue;
            }
            $cover_tpl->setCurrentBlock("content_item");
            $cover_tpl->setVariable("ITEM_TITLE", $page["title"]);
            $cover_tpl->parseCurrentBlock();
        }

        if ($this->include_signature) {
            $cover_tpl->setCurrentBlock("signature");
            $cover_tpl->setVariable("TXT_SIGNATURE", $lng->txt("prtf_signature_date"));
            $cover_tpl->parseCurrentBlock();
        }

        if (!is_null($this->declaration_of_authorship) && $this->include_declaration) {
            $cover_tpl->setCurrentBlock("decl_author");
            $cover_tpl->setVariable(
                "TXT_DECL_AUTHOR",
                nl2br($this->declaration_of_authorship->getForUser($this->user))
            );
            $cover_tpl->parseCurrentBlock();
        }

        $cover_tpl->setVariable("PORTFOLIO_TITLE", $this->portfolio->getTitle());
        $cover_tpl->setVariable("PORTFOLIO_ICON", \ilUtil::getImagePath("standard/icon_prtf.svg"));

        $cover_tpl->setVariable("TXT_AUTHOR", $lng->txt("prtf_author"));
        $cover_tpl->setVariable("TXT_LINK", $lng->txt("prtf_link"));
        $cover_tpl->setVariable("TXT_DATE", $lng->txt("prtf_date_of_print"));
        $cover_tpl->setVariable("TXT_TABLE_OF_CONTENTS", $lng->txt("prtf_table_of_contents"));

        $author = \ilObjUser::_lookupName($this->portfolio->getOwner());
        $author_str = $author["firstname"] . " " . $author["lastname"];
        $cover_tpl->setVariable("AUTHOR", $author_str);

        $href = \ilLink::_getStaticLink($this->portfolio->getId(), "prtf");
        $cover_tpl->setVariable("LINK", $href);

        \ilDatePresentation::setUseRelativeDates(false);
        $date_str = \ilDatePresentation::formatDate(new \ilDate(date("Y-m-d"), IL_CAL_DATE));
        $cover_tpl->setVariable("DATE", $date_str);

        $print_pages[] = $cover_tpl->get();

        $page_head_tpl = new \ilTemplate("tpl.prtf_page_head.html", true, true, "components/ILIAS/Portfolio");
        $page_head_tpl->setVariable("AUTHOR", $author_str);
        $page_head_tpl->setVariable("DATE", $date_str);
        $page_head_str = $page_head_tpl->get();

        foreach ($pages as $page) {
            if (is_array($this->selected_pages) &&
                !in_array($page["id"], $this->selected_pages)) {
                continue;
            }
            $page_gui = new \ilPortfolioPageGUI($this->portfolio->getId(), $page["id"]);
            $page_gui->setOutputMode($this->getOutputMode());
            $page_gui->setPresentationTitle($page["title"]);
            $html = $this->ctrl->getHTML($page_gui);
            $print_pages[] = $page_head_str . $html;
        }

        return $print_pages;
    }

Here is the call graph for this function:

getSelectionForm()

ILIAS\Portfolio\PortfolioPrintViewProviderGUI::getSelectionForm

(

)

form which is featured in the modal form target is modified to open in new window (not yet possible with ks forms) the print/pdf message is added automatically

Returns

ilPropertyFormGUI|null

Implements ILIAS\Export\PrintViewProvider.

Definition at line 72 of file class.PortfolioPrintViewProviderGUI.php.

References ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$ctrl, ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$lng, ilPortfolioPage\getAllPortfolioPages(), ilUtil\getImagePath(), and ILIAS\Repository\lng().

                                      : ?ilPropertyFormGUI
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

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


        $form = new \ilPropertyFormGUI();

        // declaration of authorship
        if ($this->declaration_of_authorship &&
            $this->declaration_of_authorship->getForUser($this->user) !== "") {
            $cb = new \ilCheckboxInputGUI($this->lng->txt("prtf_decl_authorship"), "decl_author");
            $cb->setInfo($this->declaration_of_authorship->getForUser($this->user));
            $form->addItem($cb);
        }

        // signature
        $cb = new \ilCheckboxInputGUI($this->lng->txt("prtf_signature"), "signature");
        $cb->setInfo($this->lng->txt("prtf_signature_info"));
        $form->addItem($cb);


        // selection type
        $radg = new \ilRadioGroupInputGUI($lng->txt("prtf_print_selection"), "sel_type");
        $radg->setValue("all_pages");
        $op2 = new \ilRadioOption($lng->txt("prtf_all_pages"), "all_pages");
        $radg->addOption($op2);
        $op3 = new \ilRadioOption($lng->txt("prtf_selected_pages"), "selection");
        $radg->addOption($op3);

        $nl = new \ilNestedListInputGUI("", "obj_id");
        $op3->addSubItem($nl);

        foreach ($pages as $p) {
            $nl->addListNode(
                $p["id"],
                $p["title"],
                0,
                false,
                false,
                \ilUtil::getImagePath("standard/icon_pg.svg"),
                $lng->txt("page")
            );
        }

        $form->addItem($radg);

        $form->addCommandButton("showPrintView", $lng->txt("exp_show_print_view"));

        $form->setTitle($lng->txt("prtf_print_options"));
        $form->setFormAction(
            $ilCtrl->getFormActionByClass(
                "ilObjPortfolioGUI",
                "showPrintView"
            )
        );

        return $form;
    }

Here is the call graph for this function:

getTemplateInjectors()

ILIAS\Portfolio\PortfolioPrintViewProviderGUI::getTemplateInjectors

(

)

Returns

callable[] each callable gets the $tpl passed to inject css/js/...

Implements ILIAS\Export\PrintViewProvider.

Definition at line 134 of file class.PortfolioPrintViewProviderGUI.php.

References ilPageObjectGUI\OFFLINE.

                                          : array
    {
        $page = new \ilPortfolioPage();
        $page->setEmptyPageXml();
        $resource_collector = new COPage\ResourcesCollector(
            \ilPageObjectGUI::OFFLINE,
            $page
        );
        $resource_injector = new COPage\ResourcesInjector($resource_collector);

        return [
            function ($tpl) use ($resource_injector) {
                $resource_injector->inject($tpl);
            }
        ];
    }

withDeclarationOfAuthorship()

ILIAS\Portfolio\PortfolioPrintViewProviderGUI::withDeclarationOfAuthorship	(	\ilPortfolioDeclarationOfAuthorship	$decl,
		\ilObjUser	$user
	)

Definition at line 62 of file class.PortfolioPrintViewProviderGUI.php.

References $c, and ILIAS\Portfolio\PortfolioPrintViewProviderGUI\$user.

     : self {
        $c = clone $this;
        $c->declaration_of_authorship = $decl;
        $c->user = $user;
        return $c;
    }

Field Documentation

$ctrl

ilCtrl ILIAS\Portfolio\PortfolioPrintViewProviderGUI::$ctrl

protected

Definition at line 38 of file class.PortfolioPrintViewProviderGUI.php.

Referenced by ILIAS\Portfolio\PortfolioPrintViewProviderGUI\__construct(), and ILIAS\Portfolio\PortfolioPrintViewProviderGUI\getSelectionForm().

$declaration_of_authorship

ilPortfolioDeclarationOfAuthorship ILIAS\Portfolio\PortfolioPrintViewProviderGUI::$declaration_of_authorship = null

protected

Definition at line 36 of file class.PortfolioPrintViewProviderGUI.php.

$include_declaration

bool ILIAS\Portfolio\PortfolioPrintViewProviderGUI::$include_declaration = false

protected

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

Referenced by ILIAS\Portfolio\PortfolioPrintViewProviderGUI\__construct().

$include_signature

bool ILIAS\Portfolio\PortfolioPrintViewProviderGUI::$include_signature

protected

Definition at line 35 of file class.PortfolioPrintViewProviderGUI.php.

Referenced by ILIAS\Portfolio\PortfolioPrintViewProviderGUI\__construct().

$lng

ilLanguage ILIAS\Portfolio\PortfolioPrintViewProviderGUI::$lng

protected

Definition at line 32 of file class.PortfolioPrintViewProviderGUI.php.

Referenced by ILIAS\Portfolio\PortfolioPrintViewProviderGUI\__construct(), ILIAS\Portfolio\PortfolioPrintViewProviderGUI\getPages(), and ILIAS\Portfolio\PortfolioPrintViewProviderGUI\getSelectionForm().

$port_request

StandardGUIRequest ILIAS\Portfolio\PortfolioPrintViewProviderGUI::$port_request

protected

Definition at line 31 of file class.PortfolioPrintViewProviderGUI.php.

$portfolio

ilObjPortfolio ILIAS\Portfolio\PortfolioPrintViewProviderGUI::$portfolio

protected

Definition at line 33 of file class.PortfolioPrintViewProviderGUI.php.

Referenced by ILIAS\Portfolio\PortfolioPrintViewProviderGUI\__construct(), and ILIAS\Portfolio\PortfolioPrintViewProviderGUI\getPages().

$selected_pages

array ILIAS\Portfolio\PortfolioPrintViewProviderGUI::$selected_pages = null

protected

Definition at line 34 of file class.PortfolioPrintViewProviderGUI.php.

Referenced by ILIAS\Portfolio\PortfolioPrintViewProviderGUI\__construct().

$user

ilObjUser ILIAS\Portfolio\PortfolioPrintViewProviderGUI::$user

protected

Definition at line 37 of file class.PortfolioPrintViewProviderGUI.php.

Referenced by ILIAS\Portfolio\PortfolioPrintViewProviderGUI\withDeclarationOfAuthorship().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Portfolio/PrintView/class.PortfolioPrintViewProviderGUI.php