Learning history main GUI class. More...

Collaboration diagram for ilLearningHistoryGUI:

Public Member Functions
	__construct ()

	setUserId (int $user_id)

	executeCommand ()

	getEmbeddedHTML (?int $from=null, ?int $to=null, ?array $classes=null, ?string $a_mode=null)

	getHTML (array $par)
	Get HTML. More...

Data Fields
const	TAB_ID_LEARNING_HISTORY = 'lhist_learning_history'

const	TAB_ID_MY_CERTIFICATES = 'certificates'

const	MAX = 50

Protected Member Functions
	show ()

	renderAsync ()

	send (string $output)

	getHistoryHtml (?int $from=null, ?int $to=null, ?array $classes=null, ?string $mode=null)
	Get history html. More...

	renderButton ()

Protected Attributes
ILIAS HTTP Services	$http

int	$to

int	$from

int	$user_id

ilAccessHandler	$access

ilLearningHistoryService	$lhist_service

ilCtrl	$ctrl

ilGlobalTemplateInterface	$main_tpl

ilLanguage	$lng

ILIAS DI UIServices	$ui

ilSetting	$certificateSettings

ilTabsGUI	$tabs

bool	$show_more = false

int	$last_ts = 0

Detailed Description

Learning history main GUI class.

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

Definition at line 25 of file class.ilLearningHistoryGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLearningHistoryGUI::__construct ( )

Definition at line 45 of file class.ilLearningHistoryGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
 
        $this->lhist_service = $DIC->learningHistory();
        $this->ui = $this->lhist_service->ui();
        $this->main_tpl = $this->ui->mainTemplate();
        $this->lng = $this->lhist_service->language();
        $this->access = $this->lhist_service->access();
        $this->tabs = $DIC->tabs();
 
        $this->lng->loadLanguageModule("lhist");
 
        $this->user_id = $this->lhist_service->user()->getId();
 
        $this->certificateSettings = new ilSetting("certificate");
 
        $request = $this->lhist_service->request();
        $to = $request->getToTS();
        $this->from = null;
        $this->to = ($to > 0)
            ? $to
            : null;
 
        $this->main_tpl->addJavaScript("./Services/LearningHistory/js/LearningHistory.js");
        $this->http = $DIC->http();
    }

References $DIC, $to, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\ui().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilLearningHistoryGUI::executeCommand ( )

Definition at line 80 of file class.ilLearningHistoryGUI.php.

                                    : void
    {
        $ctrl = $this->ctrl;
 
        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("show");
 
        switch ($next_class) {
            default:
                if (in_array($cmd, array("show", "renderAsync"))) {
                    $this->$cmd();
                }
        }
    }

References $ctrl, ilCtrl\getCmd(), and ilCtrl\getNextClass().

Here is the call graph for this function:

◆ getEmbeddedHTML()

ilLearningHistoryGUI::getEmbeddedHTML	(	?int	$from = `null`,
		?int	$to = `null`,
		?array	$classes = `null`,
		?string	$a_mode = `null`
	)

Exceptions

ilCtrlException

Definition at line 138 of file class.ilLearningHistoryGUI.php.

     : string {
        return $this->ctrl->getHTML($this, ["from" => $from, "to" => $to, "classes" => $classes, "mode" => $a_mode]);
    }

◆ getHistoryHtml()

ilLearningHistoryGUI::getHistoryHtml	(	?int	$from = `null`,
		?int	$to = `null`,
		?array	$classes = `null`,
		?string	$mode = `null`
	)

protected

Get history html.

Definition at line 158 of file class.ilLearningHistoryGUI.php.

     : string {
        $tpl = new ilTemplate("tpl.timeline.html", true, true, "Services/LearningHistory");
 
        $tpl->setVariable("TIMELINE", $this->renderTimeline($from, $to, $classes, $mode));
 
        if ($this->show_more && $mode !== "print") {
            $tpl->setCurrentBlock("show_more");
            $tpl->setVariable("SHOW_MORE_BUTTON", $this->renderButton());
            $tpl->parseCurrentBlock();
        }
 
        return $tpl->get();
    }

References $tpl.

Referenced by show().

Here is the caller graph for this function:

◆ getHTML()

ilLearningHistoryGUI::getHTML ( array $par )

Get HTML.

Definition at line 150 of file class.ilLearningHistoryGUI.php.

                                       : string
    {
        return $this->getHistoryHtml($par["from"], $par["to"], $par["classes"], $par["mode"]);
    }

◆ renderAsync()

ilLearningHistoryGUI::renderAsync ( )

protected

Definition at line 115 of file class.ilLearningHistoryGUI.php.

                                    : void
    {
        $response["timeline"] = $this->renderTimeline($this->from, $this->to);
        $response["more"] = $this->show_more ? $this->renderButton() : "";
        $this->send(json_encode($response, JSON_THROW_ON_ERROR));
    }

References $response, renderButton(), and send().

Here is the call graph for this function:

◆ renderButton()

ilLearningHistoryGUI::renderButton ( )

protected

Definition at line 226 of file class.ilLearningHistoryGUI.php.

                                     : string
    {
        $ctrl = $this->ctrl;
        $f = $this->ui->factory();
        $renderer = $this->ui->renderer();
        $ctrl->setParameter($this, "to_ts", $this->last_ts - 1);
        $url = $ctrl->getLinkTarget($this, "renderAsync", "", true);
 
        $button = $f->button()->standard($this->lng->txt("lhist_show_more"), "")
            ->withLoadingAnimationOnClick(true)
            ->withOnLoadCode(static function ($id) use ($url): string {
                return "il.LearningHistory.initShowMore('$id', '" . $url . "');";
            });
        if ($ctrl->isAsynch()) {
            return $renderer->renderAsync($button);
        }
 
        return $renderer->render($button);
    }

References Vendor\Package\$f, $id, $url, ilCtrl\getLinkTarget(), ilCtrl\isAsynch(), ILIAS\Repository\lng(), ilCtrl\setParameter(), and ILIAS\Repository\ui().

Referenced by renderAsync().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ send()

ilLearningHistoryGUI::send ( string $output )

protected

Parameters

string $output

Exceptions

ILIAS\HTTP\Response\Sender\ResponseSendingException

Definition at line 126 of file class.ilLearningHistoryGUI.php.

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

References ILIAS\FileDelivery\http().

Referenced by renderAsync().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUserId()

ilLearningHistoryGUI::setUserId ( int $user_id )

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

                                           : void
    {
        $this->user_id = $user_id;
    }

References $user_id.

◆ show()

ilLearningHistoryGUI::show ( )

protected

Definition at line 95 of file class.ilLearningHistoryGUI.php.

                             : void
    {
        $main_tpl = $this->main_tpl;
        $lng = $this->lng;
        $f = $this->ui->factory();
        $renderer = $this->ui->renderer();
 
        $html = $this->getHistoryHtml($this->from, $this->to);
 
        if ($html !== "") {
            $main_tpl->setContent($html);
        } else {
            $main_tpl->setContent(
                $renderer->render(
                    $f->messageBox()->info($lng->txt("lhist_no_entries"))
                )
            );
        }
    }