ILIAS\Export\PrintProcessGUI Class Reference

Collaboration diagram for ILIAS\Export\PrintProcessGUI:

Public Member Functions
	__construct (PrintViewProvider $provider, \ILIAS\HTTP\Services $http, UIServices $ui, \ilLanguage $lng, string $body_class=null)
	PrintViewGUI constructor. More...
	setOffline (bool $offline)
	Set output mode. More...
	addTemplateInjector (callable $f)
	getModalElements (string $selection_action)
	sendForm ()
	renderPrintView (int $content_style_id=0)
	sendPrintView (int $content_style_id=0)

Protected Member Functions
	send (string $output)
	Send. More...

Protected Attributes
ILIAS GlobalScreen Services	$gs
ilGlobalTemplateInterface	$main_tpl
array	$injectors = []
string	$body_class = null
HTTP Services	$http
UIServices	$ui
ilLanguage	$lng
PrintViewProvider	$provider

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ILIAS\Export\PrintProcessGUI::__construct	(	PrintViewProvider	$provider,
		\ILIAS\HTTP\Services	$http,
		UIServices	$ui,
		\ilLanguage	$lng,
		string	$body_class = null
	)

PrintViewGUI constructor.

Parameters

PrintViewProvider	$provider
\ILIAS\HTTP\Services	$http
UIServices	$ui
\ilLanguage	$lng
string | null	$body_class

Definition at line 53 of file class.PrintProcessGUI.php.

References $DIC, ILIAS\Export\PrintProcessGUI\$http, ILIAS\Export\PrintProcessGUI\$lng, ILIAS\Export\PrintProcessGUI\$provider, ILIAS\Export\PrintProcessGUI\$ui, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

      {
        global $DIC;

        $this->provider = $provider;
        $this->ui = $ui;
        $this->lng = $lng;
        $this->http = $http;
        $this->body_class = $body_class ?? "ilPrtfPdfBody";     // todo: move this class
        $this->lng->loadLanguageModule("exp");
        $this->gs = $DIC->globalScreen();
    }

Here is the call graph for this function:

Member Function Documentation

addTemplateInjector()

ILIAS\Export\PrintProcessGUI::addTemplateInjector

(

callable

$f

)

Definition at line 81 of file class.PrintProcessGUI.php.

References Vendor\Package\$f.

                                                    : void
    {
        $this->injectors[] = $f;
    }

getModalElements()

ILIAS\Export\PrintProcessGUI::getModalElements

(

string

$selection_action

)

Definition at line 86 of file class.PrintProcessGUI.php.

References ILIAS\Export\PrintProcessGUI\$lng, ILIAS\Export\PrintProcessGUI\$ui, ILIAS\DI\UIServices\factory(), ILIAS\Repository\lng(), and ILIAS\DI\UIServices\mainTemplate().

     : \stdClass {
        $ui = $this->ui;
        $lng = $this->lng;

        $ui->mainTemplate()->addJavaScript("./Services/Form/js/Form.js");
        $modal = $ui->factory()->modal()->roundtrip(
            $this->lng->txt("exp_print_pdf"),
            $ui->factory()->legacy('some modal')
        )->withAsyncRenderUrl($selection_action);
        $print_button = $ui->factory()->button()->standard(
            $this->lng->txt("exp_print_pdf"),
            $modal->getShowSignal()
        );
        $elements = new \stdClass();
        $elements->button = $print_button;
        $elements->modal = $modal;

        return $elements;
    }

Here is the call graph for this function:

renderPrintView()

ILIAS\Export\PrintProcessGUI::renderPrintView

(

int

$content_style_id = 0

)

Definition at line 131 of file class.PrintProcessGUI.php.

References Vendor\Package\$f, $path, $tpl, ilObjStyleSheet\getContentPrintStyle(), ilObjStyleSheet\getContentStylePath(), ilUtil\getStyleSheetLocation(), ilObjStyleSheet\getSyntaxStylePath(), and iljQueryUtil\initjQuery().

Referenced by ILIAS\Export\PrintProcessGUI\sendPrintView().

                                                              : string
    {
        \iljQueryUtil::initjQuery();        // e.g. on survey print screens necessary
        $pages = $this->provider->getPages();
        $tpl = new \ilGlobalTemplate(
            "tpl.print_view.html",
            true,
            true,
            "Services/Export/Print"
        );

        // get all current resources from globalscreen and add them to our template
        foreach ($this->gs->layout()->meta()->getJs()->getItemsInOrderOfDelivery() as $js) {
            $path = explode("?", $js->getContent());
            $file = $path[0];
            $tpl->addJavaScript($file, $js->addVersionNumber());
        }
        foreach ($this->gs->layout()->meta()->getOnLoadCode()->getItemsInOrderOfDelivery() as $code) {
            $tpl->addOnLoadCode($code->getContent());
        }

        //\iljQueryUtil::initjQuery($tpl);

        foreach ($this->provider->getTemplateInjectors() as $f) {
            $f($tpl);
        }

        $tpl->setBodyClass($this->body_class);
        $tpl->addCss(\ilUtil::getStyleSheetLocation("filesystem"));
        $tpl->addCss(
            \ilObjStyleSheet::getContentStylePath(
                $content_style_id,
                false
            )
        );
        $tpl->addCss(\ilObjStyleSheet::getContentPrintStyle());
        $tpl->addCss(\ilObjStyleSheet::getSyntaxStylePath());

        $pb = ($this->provider->autoPageBreak())
            ? '<div style="page-break-after:always;"></div>'
            : "";

        $content = implode(
            $pb,
            $pages
        );

        $content = '<div class="ilInvisibleBorder">' . $content . '</div>';
        $tpl->addOnLoadCode("il.Util.print();");

        $tpl->setVariable("CONTENT", $content);
        return $tpl->printToString();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ILIAS\Export\PrintProcessGUI::send ( string  $output )

protected

Send.

Parameters

string

$output

Exceptions

HTTP

Definition at line 198 of file class.PrintProcessGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Filesystem\Stream\Streams\ofString().

Referenced by ILIAS\Export\PrintProcessGUI\sendForm(), and ILIAS\Export\PrintProcessGUI\sendPrintView().

    {
        $this->http->saveResponse($this->http->response()->withBody(
            Streams::ofString($output)
        ));
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendForm()

ILIAS\Export\PrintProcessGUI::sendForm

(

)

Parameters

\ilPropertyFormGUI

$form

Exceptions

HTTP

Definition at line 112 of file class.PrintProcessGUI.php.

References $tpl, ILIAS\Repository\lng(), ILIAS\Export\PrintProcessGUI\send(), and ILIAS\Repository\ui().

                              : void
    {
        $form = $this->provider->getSelectionForm();
        $mb = $this->ui->factory()->messageBox()->info($this->lng->txt("exp_print_pdf_info"));
        $tpl = new \ilTemplate("tpl.print_view_selection.html", true, true, "Services/Export/Print");
        $form->setTarget("print_view");
        $tpl->setVariable("FORM", $form->getHTML());
        $tpl->setVariable("ON_SUBMIT_CODE", $this->provider->getOnSubmitCode());
        $modal = $this->ui->factory()->modal()->roundtrip(
            $this->lng->txt("exp_print_pdf"),
            $this->ui->factory()->legacy(
                $this->ui->renderer()->render($mb) .
                $tpl->get()
            )
        );

        $this->send($this->ui->renderer()->render($modal));
    }

Here is the call graph for this function:

sendPrintView()

ILIAS\Export\PrintProcessGUI::sendPrintView

(

int

$content_style_id = 0

)

Exceptions

HTTP

Definition at line 188 of file class.PrintProcessGUI.php.

References ILIAS\Export\PrintProcessGUI\renderPrintView(), and ILIAS\Export\PrintProcessGUI\send().

                                                            : void
    {
        $this->send($this->renderPrintView($content_style_id));
    }

Here is the call graph for this function:

setOffline()

ILIAS\Export\PrintProcessGUI::setOffline

(

bool

$offline

)

Set output mode.

Parameters

string

$a_val

self::PRINT|self::OFFLINE

Definition at line 75 of file class.PrintProcessGUI.php.

    {
        $this->provider->setOffline($offline);
    }

Field Documentation

$body_class

string ILIAS\Export\PrintProcessGUI::$body_class = null

protected

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

$gs

ILIAS GlobalScreen Services ILIAS\Export\PrintProcessGUI::$gs

protected

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

$http

HTTP Services ILIAS\Export\PrintProcessGUI::$http

protected

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

Referenced by ILIAS\Export\PrintProcessGUI\__construct().

$injectors

array ILIAS\Export\PrintProcessGUI::$injectors = []

protected

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

$lng

ilLanguage ILIAS\Export\PrintProcessGUI::$lng

protected

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

Referenced by ILIAS\Export\PrintProcessGUI\__construct(), and ILIAS\Export\PrintProcessGUI\getModalElements().

$main_tpl

ilGlobalTemplateInterface ILIAS\Export\PrintProcessGUI::$main_tpl

protected

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

$provider

PrintViewProvider ILIAS\Export\PrintProcessGUI::$provider

protected

Definition at line 43 of file class.PrintProcessGUI.php.

Referenced by ILIAS\Export\PrintProcessGUI\__construct().

$ui

UIServices ILIAS\Export\PrintProcessGUI::$ui

protected

Definition at line 41 of file class.PrintProcessGUI.php.

Referenced by ILIAS\Export\PrintProcessGUI\__construct(), and ILIAS\Export\PrintProcessGUI\getModalElements().

---

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

• Services/Export/Print/class.PrintProcessGUI.php