Add a search box to main menu. More...

Collaboration diagram for ilMainMenuSearchGUI:

Public Member Functions
	__construct ()

	getHTML ()

Protected Member Functions
	initRefIdFromQuery ()

Protected Attributes
ilTemplate	$tpl = null

ilLanguage	$lng

ilTree	$tree

ilCtrl	$ctrl

ilObjUser	$user

Private Attributes
GlobalHttpState	$http

Factory	$refinery

int	$ref_id

bool	$isContainer = true

Detailed Description

Add a search box to main menu.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 32 of file class.ilMainMenuSearchGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMainMenuSearchGUI::__construct ( )

Definition at line 47 of file class.ilMainMenuSearchGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initRefIdFromQuery(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule("search");
         $this->tree = $DIC->repositoryTree();
         $this->ctrl = $DIC->ctrl();
         $this->user = $DIC->user();
 
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $DIC['tpl']->addJavascript('Services/Search/js/SearchMainMenu.js');
 
         $this->initRefIdFromQuery();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getHTML()

ilMainMenuSearchGUI::getHTML ( )

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

References ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ilSearchSettings\getInstance(), ilUtil\img(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), ILIAS\Repository\lng(), ROOT_FOLDER_ID, ilSearchControllerGUI\TYPE_USER_SEARCH, and ILIAS\Repository\user().

                              : string
     {
         iljQueryUtil::initjQuery();
         iljQueryUtil::initjQueryUI();
 
         $this->tpl = new ilTemplate('tpl.main_menu_search.html', true, true, 'Services/Search');
         if ($this->user->getId() != ANONYMOUS_USER_ID) {
             $this->tpl->setVariable('LABEL_SEARCH_OPTIONS', $this->lng->txt("label_search_options"));
             if (ilSearchSettings::getInstance()->isLuceneUserSearchEnabled() || ($this->ref_id != ROOT_FOLDER_ID)) {
                 $this->tpl->setCurrentBlock("position");
                 $this->tpl->setVariable('TXT_GLOBALLY', $this->lng->txt("search_globally"));
                 $this->tpl->setVariable('ROOT_ID', ROOT_FOLDER_ID);
                 $this->tpl->parseCurrentBlock();
             } else {
                 $this->tpl->setCurrentBlock("position_hid");
                 $this->tpl->setVariable('ROOT_ID_HID', ROOT_FOLDER_ID);
                 $this->tpl->parseCurrentBlock();
             }
             if ($this->ref_id != ROOT_FOLDER_ID) {
                 $this->tpl->setCurrentBlock('position_rep');
                 $this->tpl->setVariable('TXT_CURRENT_POSITION', $this->lng->txt("search_at_current_position"));
                 $this->tpl->setVariable('REF_ID', $this->ref_id);
                 $this->tpl->parseCurrentBlock();
             }
         }
 
         if ($this->user->getId() != ANONYMOUS_USER_ID && ilSearchSettings::getInstance()->isLuceneUserSearchEnabled()) {
             $this->tpl->setCurrentBlock('usr_search');
             $this->tpl->setVariable('TXT_USR_SEARCH', $this->lng->txt('search_users'));
             $this->tpl->setVariable('USER_SEARCH_ID', ilSearchControllerGUI::TYPE_USER_SEARCH);
             $this->tpl->parseCurrentBlock();
         }
         $this->tpl->setVariable(
             'FORMACTION',
             $this->ctrl->getFormActionByClass(
                 ilSearchControllerGUI::class,
                 'remoteSearch'
             )
         );
         $this->tpl->setVariable('BTN_SEARCH', $this->lng->txt('search'));
         $this->tpl->setVariable('SEARCH_INPUT_LABEL', $this->lng->txt('search_field'));
         $this->tpl->setVariable(
             'AC_DATASOURCE',
             $this->ctrl->getLinkTargetByClass(
                 ilSearchControllerGUI::class,
                 'autoComplete',
                 null,
                 true
             )
         );
 
         $this->tpl->setVariable('IMG_MM_SEARCH', ilUtil::img(
             ilUtil::getImagePath("icon_seas.svg"),
             $this->lng->txt("search")
         ));
 
         if ($this->user->getId() != ANONYMOUS_USER_ID) {
             $this->tpl->setVariable(
                 'HREF_SEARCH_LINK',
                 'ilias.php?baseClass=' . ilSearchControllerGUI::class
             );
             $this->tpl->setVariable('TXT_SEARCH_LINK', $this->lng->txt("last_search_result"));
         }
         // #10555 - we need the overlay for the autocomplete which is always active
         $this->tpl->setVariable('TXT_SEARCH', $this->lng->txt("search"));
         $ov = new ilOverlayGUI("mm_search_menu");
         //$ov->setTrigger("main_menu_search", "none",
         //      "main_menu_search", "tr", "br");
         //$ov->setAnchor("main_menu_search", "tr", "br");
         $ov->setAutoHide(false);
         $ov->add();
 
         return $this->tpl->get();
     }

Here is the call graph for this function:

◆ initRefIdFromQuery()

ilMainMenuSearchGUI::initRefIdFromQuery ( )

protected

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

References ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and ROOT_FOLDER_ID.

Referenced by __construct().

                                            : void
     {
         $this->ref_id = ROOT_FOLDER_ID;
         if ($this->http->wrapper()->query()->has('ref_id')) {
             $this->ref_id = $this->http->wrapper()->query()->retrieve(
                 'ref_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
     }