Learning history main GUI class. More...

Collaboration diagram for ilLearningHistoryGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	setUserId ($user_id)
	Set user id. More...

	executeCommand ()
	Execute command. More...

	getEmbeddedHTML ($from=null, $to=null, $classes=null, $a_mode=null)
	Get HTML. More...

	getHTML ($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 ()
	Show. More...

	renderAsync ()
	Render Async. More...

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

	renderButton ()
	render Button More...

Protected Attributes
	$ctrl

	$main_tpl

	$lng

	$ui

	$certificateSettings

	$tabs

	$show_more = false

	$last_ts = 0

Detailed Description

Learning history main GUI class.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilLearningHistoryGUI::__construct ( )

Constructor.

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

References $_GET, $DIC, and ui().

     {
         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");
 
         $this->from = null;
         $this->to = ((int) $_GET["to_ts"] > 0)
             ? (int) $_GET["to_ts"]
             : null;
 
         $this->main_tpl->addJavaScript("./Services/LearningHistory/js/LearningHistory.js");
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilLearningHistoryGUI::executeCommand ( )

Execute command.

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

References $ctrl.

     {
         $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();
                 }
         }
     }

◆ getEmbeddedHTML()

ilLearningHistoryGUI::getEmbeddedHTML	(	$from = `null`,
		$to = `null`,
		$classes = `null`,
		$a_mode = `null`
	)

Get HTML.

Parameters

null	$from
null	$to
null	$classes

Returns: string

Exceptions

ilCtrlException

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

References $ctrl.

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

◆ getHistoryHtml()

ilLearningHistoryGUI::getHistoryHtml	(	$from = `null`,
		$to = `null`,
		$classes = `null`,
		$mode = `null`
	)

protected

Get history html.

Returns: string

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

References $ctrl, Vendor\Package\$e, $tpl, ilTimelineGUI\getInstance(), renderButton(), and ui().

Referenced by getHTML(), and show().

     {
         $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();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilLearningHistoryGUI::getHTML ( $par )

Get HTML.

Parameters

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

References getHistoryHtml().

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

Here is the call graph for this function:

◆ renderAsync()

ilLearningHistoryGUI::renderAsync ( )

protected

Render Async.

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

References $response, exit, and renderButton().

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

Here is the call graph for this function:

◆ renderButton()

ilLearningHistoryGUI::renderButton ( )

protected

render Button

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

References $ctrl, Vendor\Package\$f, $url, ui(), and ILIAS\UI\Implementation\Component\Button\withLoadingAnimationOnClick().

Referenced by getHistoryHtml(), and renderAsync().

     {
         $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(function ($id) use ($url) {
                 return "il.LearningHistory.initShowMore('$id', '" . $url . "');";
             });
         if ($ctrl->isAsynch()) {
             return $renderer->renderAsync($button);
         } else {
             return $renderer->render($button);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUserId()

ilLearningHistoryGUI::setUserId ( $user_id )

Set user id.

Parameters

int $user_id

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

     {
         $this->user_id = $user_id;
     }

◆ show()

ilLearningHistoryGUI::show ( )

protected

Show.

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

References Vendor\Package\$f, $lng, $main_tpl, getHistoryHtml(), and ui().

     {
         $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"))
                 )
             );
         }
     }