LTI\ilMainMenuGUI Class Reference

Handles display of the main menu for LTI. More...

Inheritance diagram for LTI\ilMainMenuGUI:

Collaboration diagram for LTI\ilMainMenuGUI:

Public Member Functions
	__construct ($a_target="_top", $a_use_start_template=false, $a_main_tpl=null)
	getSpacerClass ()
	getHTML ()
Public Member Functions inherited from ilMainMenuGUI
	__construct ($a_target="_top", $a_use_start_template=false, ilTemplate $a_main_tpl=null)
	setMode (int $a_value)
	getMode ()
	setTopBarBack ($a_url, $a_caption=null)
	getSpacerClass ()
	setActive ($a_active)
	setLoginTargetPar ($a_val)
	getLoginTargetPar ()
	getHTML ()
	renderAwareness ()
	Render awareness tool. More...
	showLogoOnly (bool $a_value)
	Toggle rendering of main menu, search, user info. More...

Private Member Functions
	setTemplateVars ()
	set all template variables (images, scripts, target frames, ...) More...
	log ($txt)

Additional Inherited Members
Static Public Member Functions inherited from ilMainMenuGUI
static	getLanguageSelection ($a_in_topbar=false)
static	_checkAdministrationPermission ()
Data Fields inherited from ilMainMenuGUI
	$tpl
	$target
	$start_template
	$mail
const	MODE_FULL = 1
const	MODE_TOPBAR_ONLY = 2
const	MODE_TOPBAR_REDUCED = 3
const	MODE_TOPBAR_MEMBERVIEW = 4
Protected Member Functions inherited from ilMainMenuGUI
	initMemberView ()
	addToolbarTooltip (string $element_id, string $help_id)
	Add toolbar tooltip. More...
Protected Attributes inherited from ilMainMenuGUI
	$rbacsystem
	$user
	$lng
	$plugin_admin
	$tree
	$access
	$nav_history
	$settings
	$ctrl
	$help
	$main_tpl
	$mode
	$topbar_back_url
	$topbar_back_caption

Detailed Description

Handles display of the main menu for LTI.

Author

Stefan Schneider

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

LTI\ilMainMenuGUI::__construct	(		$a_target = "_top",
			$a_use_start_template = false,
			$a_main_tpl = null
	)

Parameters

string	$a_target	target frame
boolean	$a_use_start_template	true means: target scripts should be called through start template

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

References $DIC, $ilLog, $ilUser, ilMainMenuGUI\$lng, ilMainMenuGUI\$rbacsystem, $url, ilLink\_getLink(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilMemberViewSettings\getInstance(), Monolog\Handler\mail(), ilMainMenuGUI\setMode(), settings(), and user().

    {
        global $ilias, $rbacsystem, $ilUser, $ilLog, $DIC, $lng;
        
        if ($a_main_tpl != null) {
            $this->main_tpl = $a_main_tpl;
        } else {
            $this->main_tpl = $DIC["tpl"];
        }
        
        $this->rbacsystem = $DIC->rbac()->system();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->plugin_admin = $DIC["ilPluginAdmin"];
        $this->tree = $DIC->repositoryTree();
        $this->access = $DIC->access();
        $this->nav_history = $DIC["ilNavigationHistory"];
        $this->settings = $DIC->settings();
        $this->ctrl = $DIC->ctrl();
        $this->help = $DIC["ilHelp"];
        $this->ui = $DIC->ui();
        $rbacsystem = $DIC->rbac()->system();
        $ilUser = $DIC->user();
        
        $this->tpl = new ilTemplate(
            "tpl.main_menu.html",
            true,
            true,
            "Services/LTI"
        );
        
        $this->target = $a_target;
        $this->start_template = $a_use_start_template;
        
        $this->mail = false;
        
        $this->setMode(self::MODE_FULL);
        
        // member view
        include_once './Services/Container/classes/class.ilMemberViewSettings.php';
        $set = ilMemberViewSettings::getInstance();
        if ($set->isActive()) {
            $ref_id = ilMemberViewSettings::getInstance()->getCurrentRefId();

            if (!$ref_id) {
                $DIC["lti"]->member_view = false;
                $DIC["lti"]->member_view_url = "";
                return;
            }
            include_once './Services/Link/classes/class.ilLink.php';
            $url = ilLink::_getLink(
                $ref_id,
                ilObject::_lookupType(ilObject::_lookupObjId($ref_id)),
                array('mv' => 0)
            );
            $DIC["lti"]->member_view = true;
            $DIC["lti"]->member_view_url = $url;
            $DIC["lti"]->member_view_close_txt = $lng->txt('mem_view_close');
        } else {
            $DIC["lti"]->member_view = false;
            $DIC["lti"]->member_view_url = "";
        }
    }

Here is the call graph for this function:

Member Function Documentation

getHTML()

LTI\ilMainMenuGUI::getHTML

(

)

Deprecated:

Returns

string

Exceptions

ilTemplateException

Definition at line 116 of file class.ilMainMenuGUI.php.

References ilMainMenuGUI\setTemplateVars().

    {
        $this->setTemplateVars();

        return $this->tpl->get();
    }

Here is the call graph for this function:

getSpacerClass()

LTI\ilMainMenuGUI::getSpacerClass

(

)

Definition at line 106 of file class.ilMainMenuGUI.php.

    {
        return "ilFixedTopSpacerBarOnly";
    }

log()

LTI\ilMainMenuGUI::log (   $txt )

private

Definition at line 160 of file class.ilMainMenuGUI.php.

References $DIC, and $txt.

    {
        global $DIC;
        $DIC->logger()->lti()->write($txt);
    }

setTemplateVars()

LTI\ilMainMenuGUI::setTemplateVars ( )

private

set all template variables (images, scripts, target frames, ...)

Definition at line 127 of file class.ilMainMenuGUI.php.

References $DIC, $ilSetting, $ilUser, ilMainMenuGUI\$lng, ilMainMenuGUI\$rbacsystem, ilMainMenuGUI\$tree, and ilUtil\getStyleSheetLocation().

    {
        global $DIC, $rbacsystem, $lng, $ilias, $tree, $ilUser, $ilSetting, $ilPluginAdmin;
        //$DIC["lti"]->log("setTemplateVars in ilMainMenu");
        // append internal and external LTI css just before </body> end-tag
        $view = $DIC["lti"];
        if ($this->main_tpl->blockExists('view_append_inline_css')) {
            $css_html = "";
            $css = $view->appendInlineCss();
            foreach ($css as $cssfile) {
                $css_html .= "<style type=\"text/css\">\n";
                $css_html .= file_get_contents($cssfile);
                $css_html .= "</style>\n";
            }
            $this->main_tpl->setCurrentBlock("view_append_inline_css");
            $this->main_tpl->setVariable("APPEND_STYLES", $css_html);
            $this->main_tpl->parseCurrentBlock();
        }
        $view->render($this->tpl, 'top_bar_header');
        if (!$view->member_view) {
            $view->render($this->tpl, 'view_nav');
            $view->render($this->tpl, 'user_logged_in');
        } else {
            $this->tpl->setVariable("TOPBAR_CLASS", " ilMemberViewMainHeader");
            $this->tpl->setVariable("MEMBER_VIEW_INFO", $lng->txt("mem_view_long"));
        }
        //$view->checkMessages();
        $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        include_once("./Modules/SystemFolder/classes/class.ilObjSystemFolder.php");
        $this->tpl->setVariable("TXT_MAIN_MENU", $lng->txt("main_menu"));
        $this->tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

---

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

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