@classDescription GUI for Lucene user search More...

Inheritance diagram for ilLuceneUserSearchGUI:

Collaboration diagram for ilLuceneUserSearchGUI:

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

	executeCommand ()
	Execute Command. More...

	prepareOutput ()

Public Member Functions inherited from ilSearchBaseGUI
	__construct ()

	prepareOutput ()

	initStandardSearchForm (int $a_mode)

	getSearchAreaForm ()

	handleCommand (string $a_cmd)

	addToDeskObject ()
	Add desktop item @access public. More...

	removeFromDeskObject ()
	Remove from desktop @access public. More...

	delete ()
	Show delete confirmation. More...

	cancelDelete ()
	Cancel delete. More...

	cancelObject ()

	cancelMoveLinkObject ()

	performDelete ()

	cut ()

	link ()

	paste ()

	showLinkIntoMultipleObjectsTree ()

	showPasteTree ()

	showMoveIntoObjectTree ()

	performPasteIntoMultipleObjects ()

	clear ()
	clear clipboard More...

	enableAdministrationPanel ()

	disableAdministrationPanel ()

	keepObjectsInClipboardObject ()

	addLocator ()

	autoComplete ()

	addToDeskObject ()
	Add desktop item @access public. More...

	removeFromDeskObject ()
	Remove from desktop @access public. More...

	delete ()
	Show delete confirmation. More...

	cancelDelete ()
	Cancel delete. More...

	performDelete ()

	cut ()

	showLinkIntoMultipleObjectsTree ()

	showMoveIntoObjectTree ()

	showPasteTree ()

	performPasteIntoMultipleObjects ()

	paste ()

	clear ()
	clear clipboard More...

	enableAdministrationPanel ()

	disableAdministrationPanel ()

	cancelMoveLinkObject ()

	keepObjectsInClipboardObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	getType ()
	Get type of search (details \| fast) More...

	getDetails ()
	Needed for base class search form. More...

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

	showSavedResults ()
	Show saved results. More...

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

	performSearch ()
	Perform search. More...

	getTabs ()
	get tabs More...

	initUserSearchCache ()
	Init user search cache. More...

	showSearchForm ()
	Show search form. More...

Protected Member Functions inherited from ilSearchBaseGUI
	initPageNumberFromQuery ()

	addPager ($result, string $a_session_key)

	buildSearchAreaPath (int $a_root_node)

	getCreationDateForm ()

	getSearchCache ()

	loadCreationFilter ()

Protected Attributes
ilTabsGUI	$tabs

ilHelpGUI	$help

Protected Attributes inherited from ilSearchBaseGUI
ilUserSearchCache	$search_cache

string	$search_mode = ''

ilSearchSettings	$settings

ilPropertyFormGUI	$form = null

ClipboardManager	$clipboard

ViewManager	$container_view_manager

ilFavouritesManager	$favourites

ilCtrl	$ctrl

ILIAS	$ilias

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilLocatorGUI	$locator

ilObjUser	$user

ilTree	$tree

GlobalHttpState	$http

Factory	$refinery

ilLogger	$logger

string	$prev_link = ''

string	$next_link = ''

Additional Inherited Members
Data Fields inherited from ilSearchBaseGUI
const	SEARCH_FAST = 1

const	SEARCH_DETAILS = 2

const	SEARCH_AND = 'and'

const	SEARCH_OR = 'or'

const	SEARCH_FORM_LUCENE = 1

const	SEARCH_FORM_STANDARD = 2

const	SEARCH_FORM_USER = 3

Detailed Description

@classDescription GUI for Lucene user search

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

@ilCtrl_Calls ilLuceneUserSearchGUI: ilPublicUserProfileGUI @ilCtrl_IsCalledBy ilLuceneUserSearchGUI: ilSearchControllerGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilLuceneUserSearchGUI::__construct ( )

Constructor.

Reimplemented from ilSearchBaseGUI.

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

    {
        global $DIC;
 
        $this->tabs = $DIC->tabs();
        $this->help = $DIC->help();
        parent::__construct();
        $this->initUserSearchCache();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\help(), initUserSearchCache(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilLuceneUserSearchGUI::executeCommand ( )

Execute Command.

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

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

References ILIAS\Repository\ctrl(), ilSearchBaseGUI\handleCommand(), ILIAS\FileDelivery\http(), ilSearchBaseGUI\initStandardSearchForm(), prepareOutput(), ILIAS\Repository\refinery(), and ilSearchBaseGUI\SEARCH_FORM_USER.

Here is the call graph for this function:

◆ getDetails()

ilLuceneUserSearchGUI::getDetails ( )

protected

Needed for base class search form.

Todo:: rename

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

                                   : array
    {
        return $this->search_cache->getItemFilter();
    }

◆ getTabs()

ilLuceneUserSearchGUI::getTabs ( )

protected

get tabs

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

                                : void
    {
        $this->help->setScreenIdComponent("src_luc");
 
        $this->tabs->addTarget('search', $this->ctrl->getLinkTargetByClass('illucenesearchgui'));
 
        if (ilSearchSettings::getInstance()->isLuceneUserSearchEnabled()) {
            $this->tabs->addTarget('search_user', $this->ctrl->getLinkTargetByClass('illuceneusersearchgui'));
        }
 
        $fields = ilLuceneAdvancedSearchFields::getInstance();
 
        if (
            !ilSearchSettings::getInstance()->getHideAdvancedSearch() and
            $fields->getActiveFields()) {
            $this->tabs->addTarget('search_advanced', $this->ctrl->getLinkTargetByClass('illuceneadvancedsearchgui'));
        }
 
        $this->tabs->setTabActive('search_user');
    }

References ILIAS\Repository\ctrl(), ilSearchSettings\getInstance(), ilLuceneAdvancedSearchFields\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:

◆ getType()

ilLuceneUserSearchGUI::getType ( )

protected

Get type of search (details | fast)

Todo:: rename Needed for base class search form

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

                                : int
    {
        return self::SEARCH_DETAILS;
    }

References ilSearchBaseGUI\SEARCH_DETAILS.

◆ initUserSearchCache()

ilLuceneUserSearchGUI::initUserSearchCache ( )

protected

Init user search cache.

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

                                            : void
    {
        $this->search_cache = ilUserSearchCache::_getInstance($this->user->getId());
        $this->search_cache->switchSearchType(ilUserSearchCache::LUCENE_USER_SEARCH);
        $page_number = $this->initPageNumberFromQuery();
        if ($page_number) {
            $this->search_cache->setResultPageNumber($page_number);
        }
 
        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(array());
            $this->search_cache->setMimeFilter(array());
            $this->search_cache->save();
        }
    }

References $query, ilUserSearchCache\_getInstance(), ILIAS\FileDelivery\http(), ilSearchBaseGUI\initPageNumberFromQuery(), 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 163 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 ( )

Reimplemented from ilSearchBaseGUI.

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

                                   : void
    {
        parent::prepareOutput();
        $this->getTabs();
    }

References getTabs().

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 103 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)

Returns: void

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

                               : void
    {
        if (!$this->form->checkInput()) {
            $this->search_cache->deleteCachedEntries();
            // Reset details
            ilSubItemListGUI::resetDetails();
            $this->showSearchForm();
            return;
        }
        ilSession::clear('max_page');
        $this->search_cache->deleteCachedEntries();
 
        // Reset details
        ilSubItemListGUI::resetDetails();
        $this->performSearch();
    }

References ilSession\clear(), ILIAS\Repository\form(), performSearch(), ilSubItemListGUI\resetDetails(), and showSearchForm().

Referenced by remoteSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSavedResults()

ilLuceneUserSearchGUI::showSavedResults ( )

protected

Show saved results.

Returns: void

Definition at line 129 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

Show search form.

Returns: boolean

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

    {
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lucene_usr_search.html', 'Services/Search');
 
        ilOverlayGUI::initJavascript();
        $this->tpl->addJavascript("./Services/Search/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());
 
        return true;
    }