@ilCtrl_IsCalledBy ilSearchGUI: ilSearchControllerGUI More...

Collaboration diagram for ilSearchGUI:

Public Member Functions
	__construct ()

	executeCommand ()

Protected Member Functions
	initByMode (Service $service)

	search ()

	remoteSearch ()
	Search from main menu. More...

	showSavedResults ()

	applyFilter ()

	switchResultPage ()

	sortResultPage ()

	autoComplete ()

	renderSearchInput (string $term)

	renderFilter (ilSearchFilterGUI $filter, int $scope)

	fillHeaderAndTabs ()

	buildViewControlInfos (Sortation $sortation, int $page, int $max_page)

Detailed Description

@ilCtrl_IsCalledBy ilSearchGUI: ilSearchControllerGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilSearchGUI::__construct ( )

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

    {
        global $DIC;
 
        $service = new Service($DIC);
 
        $this->tpl = $service->dic()->ui()->mainTemplate();
        $this->user = $service->dic()->user();
        $this->lng = $service->dic()->language();
        $this->ctrl = $service->dic()->ctrl();
        $this->tabs = $service->dic()->tabs();
        $this->help = $service->dic()->help();
        $this->settings = ilSearchSettings::getInstance();
        $this->result_presenter = $service->presentation()->result();
        $this->actions = $service->gui()->actions();
 
        $this->initByMode($service);
        $this->tpl->loadStandardTemplate();
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.search.html', 'components/ILIAS/Search');
    }

References $DIC, $service, ILIAS\Repository\ctrl(), ilSearchSettings\getInstance(), ILIAS\Repository\help(), initByMode(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ applyFilter()

ilSearchGUI::applyFilter ( )

protected

Definition at line 162 of file class.ilSearchGUI.php.

                                    : void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $this->state_handler->loadFilterToCache($filter, $cache);
 
        $term = $cache->getQuery();
        $scope = $cache->getRoot();
        $sortation = Sortation::RELEVANCE_DESC;
        $page = 1;
        $max_page = 1;
 
        $this->state_handler->resetMaxPage();
        $cache->deleteCachedEntries();
        $cache->save();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->performSearchAndRenderResults($this->user->getId(), $cache, $view_control_infos, $this->state_handler);
    }

References $scope, buildViewControlInfos(), fillHeaderAndTabs(), renderFilter(), renderSearchInput(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ autoComplete()

ilSearchGUI::autoComplete ( )

protected

Definition at line 226 of file class.ilSearchGUI.php.

                                     : void
    {
        $term = $this->state_handler->fetchRequestedAutoCompleteSearchTerm();
        $list = ilSearchAutoComplete::getList($term);
        echo $list;
        exit;
    }

References exit, and ilSearchAutoComplete\getList().

Here is the call graph for this function:

◆ buildViewControlInfos()

ilSearchGUI::buildViewControlInfos	(	Sortation	$sortation,
		int	$page,
		int	$max_page
	)

protected

Definition at line 291 of file class.ilSearchGUI.php.

     : ViewControlInfos {
        return $this->result_presenter->getViewControlInfos(
            $sortation,
            $page,
            $max_page,
            $this->settings->getMaxHits(),
            $this->actions->switchResultPage($sortation),
            Param::PAGE_NUMBER,
            $this->actions->sortResultPage(),
            Param::SORTATION
        );
    }

Referenced by applyFilter(), remoteSearch(), search(), showSavedResults(), sortResultPage(), and switchResultPage().

Here is the caller graph for this function:

◆ executeCommand()

ilSearchGUI::executeCommand ( )

Definition at line 79 of file class.ilSearchGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            default:
                if (!$this->actions->isValidCommand($cmd)) {
                    $cmd = 'showSavedResults';
                }
                $this->$cmd();
                break;
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ fillHeaderAndTabs()

ilSearchGUI::fillHeaderAndTabs ( )

protected

Definition at line 259 of file class.ilSearchGUI.php.

                                          : void
    {
        // tabs
        $this->tabs->addTab(
            'search',
            $this->lng->txt('search'),
            (string) $this->actions->showSavedResults()
        );
        if ($this->settings->enabledLucene() && $this->settings->isLuceneUserSearchEnabled()) {
            $this->tabs->addTarget(
                'search_user',
                $this->ctrl->getLinkTargetByClass(ilLuceneUserSearchGUI::class)
            );
        }
        $this->tabs->activateTab('search');
 
        // help
        if ($this->settings->enabledLucene()) {
            $this->help->setScreenIdComponent('src_luc');
        } else {
            $this->help->setScreenIdComponent('src');
 
        }
 
        // header
        $this->tpl->setTitleIcon(
            ilObject::_getIcon(0, "big", "src"),
            ""
        );
        $this->tpl->setTitle($this->lng->txt("search"));
    }

References ilObject\_getIcon(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\tabs().

Referenced by applyFilter(), remoteSearch(), search(), showSavedResults(), sortResultPage(), and switchResultPage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initByMode()

ilSearchGUI::initByMode ( Service $service )

protected

Definition at line 68 of file class.ilSearchGUI.php.

                                                   : void
    {
        if ($this->settings->enabledLucene()) {
            $this->searcher = $service->gui()->luceneSearcher();
            $this->state_handler = $service->gui()->luceneSearchStateHandler();
        } else {
            $this->searcher = $service->gui()->directSearcher();
            $this->state_handler = $service->gui()->directSearchStateHandler();
        }
    }

References $service, and ILIAS\Repository\settings().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remoteSearch()

ilSearchGUI::remoteSearch ( )

protected

Search from main menu.

Definition at line 120 of file class.ilSearchGUI.php.

                                     : void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $term = $this->state_handler->fetchRequestedRemoteSearchTerm();
        $scope = $this->state_handler->fetchRequestedRemoteScope();
        $sortation = Sortation::RELEVANCE_DESC;
        $page = 1;
        $max_page = 1;
 
        $this->state_handler->resetMaxPage();
        $cache->deleteCachedEntries();
        $cache->setQuery($term);
        $cache->setRoot($scope);
        $cache->save();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->performSearchAndRenderResults($this->user->getId(), $cache, $view_control_infos, $this->state_handler);
    }

References $scope, buildViewControlInfos(), fillHeaderAndTabs(), renderFilter(), renderSearchInput(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ renderFilter()

ilSearchGUI::renderFilter	(	ilSearchFilterGUI	$filter,
		int	$scope
	)

protected

Definition at line 247 of file class.ilSearchGUI.php.

     : void {
        $filter_html = $filter->getHTML();
        preg_match('/id="([^"]+)"/', $filter_html, $matches);
        $filter_id = $matches[1];
        $this->tpl->setVariable("SEARCH_FILTER", $filter_html);
        // scope in filter must be manipulated by JS if search is triggered in meta bar
        $this->tpl->addOnLoadCode("il.Search.syncFilterScope('" . $filter_id . "', '" . $scope . "');");
    }

Referenced by applyFilter(), remoteSearch(), search(), showSavedResults(), sortResultPage(), and switchResultPage().

Here is the caller graph for this function:

◆ renderSearchInput()

ilSearchGUI::renderSearchInput ( string $term )

protected

Definition at line 234 of file class.ilSearchGUI.php.

                                                      : void
    {
        $this->tpl->addJavascript("assets/js/Search.js");
 
        $this->tpl->setVariable("FORM_ACTION", $this->actions->search());
        $this->tpl->setVariable("TERM", ilLegacyFormElementsUtil::prepareFormOutput($term));
        $this->tpl->setVariable("SEARCH_LABEL", $this->lng->txt("search"));
        $btn = ilSubmitButton::getInstance();
        $btn->setCommand("performSearch");
        $btn->setCaption("search");
        $this->tpl->setVariable("SUBMIT_BTN", $btn->render());
    }

References ilSubmitButton\getInstance(), ILIAS\Repository\lng(), and ilLegacyFormElementsUtil\prepareFormOutput().

Referenced by applyFilter(), remoteSearch(), search(), showSavedResults(), sortResultPage(), and switchResultPage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ search()

ilSearchGUI::search ( )

protected

Definition at line 94 of file class.ilSearchGUI.php.

                               : void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $term = $this->state_handler->fetchRequestedSearchTerm();
        $scope = $cache->getRoot();
        $sortation = Sortation::RELEVANCE_DESC;
        $page = 1;
        $max_page = 1;
 
        $this->state_handler->resetMaxPage();
        $cache->deleteCachedEntries();
        $cache->setQuery($term);
        $cache->save();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->performSearchAndRenderResults($this->user->getId(), $cache, $view_control_infos, $this->state_handler);
    }

References $scope, buildViewControlInfos(), fillHeaderAndTabs(), renderFilter(), renderSearchInput(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ showSavedResults()

ilSearchGUI::showSavedResults ( )

protected

Definition at line 144 of file class.ilSearchGUI.php.

                                         : void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $term = $cache->getQuery();
        $scope = $cache->getRoot();
        $sortation = Sortation::RELEVANCE_DESC;
        $page = $cache->getResultPageNumber();
        $max_page = $this->state_handler->fetchMaxPage();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->readSavedResultsAndRenderResults($this->user->getId(), $cache, $view_control_infos);
    }

References $scope, buildViewControlInfos(), fillHeaderAndTabs(), renderFilter(), renderSearchInput(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ sortResultPage()

ilSearchGUI::sortResultPage ( )

protected

Definition at line 208 of file class.ilSearchGUI.php.

                                       : void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $term = $cache->getQuery();
        $scope = $cache->getRoot();
        $sortation = $this->state_handler->fetchSortation();
        $page = $cache->getResultPageNumber();
        $max_page = $this->state_handler->fetchMaxPage();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->readSavedResultsAndRenderResults($this->user->getId(), $cache, $view_control_infos);
    }

References $scope, buildViewControlInfos(), fillHeaderAndTabs(), renderFilter(), renderSearchInput(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ switchResultPage()

ilSearchGUI::switchResultPage ( )

protected

Definition at line 186 of file class.ilSearchGUI.php.

                                         : void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $term = $cache->getQuery();
        $scope = $cache->getRoot();
        $sortation = $this->state_handler->fetchSortation();
        $page = $this->state_handler->fetchRequestedPage();
        $max_page = max($this->state_handler->fetchMaxPage(), $page);
 
        $this->state_handler->updateMaxPage($max_page);
        $cache->setResultPageNumber($page);
        $cache->save();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->performSearchAndRenderResults($this->user->getId(), $cache, $view_control_infos, $this->state_handler);
    }

References $scope, buildViewControlInfos(), fillHeaderAndTabs(), renderFilter(), renderSearchInput(), and ILIAS\Repository\user().

Here is the call graph for this function:

Field Documentation

◆ $actions

Actions ilSearchGUI::$actions

protected

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

◆ $ctrl

ilCtrlInterface ilSearchGUI::$ctrl

protected

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

◆ $help

ilHelpGUI ilSearchGUI::$help

protected

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

◆ $lng

ilLanguage ilSearchGUI::$lng

protected

Definition at line 37 of file class.ilSearchGUI.php.

◆ $result_presenter

ResultPresenter ilSearchGUI::$result_presenter

protected

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

◆ $searcher

Searcher ilSearchGUI::$searcher

protected

Definition at line 44 of file class.ilSearchGUI.php.

◆ $settings

ilSearchSettings ilSearchGUI::$settings

protected

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

◆ $state_handler

SearchStateHandler ilSearchGUI::$state_handler

protected

Definition at line 45 of file class.ilSearchGUI.php.

◆ $tabs

ilTabsGUI ilSearchGUI::$tabs

protected

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

◆ $tpl

ilGlobalTemplateInterface ilSearchGUI::$tpl

protected

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

◆ $user

ilObjUser ilSearchGUI::$user

protected

Definition at line 36 of file class.ilSearchGUI.php.

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

components/ILIAS/Search/classes/GUI/class.ilSearchGUI.php

Protected Attributes
ilGlobalTemplateInterface	$tpl

ilObjUser	$user

ilLanguage	$lng

ilCtrlInterface	$ctrl

ilTabsGUI	$tabs

ilHelpGUI	$help

ilSearchSettings	$settings

ResultPresenter	$result_presenter

Actions	$actions

Searcher	$searcher

SearchStateHandler	$state_handler

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFilter()

◆ autoComplete()

◆ buildViewControlInfos()

◆ executeCommand()

◆ fillHeaderAndTabs()

◆ initByMode()

◆ remoteSearch()

◆ renderFilter()

◆ renderSearchInput()

◆ search()

◆ showSavedResults()

◆ sortResultPage()

◆ switchResultPage()

Field Documentation

◆ $actions

◆ $ctrl

◆ $help

◆ $lng

◆ $result_presenter

◆ $searcher

◆ $settings

◆ $state_handler

◆ $tabs

◆ $tpl

◆ $user