ilLTIViewGUI Class Reference

class for ILIAS ViewLTI More...

Collaboration diagram for ilLTIViewGUI:

Public Member Functions
	__construct (\ilObjUser $user)
	Constructor. More...
	executeCommand ()
	for ctrl commands More...
	activate ()
	activate LTI GUI More...
	deactivate ()
	deactivate LTI GUI More...
	isActive ()
	LTI is active. More...
	initGUI ()
	Set the environment backend for GUI (tree and locator behaviour, home link, ....) it is also possible to hide locator and treeicon, but if activated elsewhere a clean root folder is defined ToDo: conceptual discussion. More...
	render ($tpl, $part)
	addCss ()
	add css files to the header More...
	appendInlineCss ()
	append css styles just before </body> More...
	getHomeTitle ()
	exitLti ()
	exit LTI session and if defined redirecting to returnUrl ToDo: Standard Template with delos ... More...
	logout ()
	logout ILIAS and destroys Session and ilClientId cookie More...
	getSessionValue ($sess_key)
	get session value != '' More...

Static Public Member Functions
static	getInstance ()
	for compatiblity with ilLTIRouterGUI More...

Data Fields
const	LTI_DEBUG = false
const	MSG_ERROR = "failure"
	messsage codes More...
const	MSG_INFO = "info"
const	MSG_QUESTION = "question"
const	MSG_SUCCESS = "success"
	$show_locator = true
	public variables More...
	$member_view = false
	$member_view_url = ""
	$member_view_close_txt = ""

Protected Member Functions
	getHomeLink ()
	helper function for home link creation More...
	getCmdLink ($cmd)
	helper function for cmd link creation More...

Private Member Functions
	init ()
	Init LTI mode for lit authenticated users. More...
	isLTIUser ()
	get LTI Mode from Users->getAuthMode More...
	getNavEntries ()
	findEffectiveRefId ()
	Find effective ref_id for request. More...
	showLocator ($obj_type)
	log ($txt)

Private Attributes
	$user = null
	private variables More...
	$home_id = ""
	$home_obj_id = ""
	$home_type = ""
	$home_title = ""
	$home_url = ""
	$link_dir = ""
	$current_ref_id = ""
	$current_type = ""

Detailed Description

class for ILIAS ViewLTI

Author

Stefan Schneider <schne.nosp@m.ider.nosp@m.@hrz..nosp@m.uni-.nosp@m.marbu.nosp@m.rg.d.nosp@m.e

Version

$id$

ilLTIViewGUI: ilLTIRouterGUI

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

Constructor & Destructor Documentation

__construct()

ilLTIViewGUI::__construct

(

\ilObjUser

$user

)

Constructor.

Returns

Definition at line 70 of file class.ilLTIViewGUI.php.

References $user, deactivate(), ilContext\hasUser(), init(), isActive(), and user().

    {
        if (ilContext::hasUser()) {
            $this->user = $user;
            $this->init();
        } else {
            if ($this->isActive()) {
                $this->deactivate();
            }
        }
    }

Here is the call graph for this function:

Member Function Documentation

activate()

ilLTIViewGUI::activate

(

)

activate LTI GUI

Returns

void

Definition at line 139 of file class.ilLTIViewGUI.php.

References $_SESSION, findEffectiveRefId(), initGUI(), and log().

Referenced by init().

    {
        $this->findEffectiveRefId();
        $_SESSION['il_lti_mode'] = "1";
        $this->initGUI();
        $this->log("lti view activated");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addCss()

ilLTIViewGUI::addCss

(

)

add css files to the header

Definition at line 304 of file class.ilLTIViewGUI.php.

References array.

    {
        $arr = array();
        //$arr[] = "./Services/LTI/templates/default/hide.css";
        return $arr;
    }

appendInlineCss()

ilLTIViewGUI::appendInlineCss

(

)

append css styles just before </body>

Definition at line 314 of file class.ilLTIViewGUI.php.

References $_SESSION, and array.

    {
        $arr = array();
        $arr[] = "./Services/LTI/templates/default/lti.css";
        
        if (isset($_SESSION['lti_launch_css_url']) && $_SESSION['lti_launch_css_url'] != "") {
            $arr[] = $_SESSION['lti_launch_css_url'];
        }
        return $arr;
    }

deactivate()

ilLTIViewGUI::deactivate

(

)

deactivate LTI GUI

Returns

void

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

References $_SESSION, and log().

Referenced by __construct(), init(), and logout().

    {
        unset($_SESSION['il_lti_mode']);
        $this->log("lti view deactivated");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilLTIViewGUI::executeCommand

(

)

for ctrl commands

Definition at line 124 of file class.ilLTIViewGUI.php.

References $ilCtrl, and exitLti().

    {
        global $ilCtrl;
        $cmd = $ilCtrl->getCmd();
        switch ($cmd) {
            case 'exit':
                $this->exitLti();
            break;
        }
    }

Here is the call graph for this function:

exitLti()

ilLTIViewGUI::exitLti

(

)

exit LTI session and if defined redirecting to returnUrl ToDo: Standard Template with delos ...

Definition at line 342 of file class.ilLTIViewGUI.php.

References $_SESSION, $html, $lng, exit, getSessionValue(), header, log(), and logout().

Referenced by executeCommand().

    {
        global $lng;
        $lng->loadLanguageModule("lti");
        $this->log("exitLti");
        if ($this->getSessionValue('lti_launch_presentation_return_url') === '') {
            $tplExit = new ilTemplate("tpl.lti_exit.html", true, true, "Services/LTI");
            $tplExit->setVariable('TXT_LTI_EXITED', $lng->txt('lti_exited'));
            $tplExit->setVariable('LTI_EXITED_INFO', $lng->txt('lti_exited_info'));
            $html = $tplExit->get();
            $this->logout();
            print $html;
            exit;
        } else {
            $this->logout();
            header('Location: ' . $_SESSION['lti_launch_presentation_return_url']);
            exit;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findEffectiveRefId()

ilLTIViewGUI::findEffectiveRefId ( )

private

Find effective ref_id for request.

Definition at line 380 of file class.ilLTIViewGUI.php.

References $_GET, $target_arr, ilObject\_lookupObjectId(), ilObject\_lookupTitle(), and ilObject\_lookupType().

Referenced by activate().

    {
        if ((int) $_GET['ref_id']) {
            $this->current_type = ilObject::_lookupType($_GET['ref_id'], true);
            return $this->current_ref_id = (int) $_GET['ref_id'];
        }
        
        $target_arr = explode('_', (string) $_GET['target']);
        if (isset($target_arr[1]) and (int) $target_arr[1]) {
            $this->current_type = ilObject::_lookupType($target_arr[1], true);
            $this->home_title = ilObject::_lookupTitle(ilObject::_lookupObjectId($target_arr[1]));
            return $this->current_ref_id = (int) $target_arr[1];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCmdLink()

ilLTIViewGUI::getCmdLink (   $cmd )

protected

helper function for cmd link creation

Definition at line 407 of file class.ilLTIViewGUI.php.

References $ilCtrl, and array.

Referenced by render().

    {
        global $ilCtrl;
        $targetScript = ($ilCtrl->getTargetScript() !== 'ilias.php') ? "ilias.php" : "";
        return $this->link_dir . $targetScript . $ilCtrl->getLinkTargetByClass(array('illtiroutergui',strtolower(get_class($this))), $cmd) . "&baseClass=illtiroutergui";
    }

Here is the caller graph for this function:

getHomeLink()

ilLTIViewGUI::getHomeLink ( )

protected

helper function for home link creation

Definition at line 328 of file class.ilLTIViewGUI.php.

References $home_id.

Referenced by getNavEntries(), and initGUI().

    {
        return $this->link_dir . "goto.php?target=" . $this->home_type . "_" . $this->home_id;
    }

Here is the caller graph for this function:

getHomeTitle()

ilLTIViewGUI::getHomeTitle

(

)

Definition at line 333 of file class.ilLTIViewGUI.php.

References ilObject\_lookupTitle().

Referenced by getNavEntries(), and initGUI().

    {
        return ilObject::_lookupTitle($this->home_obj_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static ilLTIViewGUI::getInstance ( )

static

for compatiblity with ilLTIRouterGUI

Definition at line 103 of file class.ilLTIViewGUI.php.

References $DIC.

    {
        global $DIC;
        return $DIC["lti"];
    }

getNavEntries()

ilLTIViewGUI::getNavEntries ( )

private

Definition at line 245 of file class.ilLTIViewGUI.php.

References $_GET, $ilCtrl, $ilSetting, $lng, ilObject\_getIcon(), ilObject\_lookupObjId(), getHomeLink(), getHomeTitle(), ilUtil\img(), and ilUtil\shortenText().

Referenced by render().

    {
        global $lng, $ilNavigationHistory, $ilSetting, $ilCtrl;
        include_once("./Services/UIComponent/GroupedList/classes/class.ilGroupedListGUI.php");
        $gl = new ilGroupedListGUI();
        $gl->setAsDropDown(true);
        
        include_once("./Services/Link/classes/class.ilLink.php");
        
        $icon = ilUtil::img(ilObject::_getIcon((int) $this->home_obj_id, "tiny"));
        
        $gl->addEntry(
            $icon . " " . $this->getHomeTitle(),
            $this->getHomeLink(),
            "_self"
        );
        
        
        $items = $ilNavigationHistory->getItems();
        reset($items);
        $cnt = 0;
        $first = true;

        foreach ($items as $k => $item) {
            if ($cnt >= 10) {
                break;
            }
            
            if (!isset($item["ref_id"]) || !isset($_GET["ref_id"]) ||
                ($item["ref_id"] != $_GET["ref_id"] || !$first) && $this->home_id != $item["ref_id"]) { // do not list current item
                if ($cnt == 0) {
                    $gl->addGroupHeader($lng->txt("last_visited"), "ilLVNavEnt");
                }
                $obj_id = ilObject::_lookupObjId($item["ref_id"]);
                $cnt++;
                $icon = ilUtil::img(ilObject::_getIcon($obj_id, "tiny"));
                $ititle = ilUtil::shortenText(strip_tags($item["title"]), 50, true); // #11023
                $gl->addEntry($icon . " " . $ititle, $item["link"], "_self", "", "ilLVNavEnt");
            }
            $first = false;
        }
        
        if ($cnt > 0) {
            $gl->addEntry(
                "» " . $lng->txt("remove_entries"),
                "#",
                "",
                "return il.MainMenu.removeLastVisitedItems('" .
                $ilCtrl->getLinkTargetByClass("ilnavigationhistorygui", "removeEntries", "", true) . "');",
                "ilLVNavEnt"
            );
        }
        
        return $gl->getHTML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSessionValue()

ilLTIViewGUI::getSessionValue

(

$sess_key

)

get session value != ''

Parameters

$sess_key

string

Returns

string

Definition at line 420 of file class.ilLTIViewGUI.php.

References $_SESSION.

Referenced by exitLti().

    {
        if (isset($_SESSION[$sess_key]) && $_SESSION[$sess_key] != '') {
            return $_SESSION[$sess_key];
        } else {
            return '';
        }
    }

Here is the caller graph for this function:

init()

ilLTIViewGUI::init ( )

private

Init LTI mode for lit authenticated users.

Definition at line 85 of file class.ilLTIViewGUI.php.

References activate(), deactivate(), defined, isActive(), and isLTIUser().

Referenced by __construct().

    {
        $this->link_dir = (defined("ILIAS_MODULE"))
                    ? "../"
                    : "";
        if ($this->isLTIUser()) {
            $this->activate();
        } else {
            if ($this->isActive()) {
                $this->deactivate();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initGUI()

ilLTIViewGUI::initGUI

(

)

Set the environment backend for GUI (tree and locator behaviour, home link, ....) it is also possible to hide locator and treeicon, but if activated elsewhere a clean root folder is defined ToDo: conceptual discussion.

Definition at line 171 of file class.ilLTIViewGUI.php.

References $_GET, $_SESSION, $lng, ilObject\_lookupObjectId(), ilObject\_lookupType(), getHomeLink(), getHomeTitle(), log(), and showLocator().

Referenced by activate().

    {
        global $lng;
        $this->log("initGUI");
        $lng->loadLanguageModule("lti");
        $baseclass = strtolower($_GET['baseClass']);
        $cmdclass = strtolower($_GET['cmdClass']);
        
        // init home_id, home_type, home_url and home_items if not already set
        if ($this->home_id === '') {
            $this->home_id = $_SESSION['lti_context_id'];
        }
        if ($this->home_obj_id === '') {
            $this->home_obj_id = ilObject::_lookupObjectId($this->home_id);
        }
        if ($this->home_type === '') {
            $this->home_type = ilObject::_lookupType($this->home_id, true);
            $this->show_locator = $this->showLocator($this->home_type);
        }
        if ($this->home_url === '') {
            $this->home_url = $this->getHomeLink();
        }
        if ($this->home_title === '') {
            $this->home_title = $this->getHomeTitle();
        }
    
        switch ($baseclass) {
            case 'illtiroutergui':
                return;
                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isActive()

ilLTIViewGUI::isActive

(

)

LTI is active.

Returns

boolean

Definition at line 161 of file class.ilLTIViewGUI.php.

References $_SESSION.

Referenced by __construct(), and init().

    {
        return (isset($_SESSION['il_lti_mode']));
    }

Here is the caller graph for this function:

isLTIUser()

ilLTIViewGUI::isLTIUser ( )

private

get LTI Mode from Users->getAuthMode

Returns

boolean

Definition at line 113 of file class.ilLTIViewGUI.php.

References user().

Referenced by init().

    {
        if (!$this->user instanceof ilObjUser) {
            return false;
        }
        return (strpos($this->user->getAuthMode(), 'lti_') === 0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

log()

ilLTIViewGUI::log (   $txt )

private

Definition at line 429 of file class.ilLTIViewGUI.php.

References $DIC, and $txt.

Referenced by activate(), deactivate(), exitLti(), and initGUI().

    {
        global $DIC;
        if (self::LTI_DEBUG) {
            $DIC->logger()->lti()->write($txt);
        }
    }

Here is the caller graph for this function:

logout()

ilLTIViewGUI::logout

(

)

logout ILIAS and destroys Session and ilClientId cookie

Definition at line 365 of file class.ilLTIViewGUI.php.

References $_COOKIE, $client_id, $GLOBALS, deactivate(), ilSession\SESSION_CLOSE_USER, ilSession\setClosingContext(), and ilUtil\setCookie().

Referenced by exitLti().

    {
        //$DIC->logger()->root()->debug("logout");
        $this->deactivate();
        ilSession::setClosingContext(ilSession::SESSION_CLOSE_USER);
        //$this->dic['ilAuthSession']->logout();
        $GLOBALS['DIC']['ilAuthSession']->logout();
        // reset cookie
        $client_id = $_COOKIE["ilClientId"];
        ilUtil::setCookie("ilClientId", "");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilLTIViewGUI::render	(		$tpl,
			$part
	)

Definition at line 204 of file class.ilLTIViewGUI.php.

References $DIC, $lng, $tpl, getCmdLink(), and getNavEntries().

    {
        global $lng, $DIC;
        $lng->loadLanguageModule("lti");
        $f = $DIC->ui()->factory();
        $renderer = $DIC->ui()->renderer();
        switch ($part) {
            case 'top_bar_header':
                if (!$this->member_view) {
                    if (!$tpl->blockExists("header_top_title")) {
                        $tpl->addBlockFile("HEADER_TOP_TITLE", "header_top_title", "tpl.header_top_title.html", "Services/LTI");
                    }
                    $tpl->setVariable("TXT_HEADER_TITLE", $lng->txt("lti_session"));
                } else {
                    if (!$tpl->blockExists("header_back_bl")) {
                        $tpl->addBlockFile("HEADER_BACK_BL", "header_back_bl", "tpl.header_back_bl.html", "Services/LTI");
                    }
                    $tpl->setVariable("URL_HEADER_BACK", $this->member_view_url);
                    //$tpl->setVariable("TXT_HEADER_BACK", $lng->txt("lti_back_to_home")); // ToDo: $lng variable
                    $tpl->setVariable("TXT_HEADER_BACK", $this->member_view_close_txt); // ToDo: $lng variable
                }
                break;
            case 'view_nav':
                $tpl->setVariable("TXT_VIEW_NAV", $lng->txt("lti_navigation")); // ToDo: language files
                $nav_entries = $this->getNavEntries();
                $tpl->setVariable("VIEW_NAV_EN", $nav_entries);
                
                break;
            case 'user_logged_in':
                if (!$tpl->blockExists("userisloggedin")) {
                    $tpl->addBlockFile("USERLOGGEDIN", "userisloggedin", "tpl.user_logged_in.html", "Services/LTI");
                }
                $tpl->setVariable("LINK_LTI_EXIT", $this->getCmdLink('exit'));
                $tpl->setVariable("TXT_LTI_EXIT", $lng->txt("lti_exit"));
                $btn = $f->button()->close();
                $btnHtml = $renderer->render($btn);
                $tpl->setVariable("EXIT_BUTTON", $btnHtml);
                break;
        }
    }

Here is the call graph for this function:

showLocator()

ilLTIViewGUI::showLocator (   $obj_type )

private

Returns

bool

Definition at line 398 of file class.ilLTIViewGUI.php.

Referenced by initGUI().

    {
        //return true;
        return preg_match("/(crs|grp|cat|root|fold|lm)/", $obj_type);
    }

Here is the caller graph for this function:

Field Documentation

$current_ref_id

ilLTIViewGUI::$current_ref_id = ""

private

Definition at line 55 of file class.ilLTIViewGUI.php.

$current_type

ilLTIViewGUI::$current_type = ""

private

Definition at line 56 of file class.ilLTIViewGUI.php.

$home_id

ilLTIViewGUI::$home_id = ""

private

Definition at line 49 of file class.ilLTIViewGUI.php.

Referenced by getHomeLink().

$home_obj_id

ilLTIViewGUI::$home_obj_id = ""

private

Definition at line 50 of file class.ilLTIViewGUI.php.

$home_title

ilLTIViewGUI::$home_title = ""

private

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

$home_type

ilLTIViewGUI::$home_type = ""

private

Definition at line 51 of file class.ilLTIViewGUI.php.

$home_url

ilLTIViewGUI::$home_url = ""

private

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

$link_dir

ilLTIViewGUI::$link_dir = ""

private

Definition at line 54 of file class.ilLTIViewGUI.php.

$member_view

ilLTIViewGUI::$member_view = false

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

$member_view_close_txt

ilLTIViewGUI::$member_view_close_txt = ""

Definition at line 64 of file class.ilLTIViewGUI.php.

$member_view_url

ilLTIViewGUI::$member_view_url = ""

Definition at line 63 of file class.ilLTIViewGUI.php.

$show_locator

ilLTIViewGUI::$show_locator = true

public variables

Definition at line 61 of file class.ilLTIViewGUI.php.

$user

ilLTIViewGUI::$user = null

private

private variables

Definition at line 48 of file class.ilLTIViewGUI.php.

Referenced by __construct().

LTI_DEBUG

const ilLTIViewGUI::LTI_DEBUG = false

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

MSG_ERROR

const ilLTIViewGUI::MSG_ERROR = "failure"

messsage codes

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

MSG_INFO

const ilLTIViewGUI::MSG_INFO = "info"

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

MSG_QUESTION

const ilLTIViewGUI::MSG_QUESTION = "question"

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

MSG_SUCCESS

const ilLTIViewGUI::MSG_SUCCESS = "success"

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

---

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

• Services/LTI/classes/class.ilLTIViewGUI.php