ilMainMenuGUI Class Reference

Handles display of the main menu. More...

Collaboration diagram for ilMainMenuGUI:

Public Member Functions
	ilMainMenuGUI ($a_target="_top", $a_use_start_template=false)
	setSmallMode ($a_small)
	setActive ($a_active)
	setTemplate (&$tpl)
	set output template
	getTemplate ()
	get output template
	addMenuBlock ($a_var="CONTENT", $a_block="navigation")
	add menu template as block
	setTemplateVars ()
	set all template variables (images, scripts, target frames, ...)
	getScriptTarget ($a_script)
	generates complete script target (private)
	_checkAdministrationPermission ()
	getHTML ()

Data Fields
	$ilias
	$tpl
	$target
	$start_template

Protected Member Functions
	getMemberViewHTML ()

Detailed Description

Handles display of the main menu.

Author

Alex Killing

Version

Id:

class.ilMainMenuGUI.php 27915 2011-03-02 12:59:41Z akordosz

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

Member Function Documentation

ilMainMenuGUI::_checkAdministrationPermission

(

)

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

References ilUtil\_getObjectsByOperations().

Referenced by ilObjForumGUI\createObject(), ilAdministrationGUI\executeCommand(), and setTemplateVars().

        {
                global $rbacsystem;

                if($rbacsystem->checkAccess("visible,read", SYSTEM_FOLDER_ID))
                {
                        return true;
                }
                return false;
                // Allow all local admins to use the administration
                return count(ilUtil::_getObjectsByOperations('cat','cat_administrate_users')) ? true : false;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMainMenuGUI::addMenuBlock	(		$a_var = "CONTENT",
			$a_block = "navigation"
	)

add menu template as block

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

        {
                echo "ilMainMenu->addMenuBlick is deprecated. Use getHTML instead.";
                return;
                $this->tpl->addBlockFile($a_var, $a_block, "tpl.main_buttons.html");
        }

ilMainMenuGUI::getHTML

(

)

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

References ilMemberViewSettings\getInstance(), getMemberViewHTML(), and setTemplateVars().

        {
                include_once './Services/Container/classes/class.ilMemberViewSettings.php';
                $set = ilMemberViewSettings::getInstance();
                
                if($set->isActive())
                {
                        return $this->getMemberViewHTML();
                }
                
                
                $this->setTemplateVars();
                return $this->tpl->get();
        }

Here is the call graph for this function:

ilMainMenuGUI::getMemberViewHTML ( )

protected

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

References $_GET, $lng, ilLink\_getLink(), ilObject\_lookupObjId(), ilObject\_lookupType(), and ilUtil\getImagePath().

Referenced by getHTML().

        {
                global $lng;
                
                $this->tpl = new ilTemplate('tpl.member_view_main_menu.html',true,true,'Services/MainMenu');
                
                $this->tpl->setVariable('TXT_MM_HEADER',$lng->txt('mem_view_long'));
                $this->tpl->setVariable('TXT_MM_CLOSE_PREVIEW',$lng->txt('mem_view_close'));
                $this->tpl->setVariable('MM_CLOSE_IMG',ilUtil::getImagePath('cancel.gif'));

                include_once './classes/class.ilLink.php';
                
                $this->tpl->setVariable(
                        'HREF_CLOSE_MM',
                        ilLink::_getLink(
                                (int) $_GET['ref_id'],
                                ilObject::_lookupType(ilObject::_lookupObjId((int) $_GET['ref_id'])),
                                array('mv' => 0)));
                
                return $this->tpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMainMenuGUI::getScriptTarget

(

$a_script

)

generates complete script target (private)

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

References $ilias.

Referenced by setTemplateVars().

        {
                global $ilias;

                $script = "./".$a_script;

                //if ($this->start_template == true)
                //{
                        //if(is_file("./templates/".$ilias->account->skin."/tpl.start.html"))
                        //{
        //                      $script = "./start.php?script=".rawurlencode($script);
                        //}
                //}
                if (defined("ILIAS_MODULE"))
                {
                        $script = ".".$script;
                }
                return $script;
        }

Here is the caller graph for this function:

ilMainMenuGUI::getTemplate

(

)

get output template

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

        {
                echo "ilMainMenu->getTemplate is deprecated. Use getHTML instead.";
                return;
        }

ilMainMenuGUI::ilMainMenuGUI	(		$a_target = "_top",
			$a_use_start_template = false
	)

Parameters

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

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

References $ilias.

        {
                global $ilias;
                
                
                $this->tpl = new ilTemplate("tpl.main_menu.html", true, true,
                        "Services/MainMenu");
                $this->ilias =& $ilias;
                $this->target = $a_target;
                $this->start_template = $a_use_start_template;
                $this->small = false;
        }

ilMainMenuGUI::setActive

(

$a_active

)

Parameters

string

$a_active

"desktop"|"repository"|"search"|"mail"|"chat_invitation"|"administration"

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

        {
                $this->active = $a_active;
        }

ilMainMenuGUI::setSmallMode

(

$a_small

)

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

        {
                $this->small = $a_small;
        }

ilMainMenuGUI::setTemplate

(

&

$tpl

)

set output template

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

References $tpl.

        {
                echo "ilMainMenu->setTemplate is deprecated. Use getHTML instead.";
                return;
                $this->tpl =& $tpl;
        }

ilMainMenuGUI::setTemplateVars

(

)

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

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

References $_GET, $_SESSION, $ilias, $ilSetting, $lng, $nav_hist, $title, $type, _checkAdministrationPermission(), ilMailbox\_countNewMails(), ilObjSystemFolder\_getHeaderTitle(), ilGeneralSettings\_getInstance(), ilSearchSettings\_getSearchSettingRefId(), ilLink\_getStaticLink(), ilLanguage\_lookupEntry(), ilObject\_lookupObjId(), ilRegistrationSettings\_lookupRegistrationType(), ilObject\_lookupType(), ilUtil\appendUrlParameterString(), ilUtil\getImagePath(), getScriptTarget(), ilUtil\getStyleSheetLocation(), and IL_REG_DISABLED.

Referenced by getHTML().

        {
                global $rbacsystem, $lng, $ilias, $tree, $ilUser, $ilSetting;

                
                // navigation history
                require_once("Services/Navigation/classes/class.ilNavigationHistoryGUI.php");
                $nav_hist = new ilNavigationHistoryGUI();
                $nav_html = $nav_hist->getHTML();

                if ($nav_html != "")
                {

                        $this->tpl->setCurrentBlock("nav_history");
                        $this->tpl->setVariable("TXT_LAST_VISITED", $lng->txt("last_visited"));
                        $this->tpl->setVariable("NAVIGATION_HISTORY", $nav_html);
                        $this->tpl->parseCurrentBlock();
                }

                // administration button
                if(ilMainMenuGUI::_checkAdministrationPermission())
                {
                        $this->tpl->setCurrentBlock("userisadmin");
                        $this->tpl->setVariable("IMG_ADMIN", ilUtil::getImagePath("navbar/admin.gif", false));
                        $this->tpl->setVariable("IMG_SPACE_ADMIN", ilUtil::getImagePath("spacer.gif", false));
                        $this->tpl->setVariable("TXT_ADMINISTRATION", $lng->txt("administration"));
                        $this->tpl->setVariable("SCRIPT_ADMIN", $this->getScriptTarget("ilias.php?baseClass=ilAdministrationGUI"));
                        $this->tpl->setVariable("TARGET_ADMIN", $this->target);
                        if ($this->active == "administration")
                        {
                                $this->tpl->setVariable("MM_CLASS", "MMActive");
                                $this->tpl->setVariable("SEL", '<span class="ilAccHidden">('.$lng->txt("stat_selected").')</span>');
                        }
                        else
                        {
                                $this->tpl->setVariable("MM_CLASS", "MMInactive");
                        }
                        $this->tpl->parseCurrentBlock();
                }

                // search
                include_once 'Services/Search/classes/class.ilSearchSettings.php';
                if($rbacsystem->checkAccess('search',ilSearchSettings::_getSearchSettingRefId()))
                {
                        $this->tpl->setCurrentBlock("searchbutton");
                        $this->tpl->setVariable("SCRIPT_SEARCH",$this->getScriptTarget('ilias.php?baseClass=ilSearchController'));
                        $this->tpl->setVariable("TARGET_SEARCH",$this->target);
                        $this->tpl->setVariable("TXT_SEARCH", $lng->txt("search"));
                        if ($this->active == "search")
                        {
                                $this->tpl->setVariable("MM_CLASS", "MMActive");
                                $this->tpl->setVariable("SEL", '<span class="ilAccHidden">('.$lng->txt("stat_selected").')</span>');
                        }
                        else
                        {
                                $this->tpl->setVariable("MM_CLASS", "MMInactive");
                        }
                        $this->tpl->parseCurrentBlock();
                        
                        include_once './Services/Search/classes/class.ilMainMenuSearchGUI.php';
                        $main_search = new ilMainMenuSearchGUI();
                        if(strlen($html = $main_search->getHTML()))
                        {
                                $this->tpl->setVariable('SEARCHBOX',$html);
                        }
                }
                
                
                // webshop
                include_once 'payment/classes/class.ilGeneralSettings.php';
                if((bool)ilGeneralSettings::_getInstance()->get('shop_enabled'))
                {
                        $this->tpl->setCurrentBlock('shopbutton');
                        $this->tpl->setVariable('SCRIPT_SHOP', $this->getScriptTarget('ilias.php?baseClass=ilShopController&cmd=clearFilter'));
                        $this->tpl->setVariable('TARGET_SHOP', $this->target);                  
                        
                        include_once 'payment/classes/class.ilPaymentShoppingCart.php';
                        $objShoppingCart = new ilPaymentShoppingCart($ilUser);
                        $items = $objShoppingCart->getEntries();
                        
                        $this->tpl->setVariable('TXT_SHOP', $lng->txt('shop').(count($items) > 0 ? ' ('.count($items).')' : ''));                       
                        
                        if($this->active == 'shop')
                        {
                                $this->tpl->setVariable('MM_CLASS', 'MMActive');
                                $this->tpl->setVariable("SEL", '<span class="ilAccHidden">('.$lng->txt("stat_selected").')</span>');
                        }
                        else
                        {
                                $this->tpl->setVariable('MM_CLASS', 'MMInactive');
                        }
                        $this->tpl->parseCurrentBlock();
                }

                // help button
                //$this->tpl->setCurrentBlock("userhelp");
                //$this->tpl->setVariable("TXT_HELP", $lng->txt("help"));
                //$this->tpl->setVariable("SCRIPT_HELP", "ilias.php?baseClass=ilHelpGUI");
                //$this->tpl->setVariable("TARGET_HELP", "ilias_help");
                //$this->tpl->parseCurrentBlock();

                $this->tpl->setVariable("IMG_SPACE", ilUtil::getImagePath("spacer.gif", false));
                
                // mail & desktop button
                if ($_SESSION["AccountId"] != ANONYMOUS_USER_ID)
                {
                        $this->tpl->setCurrentBlock("desktopbutton");
                        $this->tpl->setVariable("IMG_DESK", ilUtil::getImagePath("navbar/desk.gif", false));
                        $this->tpl->setVariable("IMG_SPACE_DESK", ilUtil::getImagePath("spacer.gif", false));
                        $this->tpl->setVariable("TXT_PERSONAL_DESKTOP", $lng->txt("personal_desktop"));
                        #$this->tpl->setVariable("SCRIPT_DESK", $this->getScriptTarget("ilias.php?baseClass=ilPersonalDesktopGUI&PDHistory=1"));
                        $this->tpl->setVariable("SCRIPT_DESK", $this->getScriptTarget("ilias.php?baseClass=ilPersonalDesktopGUI"));
                        $this->tpl->setVariable("TARGET_DESK", $this->target);
                        if ($this->active == "desktop")
                        {
                                $this->tpl->setVariable("MM_CLASS", "MMActive");
                                $this->tpl->setVariable("SEL", '<span class="ilAccHidden">('.$lng->txt("stat_selected").')</span>');
                        }
                        else
                        {
                                $this->tpl->setVariable("MM_CLASS", "MMInactive");
                        }
                        $this->tpl->parseCurrentBlock();

                        include_once "Services/Mail/classes/class.ilMail.php";
                        
                        $mail = new ilMail($_SESSION["AccountId"]);

                        if( $rbacsystem->checkAccess('mail_visible', $mail->getMailObjectReferenceId()) )
                        {
                                $link = "ilias.php?baseClass=ilMailGUI";
                                $add = '';
                                
                                if( $new_mails = ilMailbox::_countNewMails($_SESSION["AccountId"]) )
                                {
                                        $mail = new ilMail($_SESSION['AccountId']);
                                        $add = " ".sprintf($lng->txt("cnt_new"), $new_mails);
                                }
                                
                                $this->tpl->setCurrentBlock("mailbutton");
                                $this->tpl->setVariable("IMG_MAIL", ilUtil::getImagePath("navbar/mail.gif", false));
                                $this->tpl->setVariable("IMG_SPACE_MAIL", ilUtil::getImagePath("spacer.gif", false));
                                $this->tpl->setVariable("TXT_MAIL", $lng->txt("mail").$add);
                                $this->tpl->setVariable("SCRIPT_MAIL", $this->getScriptTarget($link));
                                $this->tpl->setVariable("TARGET_MAIL", $this->target);
                                if ($this->active == "mail")
                                {
                                        $this->tpl->setVariable("MM_CLASS", "MMActive");
                                        $this->tpl->setVariable("SEL", '<span class="ilAccHidden">('.$lng->txt("stat_selected").')</span>');
                                }
                                else
                                {
                                        $this->tpl->setVariable("MM_CLASS", "MMInactive");
                                }
                                $this->tpl->parseCurrentBlock();                                
                        }
                }
                
                // chat messages
                if ($ilSetting->get('chat_message_notify_status') == 1 && $_REQUEST['baseClass'] != 'ilChatPresentationGUI' && $ilUser->getPref('chat_message_notify_status') == 1) {
                        include_once 'Modules/Chat/classes/class.ilChatMessageNotifyGUI.php';
                        $msg_notify = new ilChatMessageNotifyGUI();
                        $html = $msg_notify->getHtml();
                        if ($html) {
                                $this->tpl->setCurrentBlock("chat_lastmsg");
                                $this->tpl->setVariable('CHAT_LAST_MESSAGE', $html);
                                $this->tpl->parseCurrentBlock();
                        }
                        
                }
                
                // chat invitations
                include_once 'Modules/Chat/classes/class.ilChatInvitationGUI.php';
                $chat_invitation_gui = new ilChatInvitationGUI();
                $chat_invitation_html = $chat_invitation_gui->getHTML();
                if(trim($chat_invitation_html) != '')
                {
                        $this->tpl->setCurrentBlock('chatbutton');
                        $this->tpl->setVariable('CHAT_INVITATIONS', $chat_invitation_html);
                        $this->tpl->parseCurrentBlock();
                }               

                // repository link              
                $this->tpl->setCurrentBlock("rep_button");
#               $this->tpl->setVariable("SCRIPT_CATALOG",'goto__target__root_1__client__ilias38.html');
#                       #$this->getScriptTarget("repository.php?cmd=frameset&getlast=true"));

                include_once('classes/class.ilLink.php');
                $this->tpl->setVariable('SCRIPT_CATALOG',ilLink::_getStaticLink(1,'root',true));
                $nd = $tree->getNodeData(ROOT_FOLDER_ID);
                $title = $nd["title"];
                if ($title == "ILIAS")
                {
                        $title = $lng->txt("repository");
                }
                $this->tpl->setVariable("TXT_CATALOG", $title);
                if ($this->active == "repository" || $this->active == "")
                {
                        $this->tpl->setVariable("MM_CLASS", "MMActive");
                        $this->tpl->setVariable("SEL", '<span class="ilAccHidden">('.$lng->txt("stat_selected").')</span>');
                }
                else
                {
                        $this->tpl->setVariable("MM_CLASS", "MMInactive");
                }
                // set target frame
                $this->tpl->setVariable("TARGET", $this->target);
                $this->tpl->parseCurrentBlock();
                

                $link_dir = (defined("ILIAS_MODULE"))
                        ? "../"
                        : "";

                if (!$this->small)
                {
        
                        // login stuff
                        if ($_SESSION["AccountId"] == ANONYMOUS_USER_ID)
                        {
                                include_once 'Services/Registration/classes/class.ilRegistrationSettingsGUI.php';
                                if (ilRegistrationSettings::_lookupRegistrationType() != IL_REG_DISABLED)
                                {
                                        $this->tpl->setCurrentBlock("registration_link");
                                        $this->tpl->setVariable("TXT_REGISTER",$lng->txt("register"));
                                        $this->tpl->setVariable("LINK_REGISTER", $link_dir."register.php?client_id=".rawurlencode(CLIENT_ID)."&lang=".$ilias->account->getCurrentLanguage());
                                        $this->tpl->parseCurrentBlock();
                                }
        
                                // language selection
                                include_once("./Services/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
                                $selection = new ilAdvancedSelectionListGUI();
                                $selection->setFormSelectMode("change_lang_to", "ilLanguageSelection", true,
                                        "#", "ilNavHistory", "ilNavHistoryForm",
                                        "_top", $lng->txt("ok"), "ilLogin");
                                //$selection->setListTitle($lng->txt("choose_language"));
                                $selection->setListTitle($lng->txt("language"));
                                $selection->setItemLinkClass("small");
                                $languages = $lng->getInstalledLanguages();
                //var_dump($_SERVER);
                                foreach ($languages as $lang_key)
                                {
                                        $base = substr($_SERVER["REQUEST_URI"], strrpos($_SERVER["REQUEST_URI"], "/") + 1);
                                        $base = str_replace("lang=", "", $base);
                                        $link = ilUtil::appendUrlParameterString($base,
                                                "lang=".$lang_key);
                                        $selection->addItem(ilLanguage::_lookupEntry($lang_key, "meta", "meta_l_".$lang_key),
                                                $lang_key, $link, "", "", "_top");
                                }
                                if (count($languages) > 0)
                                {
                                        $this->tpl->setVariable("LANG_SELECT", $selection->getHTML());
                                }
        
                                $this->tpl->setCurrentBlock("userisanonymous");
                                $this->tpl->setVariable("TXT_NOT_LOGGED_IN",$lng->txt("not_logged_in"));
                                $this->tpl->setVariable("TXT_LOGIN",$lng->txt("log_in"));
                                
                                $target_str = "";
                                if ($_GET["ref_id"] != "")
                                {
                                        if ($tree->isInTree($_GET["ref_id"]) && $_GET["ref_id"] != $tree->getRootId())
                                        {
                                                $obj_id = ilObject::_lookupObjId($_GET["ref_id"]);
                                                $type = ilObject::_lookupType($obj_id);
                                                $target_str = $type."_".$_GET["ref_id"];
                                        }
                                }
                                $this->tpl->setVariable("LINK_LOGIN",
                                        $link_dir."login.php?target=".$target_str."&client_id=".rawurlencode(CLIENT_ID)."&cmd=force_login&lang=".$ilias->account->getCurrentLanguage());
                                $this->tpl->parseCurrentBlock();
                        }
                        else
                        {
                                $this->tpl->setCurrentBlock("userisloggedin");
                                $this->tpl->setVariable("TXT_LOGIN_AS",$lng->txt("login_as"));
                                $this->tpl->setVariable("TXT_LOGOUT2",$lng->txt("logout"));
                                $this->tpl->setVariable("LINK_LOGOUT2", $link_dir."logout.php?lang=".$ilias->account->getCurrentLanguage());
                                $this->tpl->setVariable("USERNAME",$ilias->account->getFullname());
                                $this->tpl->parseCurrentBlock();
                        }
        
        
                        $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        
                        $this->tpl->setVariable("TXT_LOGOUT", $lng->txt("logout"));
                        $this->tpl->setVariable("HEADER_ICON", ilUtil::getImagePath("HeaderIcon.png"));
                        $this->tpl->setVariable("HEADER_BG_IMAGE", ilUtil::getImagePath("HeaderBackground.gif"));
                        include_once("./Modules/SystemFolder/classes/class.ilObjSystemFolder.php");
                        $this->tpl->setVariable("TXT_HEADER_TITLE", ilObjSystemFolder::_getHeaderTitle());
        
                        // set link to return to desktop, not depending on a specific position in the hierarchy
                        //$this->tpl->setVariable("SCRIPT_START", $this->getScriptTarget("start.php"));
                }
                else
                {
                        $this->tpl->setVariable("HEADER_ICON", ilUtil::getImagePath("HeaderIcon.png"));
                }

                $this->tpl->setVariable("TXT_MAIN_MENU", $lng->txt("main_menu"));
                
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

ilMainMenuGUI::$ilias

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

Referenced by getScriptTarget(), ilMainMenuGUI(), and setTemplateVars().

ilMainMenuGUI::$start_template

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

ilMainMenuGUI::$target

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

ilMainMenuGUI::$tpl

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

Referenced by setTemplate().

---

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

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