ilLuceneAdvancedSearchGUI Class Reference

Meta Data search GUI. More...

Inheritance diagram for ilLuceneAdvancedSearchGUI:

Collaboration diagram for ilLuceneAdvancedSearchGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	Execute Command. More...
	showSavedResults ()
	Show saved results. 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...
	cancelObject ()
	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...
	showPasteTree ()
	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...
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	initFormSearch ()
	Show search form. More...
	remoteSearch ()
	Search from main menu. More...
	search ()
	reset ()
	Reset search form. More...
	performSearch ()
	Perform search. More...
	getTabs ()
	get tabs More...
	initUserSearchCache ()
	Init user search cache. More...
	fillAdminPanel ()
	addAdminPanelCommand ($a_cmd, $a_txt)
	Add a command to the admin panel. More...
	setAdminViewButton ($a_link, $a_txt)
	Show admin view button. More...
	setPageFormAction ($a_action)
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
	$fields = null
Protected Attributes inherited from ilSearchBaseGUI
	$settings = null
	$ctrl = null
	$favourites
	$user

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

Meta Data search GUI.

Author

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

Version

$Id$

ilLuceneAdvancedSearchGUI: ilSearchController ilLuceneAdvancedSearchGUI: ilObjectGUI, ilContainerGUI ilLuceneAdvancedSearchGUI: ilObjCategoryGUI, ilObjCourseGUI, ilObjFolderGUI, ilObjGroupGUI ilLuceneAdvancedSearchGUI: ilObjRootFolderGUI, ilObjectCopyGUI

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

Constructor & Destructor Documentation

__construct()

ilLuceneAdvancedSearchGUI::__construct

(

)

Constructor.

Definition at line 50 of file class.ilLuceneAdvancedSearchGUI.php.

References $DIC, $ilTabs, ILIAS\GlobalScreen\Provider\__construct(), fields, ilLuceneAdvancedSearchFields\getInstance(), and initUserSearchCache().

    {
        global $DIC;

        $ilTabs = $DIC['ilTabs'];
        
        $this->tabs_gui = $ilTabs;
        parent::__construct();
        
        $this->fields = ilLuceneAdvancedSearchFields::getInstance();
        $this->initUserSearchCache();
    }

Here is the call graph for this function:

Member Function Documentation

addAdminPanelCommand()

ilLuceneAdvancedSearchGUI::addAdminPanelCommand (   $a_cmd,   $a_txt  )

protected

Add a command to the admin panel.

Definition at line 422 of file class.ilLuceneAdvancedSearchGUI.php.

    {
        $this->admin_panel_commands[] =
            array("cmd" => $a_cmd, "txt" => $a_txt);
    }

executeCommand()

ilLuceneAdvancedSearchGUI::executeCommand

(

)

Execute Command.

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

References ilSearchBaseGUI\handleCommand(), and prepareOutput().

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();
        switch ($next_class) {
            case 'ilobjectcopygui':
                $this->ctrl->setReturn($this);
                include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
                $cp = new ilObjectCopyGUI($this, '');
                $this->ctrl->forwardCommand($cp);
                break;
            
            
            default:
                if (!$cmd) {
                    $cmd = "showSavedResults";
                }
                $this->handleCommand($cmd);
                break;
        }
        return true;
    }

Here is the call graph for this function:

fillAdminPanel()

ilLuceneAdvancedSearchGUI::fillAdminPanel ( )

protected

Definition at line 343 of file class.ilLuceneAdvancedSearchGUI.php.

References $DIC, ilSearchBaseGUI\$lng, and ilUtil\getImagePath().

Referenced by performSearch(), and showSavedResults().

    {
        global $DIC;

        $lng = $DIC['lng'];
        
        $adm_view_cmp = $adm_cmds = $creation_selector = $adm_view = false;

        // admin panel commands
        if ((count((array) $this->admin_panel_commands) > 0)) {
            foreach ($this->admin_panel_commands as $cmd) {
                $this->tpl->setCurrentBlock("lucene_admin_panel_cmd");
                $this->tpl->setVariable("LUCENE_PANEL_CMD", $cmd["cmd"]);
                $this->tpl->setVariable("LUCENE_TXT_PANEL_CMD", $cmd["txt"]);
                $this->tpl->parseCurrentBlock();
            }

            $adm_cmds = true;
        }
        if ($adm_cmds) {
            $this->tpl->setCurrentBlock("lucene_adm_view_components");
            $this->tpl->setVariable("LUCENE_ADM_IMG_ARROW", ilUtil::getImagePath("arrow_upright.svg"));
            $this->tpl->setVariable("LUCENE_ADM_ALT_ARROW", $lng->txt("actions"));
            $this->tpl->parseCurrentBlock();
            $adm_view_cmp = true;
        }
        
        // admin view button
        if (is_array($this->admin_view_button)) {
            if (is_array($this->admin_view_button)) {
                $this->tpl->setCurrentBlock("lucene_admin_button");
                $this->tpl->setVariable(
                    "LUCENE_ADMIN_MODE_LINK",
                    $this->admin_view_button["link"]
                );
                $this->tpl->setVariable(
                    "LUCENE_TXT_ADMIN_MODE",
                    $this->admin_view_button["txt"]
                );
                $this->tpl->parseCurrentBlock();
            }
            $this->tpl->setCurrentBlock("lucene_admin_view");
            $this->tpl->parseCurrentBlock();
            $adm_view = true;
        }
        
        // creation selector
        if (is_array($this->creation_selector)) {
            $this->tpl->setCurrentBlock("lucene_add_commands");
            if ($adm_cmds) {
                $this->tpl->setVariable("LUCENE_ADD_COM_WIDTH", 'width="1"');
            }
            $this->tpl->setVariable(
                "LUCENE_SELECT_OBJTYPE_REPOS",
                $this->creation_selector["options"]
            );
            $this->tpl->setVariable(
                "LUCENE_BTN_NAME_REPOS",
                $this->creation_selector["command"]
            );
            $this->tpl->setVariable(
                "LUCENE_TXT_ADD_REPOS",
                $this->creation_selector["txt"]
            );
            $this->tpl->parseCurrentBlock();
            $creation_selector = true;
        }
        if ($adm_view || $creation_selector) {
            $this->tpl->setCurrentBlock("lucene_adm_panel");
            if ($adm_view_cmp) {
                $this->tpl->setVariable("LUCENE_ADM_TBL_WIDTH", 'width:"100%";');
            }
            $this->tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTabs()

ilLuceneAdvancedSearchGUI::getTabs ( )

protected

get tabs

Definition at line 298 of file class.ilLuceneAdvancedSearchGUI.php.

References $DIC, fields, and ilSearchSettings\getInstance().

Referenced by prepareOutput().

    {
        global $DIC;

        $ilHelp = $DIC['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'));
        }
        
        if (
            !ilSearchSettings::getInstance()->getHideAdvancedSearch() and
            $this->fields->getActiveFields()) {
            $this->tabs_gui->addTarget('search_advanced', $this->ctrl->getLinkTarget($this));
        }
        
        $this->tabs_gui->setTabActive('search_advanced');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFormSearch()

ilLuceneAdvancedSearchGUI::initFormSearch ( )

protected

Show search form.

Definition at line 149 of file class.ilLuceneAdvancedSearchGUI.php.

References $DIC, $section, and fields.

Referenced by performSearch(), and showSavedResults().

    {
        global $DIC;

        $tree = $DIC['tree'];
        
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this, 'search'));
        $this->form->setTitle($this->lng->txt('search_advanced'));
        $this->form->addCommandButton('search', $this->lng->txt('search'));
        $this->form->addCommandButton('reset', $this->lng->txt('reset'));
        
        foreach ($this->fields->getActiveSections() as $definition) {
            if ($definition['name'] != 'default') {
                $section = new ilFormSectionHeaderGUI();
                $section->setTitle($definition['name']);
                $this->form->addItem($section);
            }
            
            foreach ($definition['fields'] as $field_name) {
                if (is_object($element = $this->fields->getFormElement($this->search_cache->getQuery(), $field_name, $this->form))) {
                    $this->form->addItem($element);
                }
            }
        }
        return true;
    }

Here is the caller graph for this function:

initUserSearchCache()

ilLuceneAdvancedSearchGUI::initUserSearchCache ( )

protected

Init user search cache.

private

Definition at line 327 of file class.ilLuceneAdvancedSearchGUI.php.

References $_GET, $_POST, $DIC, $ilUser, ilUserSearchCache\_getInstance(), and ilUserSearchCache\LUCENE_ADVANCED.

Referenced by __construct().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        
        include_once('Services/Search/classes/class.ilUserSearchCache.php');
        $this->search_cache = ilUserSearchCache::_getInstance($ilUser->getId());
        $this->search_cache->switchSearchType(ilUserSearchCache::LUCENE_ADVANCED);
        if ((int) $_GET['page_number']) {
            $this->search_cache->setResultPageNumber((int) $_GET['page_number']);
        }
        if (isset($_POST['query'])) {
            $this->search_cache->setQuery($_POST['query']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

performSearch()

ilLuceneAdvancedSearchGUI::performSearch ( )

protected

Perform search.

Definition at line 221 of file class.ilLuceneAdvancedSearchGUI.php.

References $_SESSION, $DIC, $ilBench, $ilUser, ilSearchBaseGUI\addPager(), fillAdminPanel(), ilLuceneSearcher\getInstance(), ilLuceneSearchResultFilter\getInstance(), initFormSearch(), ilLuceneAdvancedQueryParser\parse(), ilUtil\sendInfo(), and showSavedResults().

Referenced by search().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $ilBench = $DIC['ilBench'];
        
        unset($_SESSION['vis_references']);
        
        include_once './Services/Search/classes/Lucene/class.ilLuceneSearcher.php';
        include_once './Services/Search/classes/Lucene/class.ilLuceneAdvancedQueryParser.php';
        $qp = new ilLuceneAdvancedQueryParser($this->search_cache->getQuery());
        $qp->parse();
        if (!strlen(trim($qp->getQuery()))) {
            ilUtil::sendInfo($this->lng->txt('msg_no_search_string'));
            $this->showSavedResults();
            return false;
        }
        
        $searcher = ilLuceneSearcher::getInstance($qp);
        $searcher->search();
        
        // Filter results
        $ilBench->start('Lucene', 'ResultFilter');
        include_once './Services/Search/classes/Lucene/class.ilLuceneSearchResultFilter.php';
        include_once './Services/Search/classes/Lucene/class.ilLucenePathFilter.php';
        $filter = ilLuceneSearchResultFilter::getInstance($ilUser->getId());
        $filter->addFilter(new ilLucenePathFilter($this->search_cache->getRoot()));
        $filter->setCandidates($searcher->getResult());
        $filter->filter();
        $ilBench->stop('Lucene', 'ResultFilter');
                
        if ($filter->getResultObjIds()) {
            $searcher->highlight($filter->getResultObjIds());
        }

        // Show results
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lucene_adv_search.html', 'Services/Search');
        include_once './Services/Search/classes/class.ilSearchResultPresentation.php';
        $presentation = new ilSearchResultPresentation($this);
        $presentation->setResults($filter->getResultIds());
        $presentation->setSearcher($searcher);

        // TODO: other handling required
        $ilBench->start('Lucene', '1500_fo');
        $this->addPager($filter, 'max_page');
        $ilBench->stop('Lucene', '1500_fo');
        $presentation->setPreviousNext($this->prev_link, $this->next_link);

        if ($presentation->render()) {
            $this->tpl->setVariable('SEARCH_RESULTS', $presentation->getHTML(true));
        } else {
            ilUtil::sendInfo($this->lng->txt('search_no_match'));
        }
        
        // and finally add search form
        $this->initFormSearch();
        $this->tpl->setVariable('SEARCH_TABLE', $this->form->getHTML());
        
        if ($filter->getResultIds()) {
            $this->fillAdminPanel();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareOutput()

ilLuceneAdvancedSearchGUI::prepareOutput

(

)

Add admin panel command.

Definition at line 288 of file class.ilLuceneAdvancedSearchGUI.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()

ilLuceneAdvancedSearchGUI::remoteSearch ( )

protected

Search from main menu.

Definition at line 182 of file class.ilLuceneAdvancedSearchGUI.php.

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

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

Here is the call graph for this function:

reset()

ilLuceneAdvancedSearchGUI::reset ( )

protected

Reset search form.

Definition at line 211 of file class.ilLuceneAdvancedSearchGUI.php.

References showSavedResults().

    {
        $this->search_cache->setQuery(array());
        $this->search_cache->save();
        $this->showSavedResults();
    }

Here is the call graph for this function:

search()

ilLuceneAdvancedSearchGUI::search ( )

protected

Definition at line 190 of file class.ilLuceneAdvancedSearchGUI.php.

References $_SESSION, performSearch(), ilSubItemListGUI\resetDetails(), ilUtil\sendInfo(), and showSavedResults().

Referenced by remoteSearch().

    {
        if (!is_array($this->search_cache->getQuery())) {
            // TOD: handle empty advances search
            ilUtil::sendInfo($this->lng->txt('msg_no_search_string'));
            $this->showSavedResults();
            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:

setAdminViewButton()

ilLuceneAdvancedSearchGUI::setAdminViewButton (   $a_link,   $a_txt  )

protected

Show admin view button.

Definition at line 431 of file class.ilLuceneAdvancedSearchGUI.php.

    {
        $this->admin_view_button =
            array("link" => $a_link, "txt" => $a_txt);
    }

setPageFormAction()

ilLuceneAdvancedSearchGUI::setPageFormAction (   $a_action )

protected

Definition at line 437 of file class.ilLuceneAdvancedSearchGUI.php.

    {
        $this->page_form_action = $a_action;
    }

showSavedResults()

ilLuceneAdvancedSearchGUI::showSavedResults

(

)

Show saved results.

Returns

Definition at line 96 of file class.ilLuceneAdvancedSearchGUI.php.

References $DIC, $ilBench, $ilUser, ilSearchBaseGUI\addPager(), fillAdminPanel(), ilLuceneSearcher\getInstance(), ilLuceneSearchResultFilter\getInstance(), initFormSearch(), ilLuceneAdvancedQueryParser\parse(), and ilUtil\sendInfo().

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

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $ilBench = $DIC['ilBench'];
        
        include_once './Services/Search/classes/Lucene/class.ilLuceneSearcher.php';
        include_once './Services/Search/classes/Lucene/class.ilLuceneAdvancedQueryParser.php';
        $qp = new ilLuceneAdvancedQueryParser($this->search_cache->getQuery());
        $qp->parse();
        $searcher = ilLuceneSearcher::getInstance($qp);
        $searcher->search();

        // Load saved results
        include_once './Services/Search/classes/Lucene/class.ilLuceneSearchResultFilter.php';
        $filter = ilLuceneSearchResultFilter::getInstance($ilUser->getId());
        $filter->loadFromDb();

        // Highlight
        if ($filter->getResultObjIds()) {
            $searcher->highlight($filter->getResultObjIds());
        }
        
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lucene_adv_search.html', 'Services/Search');
        include_once './Services/Search/classes/class.ilSearchResultPresentation.php';
        $presentation = new ilSearchResultPresentation($this);
        $presentation->setResults($filter->getResultIds());
        $presentation->setSearcher($searcher);


        // TODO: other handling required
        $this->addPager($filter, 'max_page');
        $presentation->setPreviousNext($this->prev_link, $this->next_link);
        
        if ($presentation->render()) {
            $this->tpl->setVariable('SEARCH_RESULTS', $presentation->getHTML(true));
        } elseif (strlen(trim($qp->getQuery()))) {
            ilUtil::sendInfo($this->lng->txt('search_no_match'));
        }
        
        // and finally add search form
        $this->initFormSearch();
        $this->tpl->setVariable('SEARCH_TABLE', $this->form->getHTML());
        
        if ($filter->getResultIds()) {
            $this->fillAdminPanel();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$fields

ilLuceneAdvancedSearchGUI::$fields = null

protected

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

$ilTabs

ilLuceneAdvancedSearchGUI::$ilTabs

protected

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

Referenced by __construct().

---

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

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