Collaboration diagram for ilLuceneUserSearchGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	executeCommand ()
	Execute Command. More...

Protected Member Functions
	prepareOutput ()

	getTabs ()

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

	showSavedResults ()

	search ()
	Search (button pressed) More...

	performSearch ()
	Perform search. More...

	initUserSearchCache ()

	showSearchForm ()

Protected Attributes
ilUserSearchCache	$search_cache

ilCtrl	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilObjUser	$user

GlobalHttpState	$http

Refinery	$refinery

ilTabsGUI	$tabs

ilHelpGUI	$help

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 31 of file class.ilLuceneUserSearchGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLuceneUserSearchGUI::__construct ( )

Constructor.

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

    {
        global $DIC;
 
        $this->tabs = $DIC->tabs();
        $this->help = $DIC->help();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('search');
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->user = $DIC->user();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->initUserSearchCache();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilLuceneUserSearchGUI::executeCommand ( )

Execute Command.

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        $this->prepareOutput();
        switch ($next_class) {
            case strtolower(PublicProfileGUI::class):
 
                $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);
                $profile->setBackUrl($this->ctrl->getLinkTarget($this, 'showSavedResults'));
                $ret = $this->ctrl->forwardCommand($profile);
                $this->tpl->setContent($ret);
                break;
 
 
            default:
                if (!$cmd) {
                    $cmd = "showSavedResults";
                }
                $this->$cmd();
                break;
        }
    }

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

Here is the call graph for this function:

◆ getTabs()

ilLuceneUserSearchGUI::getTabs ( )

protected

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

                                : void
    {
        $this->help->setScreenIdComponent('src_luc');
 
        $this->tabs->addTarget('search', $this->ctrl->getLinkTargetByClass(ilSearchGUI::class));
 
        if (ilSearchSettings::getInstance()->isLuceneUserSearchEnabled()) {
            $this->tabs->addTarget('search_user', $this->ctrl->getLinkTargetByClass(ilLuceneUserSearchGUI::class));
        }
 
        $this->tabs->setTabActive('search_user');
    }

References ILIAS\Repository\ctrl(), ilSearchSettings\getInstance(), ILIAS\Repository\help(), and ILIAS\Repository\tabs().

Referenced by prepareOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserSearchCache()

ilLuceneUserSearchGUI::initUserSearchCache ( )

protected

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

                                            : void
    {
        $this->search_cache = ilUserSearchCache::_getInstance($this->user->getId());
        $this->search_cache->switchSearchType(ilUserSearchCache::LUCENE_USER_SEARCH);
 
        if ($this->http->wrapper()->post()->has('term')) {
            $query = $this->http->wrapper()->post()->retrieve(
                'term',
                $this->refinery->kindlyTo()->string()
            );
            $this->search_cache->setQuery($query);
            $this->search_cache->setItemFilter([]);
            $this->search_cache->setMimeFilter([]);
            $this->search_cache->save();
        }
    }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performSearch()

ilLuceneUserSearchGUI::performSearch ( )

protected

Perform search.

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

                                      : void
    {
        $qp = new ilLuceneQueryParser($this->search_cache->getQuery());
        $qp->parse();
        $searcher = ilLuceneSearcher::getInstance($qp);
        $searcher->setType(ilLuceneSearcher::TYPE_USER);
        $searcher->search();
 
        $this->showSearchForm();
 
        $user_table = new ilRepositoryUserResultTableGUI(
            $this,
            'performSearch',
            false,
            ilRepositoryUserResultTableGUI::TYPE_GLOBAL_SEARCH
        );
        $user_table->setLuceneResult($searcher->getResult());
        $user_table->parseUserIds($searcher->getResult()->getCandidates());
 
        $this->tpl->setVariable('SEARCH_RESULTS', $user_table->getHTML());
    }

References ilLuceneSearcher\getInstance(), showSearchForm(), ilRepositoryUserResultTableGUI\TYPE_GLOBAL_SEARCH, and ilLuceneSearcher\TYPE_USER.

Referenced by search(), and showSavedResults().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareOutput()

ilLuceneUserSearchGUI::prepareOutput ( )

protected

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

                                      : void
    {
        $this->tpl->loadStandardTemplate();
 
        $this->tpl->setTitleIcon(
            ilObject::_getIcon(0, "big", "src"),
            ""
        );
        $this->tpl->setTitle($this->lng->txt("search"));
 
        $this->getTabs();
    }

References ilObject\_getIcon(), getTabs(), and ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remoteSearch()

ilLuceneUserSearchGUI::remoteSearch ( )

protected

Search from main menu.

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

                                     : void
    {
        $root_id = 0;
        if ($this->http->wrapper()->post()->has('root_id')) {
            $root_id = $this->http->wrapper()->post()->retrieve(
                'root_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        $queryString = '';
        if ($this->http->wrapper()->post()->has('queryString')) {
            $queryString = $this->http->wrapper()->post()->retrieve(
                'queryString',
                $this->refinery->kindlyTo()->string()
            );
        }
        $this->search_cache->setRoot($root_id);
        $this->search_cache->setQuery($queryString);
        $this->search_cache->save();
        $this->search();
    }

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

Here is the call graph for this function:

◆ search()

ilLuceneUserSearchGUI::search ( )

protected

Search (button pressed)

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

                               : void
    {
        $this->search_cache->deleteCachedEntries();
        $this->performSearch();
    }

References performSearch().

Referenced by remoteSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSavedResults()

ilLuceneUserSearchGUI::showSavedResults ( )

protected

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

                                         : void
    {
        if (strlen($this->search_cache->getQuery())) {
            $this->performSearch();
            return;
        }
 
        $this->showSearchForm();
    }

References performSearch(), and showSearchForm().

Here is the call graph for this function:

◆ showSearchForm()

ilLuceneUserSearchGUI::showSearchForm ( )

protected

Definition at line 211 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, "performSearch"));
        $this->tpl->setVariable("TERM", ilLegacyFormElementsUtil::prepareFormOutput($this->search_cache->getQuery()));
        $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());
    }