ilLuceneUserSearchGUI Class Reference

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 ()
	Add admin panel command. More...
Public Member Functions inherited from ilSearchBaseGUI
	__construct ()
	Constructor public. More...
	prepareOutput ()
	initStandardSearchForm ($a_mode)
	Init standard search form. More...
	getSearchAreaForm ()
	Init standard search form. More...
	handleCommand ($a_cmd)
	Handle command. More...
	addToDeskObject ()
	Interface methods. More...
	removeFromDeskObject ()
	Remove from dektop. More...
	delete ()
	Show deletion screen. More...
	cancelDelete ()
	Cancel delete. More...
	cancelMoveLinkObject ()
	Cancel move/link. More...
	performDelete ()
	Delete objects. More...
	cut ()
	Interface ilAdministrationCommandHandler. More...
	link ()
	Interface ilAdministrationCommandHandler. More...
	paste ()
	Paste. More...
	showLinkIntoMultipleObjectsTree ()
	Target selection link. More...
	showMoveIntoObjectTree ()
	Target selection cut. More...
	performPasteIntoMultipleObjects ()
	Perform paste into multiple objects. More...
	clear ()
	clear clipboard More...
	enableAdministrationPanel ()
	Enable administration panel. More...
	disableAdministrationPanel ()
	Disable administration panel. More...
	keepObjectsInClipboardObject ()
	cancel action but keep objects in clipboard Returns void More...
	addLocator ()
	Add Locator. More...
	autoComplete ()
	Data resource for autoComplete. More...

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
	addPager ($result, $a_session_key)
	Add Pager. More...
	buildSearchAreaPath ($a_root_node)
	Build path for search area. More...
	getCreationDateForm ()
	getSearchCache ()
	Get user search cache. More...
	loadCreationFilter ()
	Load creation date filter. More...

Protected Attributes
	$ilTabs
Protected Attributes inherited from ilSearchBaseGUI
	$settings = null
	$ctrl = null

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
	$ilias = null
	$lng = null
	$tpl = null

Detailed Description

GUI for Lucene user search

Author

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

Version

$Id$

ilLuceneUserSearchGUI: ilPublicUserProfileGUI ilLuceneUserSearchGUI: ilSearchController

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

Constructor & Destructor Documentation

__construct()

ilLuceneUserSearchGUI::__construct

(

)

Constructor.

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

References $ilTabs, and initUserSearchCache().

    {
        global $ilTabs;
        
        $this->tabs_gui = $ilTabs;
        parent::__construct();
        $this->initUserSearchCache();
    }

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.

References $GLOBALS, $ilBench, $ilCtrl, $ret, ilSearchBaseGUI\handleCommand(), ilSearchBaseGUI\initStandardSearchForm(), prepareOutput(), and ilSearchBaseGUI\SEARCH_FORM_USER.

    {
        global $ilBench, $ilCtrl;
        
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        
        $this->prepareOutput();
        switch ($next_class) {
            case "ilpublicuserprofilegui":
                include_once('./Services/User/classes/class.ilPublicUserProfileGUI.php');
                $profile = new ilPublicUserProfileGUI((int) $_REQUEST['user']);
                $profile->setBackUrl($this->ctrl->getLinkTarget($this, 'showSavedResults'));
                $ret = $ilCtrl->forwardCommand($profile);
                $GLOBALS['tpl']->setContent($ret);
                break;

            
            default:
                $this->initStandardSearchForm(ilSearchBaseGUI::SEARCH_FORM_USER);
                if (!$cmd) {
                    $cmd = "showSavedResults";
                }
                $this->handleCommand($cmd);
                break;
        }
        return true;
    }

Here is the call graph for this function:

getDetails()

ilLuceneUserSearchGUI::getDetails ( )

protected

Needed for base class search form.

Todo:

rename

Returns

type

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

References array.

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

getTabs()

ilLuceneUserSearchGUI::getTabs ( )

protected

get tabs

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

References ilSearchSettings\getInstance(), and ilLuceneAdvancedSearchFields\getInstance().

Referenced by prepareOutput().

    {
        global $ilHelp;

        $ilHelp->setScreenIdComponent("src_luc");

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

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

References ilSearchBaseGUI\SEARCH_DETAILS, and ilSearchBaseGUI\SEARCH_FAST.

    {
        if (count($this->search_cache)) {
            return ilSearchBaseGUI::SEARCH_DETAILS;
        }
        return ilSearchBaseGUI::SEARCH_FAST;
    }

initUserSearchCache()

ilLuceneUserSearchGUI::initUserSearchCache ( )

protected

Init user search cache.

private

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

References $_GET, $_POST, $ilUser, ilUserSearchCache\_getInstance(), array, ilUserSearchCache\LUCENE_USER_SEARCH, and ilUtil\stripSlashes().

Referenced by __construct().

    {
        global $ilUser;
        
        include_once('Services/Search/classes/class.ilUserSearchCache.php');
        $this->search_cache = ilUserSearchCache::_getInstance($ilUser->getId());
        $this->search_cache->switchSearchType(ilUserSearchCache::LUCENE_USER_SEARCH);
        if ((int) $_GET['page_number']) {
            $this->search_cache->setResultPageNumber((int) $_GET['page_number']);
        }
        if (isset($_POST['term'])) {
            $this->search_cache->setQuery(ilUtil::stripSlashes($_POST['term']));
            $this->search_cache->setItemFilter(array());
            $this->search_cache->setMimeFilter(array());
            $this->search_cache->save();
        }
    }

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

References $GLOBALS, ilLuceneSearcher\getInstance(), ilLuceneQueryParser\parse(), showSearchForm(), ilRepositoryUserResultTableGUI\TYPE_GLOBAL_SEARCH, and ilLuceneSearcher\TYPE_USER.

Referenced by search(), and showSavedResults().

    {
        include_once './Services/Search/classes/Lucene/class.ilLuceneSearcher.php';
        include_once './Services/Search/classes/Lucene/class.ilLuceneQueryParser.php';
        $qp = new ilLuceneQueryParser($this->search_cache->getQuery());
        $qp->parse();
        $searcher = ilLuceneSearcher::getInstance($qp);
        $searcher->setType(ilLuceneSearcher::TYPE_USER);
        $searcher->search();
        
        $this->showSearchForm();
        
        include_once './Services/Search/classes/class.ilRepositoryUserResultTableGUI.php';
        $user_table = new ilRepositoryUserResultTableGUI(
            $this,
            'performSearch',
            false,
            ilRepositoryUserResultTableGUI::TYPE_GLOBAL_SEARCH
        );
        $user_table->setLuceneResult($searcher->getResult());
        $user_table->parseUserIds($searcher->getResult()->getCandidates());

        $GLOBALS['tpl']->setVariable('SEARCH_RESULTS', $user_table->getHTML());
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareOutput()

ilLuceneUserSearchGUI::prepareOutput

(

)

Add admin panel command.

Todo:

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

References getTabs().

Referenced by executeCommand().

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

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

References $_POST, search(), and ilUtil\stripSlashes().

    {
        $_POST['query'] = $_POST['queryString'];
        $this->search_cache->setRoot((int) $_POST['root_id']);
        $this->search_cache->setQuery(ilUtil::stripSlashes($_POST['queryString']));
        $this->search_cache->save();
        
        $this->search();
    }

Here is the call graph for this function:

search()

ilLuceneUserSearchGUI::search ( )

protected

Search (button pressed)

Returns

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

References $_SESSION, performSearch(), ilSubItemListGUI\resetDetails(), and showSearchForm().

Referenced by remoteSearch().

    {
        if (!$this->form->checkInput()) {
            $this->search_cache->deleteCachedEntries();
            // Reset details
            include_once './Services/Object/classes/class.ilSubItemListGUI.php';
            ilSubItemListGUI::resetDetails();
            $this->showSearchForm();
            return false;
        }
        
        unset($_SESSION['max_page']);
        $this->search_cache->deleteCachedEntries();
        
        // Reset details
        include_once './Services/Object/classes/class.ilSubItemListGUI.php';
        ilSubItemListGUI::resetDetails();
        
        $this->performSearch();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showSavedResults()

ilLuceneUserSearchGUI::showSavedResults ( )

protected

Show saved results.

Returns

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

References $ilBench, $ilUser, performSearch(), and showSearchForm().

    {
        global $ilUser,$ilBench;
        
        if (strlen($this->search_cache->getQuery())) {
            return $this->performSearch();
        }

        return $this->showSearchForm();
    }

Here is the call graph for this function:

showSearchForm()

ilLuceneUserSearchGUI::showSearchForm ( )

protected

Show search form.

Returns

boolean

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

References $GLOBALS, $ilCtrl, ilSearchBaseGUI\$lng, ilSubmitButton\getInstance(), ilOverlayGUI\initJavascript(), and ilUtil\prepareFormOutput().

Referenced by performSearch(), search(), and showSavedResults().

    {
        global $ilCtrl, $lng;
        
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lucene_usr_search.html', 'Services/Search');

        // include js needed
        include_once("./Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php");
        ilOverlayGUI::initJavascript();
        $this->tpl->addJavascript("./Services/Search/js/Search.js");

        $this->tpl->setVariable('FORM_ACTION', $GLOBALS['ilCtrl']->getFormAction($this, 'performSearch'));
        $this->tpl->setVariable("TERM", ilUtil::prepareFormOutput($this->search_cache->getQuery()));
        include_once("./Services/UIComponent/Button/classes/class.ilSubmitButton.php");
        $btn = ilSubmitButton::getInstance();
        $btn->setCommand("performSearch");
        $btn->setCaption("search");
        $this->tpl->setVariable("SUBMIT_BTN", $btn->render());
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ilTabs

ilLuceneUserSearchGUI::$ilTabs

protected

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

Referenced by __construct().

---

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

• Services/Search/classes/Lucene/class.ilLuceneUserSearchGUI.php