Collaboration diagram for ilLuceneUserSearchGUI:

Public Member Functions
	__construct ()

	executeCommand ()

Protected Member Functions
	search ()

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

	showSavedResults ()

	switchResultPage ()

	performSearch (string $term, int $current_page)

	fetchCache ()

	renderResults (FilteredResult $result, PaginationInfos $pagination_infos, string $term)

	renderSearchInput (string $term)

	buildPaginationInfos (int $page, int $max_page)

Protected Attributes
ilCtrl	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilTabsGUI	$tabs

UIRenderer	$ui_renderer

ilObjUser	$user

GlobalHttpState	$http

Refinery	$refinery

ilSearchSettings	$settings

ResultPresenter	$result_presenter

Actions	$actions

SearchStateHandler	$state_handler

ResultFilter	$result_filter

Criterion	$user_public_criterion

Detailed Description

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

@ilCtrl_Calls ilLuceneUserSearchGUI: ILIAS\User\Profile\PublicProfileGUI @ilCtrl_IsCalledBy ilLuceneUserSearchGUI: ilSearchControllerGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilLuceneUserSearchGUI::__construct ( )

Definition at line 59 of file class.ilLuceneUserSearchGUI.php.

    {
        global $DIC;
 
        $service = new Service($DIC);
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('search');
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->tabs = $DIC->tabs();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->user = $DIC->user();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->settings = ilSearchSettings::getInstance();
        $this->result_presenter = $service->presentation()->result();
        $this->actions = $service->gui()->userSearchActions();
        $this->state_handler = $service->gui()->searchStateHandler();
        $this->result_filter = $service->result()->resultFilter();
        $this->user_public_criterion = $service->result()->userIsPublicCriterion();
    }

References $DIC, $service, ILIAS\Repository\ctrl(), ilSearchSettings\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ buildPaginationInfos()

ilLuceneUserSearchGUI::buildPaginationInfos	(	int	$page,
		int	$max_page
	)

protected

Definition at line 277 of file class.ilLuceneUserSearchGUI.php.

     : PaginationInfos {
        return $this->result_presenter->getPaginationInfos(
            $page,
            $max_page,
            $this->settings->getMaxHits(),
            $this->actions->switchResultPage(),
            Param::PAGE_NUMBER
        );
    }

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

Here is the caller graph for this function:

◆ executeCommand()

ilLuceneUserSearchGUI::executeCommand ( )

Definition at line 82 of file class.ilLuceneUserSearchGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            case strtolower(PublicProfileGUI::class):
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt('back'),
                    (string) $this->actions->showSavedResults()
                );
                $user_id = 0;
                if ($this->http->wrapper()->query()->has('user_id')) {
                    $user_id = $this->http->wrapper()->query()->retrieve(
                        'user_id',
                        $this->refinery->kindlyTo()->int()
                    );
                }
                $profile = new PublicProfileGUI($user_id);
                $ret = $this->ctrl->forwardCommand($profile);
                $this->tpl->setContent($ret);
                break;
 
 
            default:
                if (!$this->actions->isValidCommand($cmd)) {
                    $cmd = 'showSavedResults';
                }
                $this->$cmd();
                break;
        }
    }

References $user_id, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ fetchCache()

ilLuceneUserSearchGUI::fetchCache ( )

protected

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

                                   : ilUserSearchCache
    {
        $cache = ilUserSearchCache::_getInstance($this->user->getId());
        $cache->switchSearchType(ilUserSearchCache::LUCENE_USER_SEARCH);
        return $cache;
    }

References ilUserSearchCache\_getInstance(), ilUserSearchCache\LUCENE_USER_SEARCH, and ILIAS\Repository\user().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performSearch()

ilLuceneUserSearchGUI::performSearch	(	string	$term,
		int	$current_page
	)

protected

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

     : FilteredResult {
        $qp = new ilLuceneQueryParser($term);
        $qp->parse();
        $searcher = ilLuceneSearcher::getInstance($qp);
        $searcher->setType(ilLuceneSearcher::TYPE_USER);
        $searcher->search();
 
        return $this->result_filter->filter(
            $this->user_public_criterion,
            ($current_page - 1) * $this->settings->getMaxHits(),
            $this->settings->getMaxHits(),
            ...$searcher->getResult()->getCandidates()
        );
    }

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

Here is the caller graph for this function:

◆ remoteSearch()

ilLuceneUserSearchGUI::remoteSearch ( )

protected

Search from main menu.

Definition at line 143 of file class.ilLuceneUserSearchGUI.php.

                                     : void
    {
        $cache = $this->fetchCache();
 
        $term = $this->state_handler->fetchRequestedRemoteSearchTerm();
        $page = 1;
        $max_page = 1;
 
        $result = $this->performSearch($term, $page);
        if ($page >= $max_page && !$result->isResultComplete()) {
            $max_page = $page + 1;
        }
 
        $this->state_handler->updateMaxPage($max_page);
        $cache->deleteCachedEntries();
        $cache->setQuery($term);
        $cache->save();
 
        $this->renderSearchInput($term);
        $pagination_infos = $this->buildPaginationInfos($page, $max_page);
        $this->renderResults($result, $pagination_infos, $term);
    }

References $page, buildPaginationInfos(), fetchCache(), performSearch(), renderResults(), and renderSearchInput().

Here is the call graph for this function:

◆ renderResults()

ilLuceneUserSearchGUI::renderResults	(	FilteredResult	$result,
		PaginationInfos	$pagination_infos,
		string	$term
	)

protected

Definition at line 233 of file class.ilLuceneUserSearchGUI.php.

     : void {
        if ($result->valid() || $pagination_infos->currentPage() > 1) {
            $result_panel = $this->result_presenter->getLuceneUserSearchResultAsPanel(
                $pagination_infos,
                ...$result
            );
            $this->tpl->setVariable(
                'SEARCH_RESULTS',
                $this->ui_renderer->render($result_panel)
            );
        } elseif ($term !== '') {
            $this->tpl->setOnScreenMessage(
                GlobalTemplate::MESSAGE_TYPE_INFO,
                sprintf(
                    $this->lng->txt('search_no_match_hint'),
                    $term
                )
            );
        } else {
            $this->tpl->setOnScreenMessage(
                GlobalTemplate::MESSAGE_TYPE_INFO,
                $this->lng->txt('search_no_match')
            );
        }
    }

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

Here is the caller graph for this function:

◆ renderSearchInput()

ilLuceneUserSearchGUI::renderSearchInput ( string $term )

protected

Definition at line 263 of file class.ilLuceneUserSearchGUI.php.

    {
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lucene_usr_search.html', 'components/ILIAS/Search');
        $this->tpl->addJavascript("assets/js/Search.js");
 
        $this->tpl->setVariable("FORM_ACTION", $this->ctrl->getFormAction($this, "search"));
        $this->tpl->setVariable("TERM", ilLegacyFormElementsUtil::prepareFormOutput($term));
        $this->tpl->setVariable("SEARCH_LABEL", $this->lng->txt("search"));
        $btn = ilSubmitButton::getInstance();
        $btn->setCommand("search");
        $btn->setCaption("search");
        $this->tpl->setVariable("SUBMIT_BTN", $btn->render());
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ search()

ilLuceneUserSearchGUI::search ( )

protected

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

                               : void
    {
        $cache = $this->fetchCache();
 
        $term = $this->state_handler->fetchRequestedSearchTerm();
        $page = 1;
        $max_page = 1;
 
 
        $result = $this->performSearch($term, $page);
        if ($page >= $max_page && !$result->isResultComplete()) {
            $max_page = $page + 1;
        }
 
        $this->state_handler->updateMaxPage($max_page);
        $cache->deleteCachedEntries();
        $cache->setQuery($term);
        $cache->save();
 
        $this->renderSearchInput($term);
        $pagination_infos = $this->buildPaginationInfos($page, $max_page);
        $this->renderResults($result, $pagination_infos, $term);
    }

References $page, buildPaginationInfos(), fetchCache(), performSearch(), renderResults(), and renderSearchInput().

Here is the call graph for this function:

◆ showSavedResults()

ilLuceneUserSearchGUI::showSavedResults ( )

protected

Definition at line 166 of file class.ilLuceneUserSearchGUI.php.

                                         : void
    {
        $cache = $this->fetchCache();
 
        $term = $cache->getQuery();
        $page = $cache->getResultPageNumber();
        $max_page = $this->state_handler->fetchMaxPage();
 
        $result = $this->performSearch($term, $page);
        if ($page >= $max_page && !$result->isResultComplete()) {
            $max_page = $page + 1;
        }
 
        $this->state_handler->updateMaxPage($max_page);
 
        $this->renderSearchInput($term);
        $pagination_infos = $this->buildPaginationInfos($page, $max_page);
        $this->renderResults($result, $pagination_infos, $term);
    }

References $page, buildPaginationInfos(), fetchCache(), performSearch(), renderResults(), and renderSearchInput().

Here is the call graph for this function:

◆ switchResultPage()

ilLuceneUserSearchGUI::switchResultPage ( )

protected

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

                                         : void
    {
        $cache = $this->fetchCache();
 
        $term = $cache->getQuery();
        $page = $this->state_handler->fetchRequestedPage();
        $max_page = max($this->state_handler->fetchMaxPage(), $page);
 
        $result = $this->performSearch($term, $page);
        if ($page >= $max_page && !$result->isResultComplete()) {
            $max_page = $page + 1;
        }
 
        $this->state_handler->updateMaxPage($max_page);
        $cache->setResultPageNumber($page);
        $cache->save();
 
        $this->renderSearchInput($term);
        $pagination_infos = $this->buildPaginationInfos($page, $max_page);
        $this->renderResults($result, $pagination_infos, $term);
    }