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

Collaboration diagram for ilMainMenuSearchGUI:

Public Member Functions
	__construct ()

	getHTML ()

	getStandardSearchAction ()

	getUserSearchAction ()

	getAutocompleteSource ()

Protected Member Functions
	initRefIdFromQuery ()

	buildSearchLink (string $cmd)

Protected Attributes
ilTemplate	$tpl = null

ilLanguage	$lng

ilTree	$tree

ilCtrl	$ctrl

ilObjUser	$user

ilGlobalTemplateInterface	$global_template

Private Attributes
GlobalHttpState	$http

Factory	$refinery

int	$ref_id

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.

    {
        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();
        $this->global_template = $DIC->ui()->mainTemplate();
 
        $this->initRefIdFromQuery();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ buildSearchLink()

ilMainMenuSearchGUI::buildSearchLink ( string $cmd )

protected

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

                                                   : string
    {
        return $this->ctrl->getLinkTargetByClass(
            [strtolower(ilSearchControllerGUI::class), strtolower(ilSearchGUI::class)],
            $cmd
        );
    }

References ILIAS\Repository\ctrl().

Referenced by getHTML(), and getStandardSearchAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAutocompleteSource()

ilMainMenuSearchGUI::getAutocompleteSource ( )

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

                                           : string
    {
        return $this->ctrl->getLinkTargetByClass(
            [strtolower(ilSearchControllerGUI::class)],
            'autoComplete',
            null,
            true
        );
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getHTML()

ilMainMenuSearchGUI::getHTML ( )

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

                             : string
    {
        iljQueryUtil::initjQuery();
 
        $this->global_template->addJavaScript('assets/js/legacyAutocomplete.js', true, 3);
        $this->global_template->addJavascript('assets/js/SearchMainMenu.js');
 
        $this->tpl = new ilTemplate('tpl.main_menu_search.html', true, true, 'components/ILIAS/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->buildSearchLink('remoteSearch', false)
        );
        $this->tpl->setVariable('BTN_SEARCH', $this->lng->txt('search'));
        $this->tpl->setVariable('SEARCH_INPUT_LABEL', $this->lng->txt('search_field'));
 
        $this->tpl->setVariable('IMG_MM_SEARCH', ilUtil::img(
            ilUtil::getImagePath("standard/icon_seas.svg"),
            $this->lng->txt("search")
        ));
 
        if ($this->user->getId() != ANONYMOUS_USER_ID) {
            $this->tpl->setVariable(
                'HREF_SEARCH_LINK',
                $this->buildSearchLink('')
            );
            $this->tpl->setVariable('TXT_SEARCH_LINK', $this->lng->txt("last_search_result"));
        }
        $this->tpl->setVariable('TXT_SEARCH', $this->lng->txt("search"));
 
        return $this->tpl->get();
    }

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

Here is the call graph for this function:

◆ getStandardSearchAction()

ilMainMenuSearchGUI::getStandardSearchAction ( )

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

                                             : string
    {
        return $this->buildSearchLink('remoteSearch');
    }

References buildSearchLink().

Here is the call graph for this function:

◆ getUserSearchAction()

ilMainMenuSearchGUI::getUserSearchAction ( )

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

                                         : string
    {
        return $this->ctrl->getLinkTargetByClass(
            [strtolower(ilSearchControllerGUI::class), strtolower(ilLuceneUserSearchGUI::class)],
            'remoteSearch'
        );
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ initRefIdFromQuery()

ilMainMenuSearchGUI::initRefIdFromQuery ( )

protected

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

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