ilLuceneSearchGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilLuceneSearchGUI:

Collaboration diagram for ilLuceneSearchGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	Execute Command. More...
	prepareOutput ()
	Add admin panel command. More...
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 ()
	getDetails ()
	Needed for base class search form. More...
	getMimeDetails ()
	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...
	storeRoot ()
	Store new root node. More...
	getTabs ()
	get tabs More...
	initUserSearchCache ()
	Init user search cache. More...
	fillAdminPanel ()
	Put admin panel into template: More...
	addAdminPanelCommand (string $a_cmd, string $a_txt)
	Add a command to the admin panel. More...
	setAdminViewButton (string $a_link, string $a_txt)
	Show admin view button. More...
	setPageFormAction (string $a_action)
	showSearchForm ()
	Show search form. More...
	parseCreationFilter ()
	Parse creation date. 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
ilLuceneAdvancedSearchFields	$fields
int	$root_node
array	$admin_panel_commands = []
array	$admin_view_button = []
array	$creation_selector = []
string	$page_form_action = ''
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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning @classDescription GUI for simple Lucene search

Author

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

@ilCtrl_IsCalledBy ilLuceneSearchGUI: ilSearchControllerGUI @ilCtrl_Calls ilLuceneSearchGUI: ilPropertyFormGUI @ilCtrl_Calls ilLuceneSearchGUI: ilObjectGUI, ilContainerGUI @ilCtrl_Calls ilLuceneSearchGUI: ilObjCategoryGUI, ilObjCourseGUI, ilObjFolderGUI, ilObjGroupGUI @ilCtrl_Calls ilLuceneSearchGUI: ilObjStudyProgrammeGUI @ilCtrl_Calls ilLuceneSearchGUI: ilObjRootFolderGUI, ilObjectCopyGUI

Definition at line 35 of file class.ilLuceneSearchGUI.php.

Constructor & Destructor Documentation

__construct()

ilLuceneSearchGUI::__construct

(

)

Constructor.

Reimplemented from ilSearchBaseGUI.

Definition at line 52 of file class.ilLuceneSearchGUI.php.

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

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

Here is the call graph for this function:

Member Function Documentation

addAdminPanelCommand()

ilLuceneSearchGUI::addAdminPanelCommand ( string  $a_cmd, string  $a_txt  )

protected

Add a command to the admin panel.

Definition at line 495 of file class.ilLuceneSearchGUI.php.

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

executeCommand()

ilLuceneSearchGUI::executeCommand

(

)

Execute Command.

Definition at line 67 of file class.ilLuceneSearchGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            case "ilpropertyformgui":
                /*$this->initStandardSearchForm(ilSearchBaseGUI::SEARCH_FORM_LUCENE);
                $ilCtrl->setReturn($this, 'storeRoot');
                $ilCtrl->forwardCommand($this->form);*/
                $form = $this->getSearchAreaForm();
                $this->prepareOutput();
                $this->ctrl->setReturn($this, 'storeRoot');
                $this->ctrl->forwardCommand($form);
                break;
 
            case 'ilobjectcopygui':
                $this->prepareOutput();
                $this->ctrl->setReturn($this, '');
                $cp = new ilObjectCopyGUI($this);
                $this->ctrl->forwardCommand($cp);
                break;
 
            default:
                $this->prepareOutput();
                $this->initStandardSearchForm(ilSearchBaseGUI::SEARCH_FORM_LUCENE);
                if (!$cmd) {
                    $cmd = "showSavedResults";
                }
                $this->handleCommand($cmd);
                break;
        }
    }

References ilSearchBaseGUI\$form, ILIAS\Repository\ctrl(), ilSearchBaseGUI\getSearchAreaForm(), ilSearchBaseGUI\handleCommand(), ilSearchBaseGUI\initStandardSearchForm(), prepareOutput(), and ilSearchBaseGUI\SEARCH_FORM_LUCENE.

Here is the call graph for this function:

fillAdminPanel()

ilLuceneSearchGUI::fillAdminPanel ( )

protected

Put admin panel into template:

• creation selector
• admin view on/off button

Definition at line 420 of file class.ilLuceneSearchGUI.php.

                                       : void
    {
        $adm_view_cmp = $adm_cmds = $creation_selector = $adm_view = false;
 
        // admin panel commands
        if ((count($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", $this->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();
        }
    }

References $creation_selector, ilUtil\getImagePath(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getDetails()

ilLuceneSearchGUI::getDetails ( )

protected

Needed for base class search form.

Todo:

rename

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

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

getMimeDetails()

ilLuceneSearchGUI::getMimeDetails ( )

protected

Needed for base class search form.

Todo:

rename

Definition at line 131 of file class.ilLuceneSearchGUI.php.

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

getTabs()

ilLuceneSearchGUI::getTabs ( )

protected

get tabs

Definition at line 338 of file class.ilLuceneSearchGUI.php.

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

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

getType()

ilLuceneSearchGUI::getType ( )

protected

Todo:

rename

Definition at line 113 of file class.ilLuceneSearchGUI.php.

                                : int
    {
        return self::SEARCH_DETAILS;
    }

References ilSearchBaseGUI\SEARCH_DETAILS.

initUserSearchCache()

ilLuceneSearchGUI::initUserSearchCache ( )

protected

Init user search cache.

@access private

Definition at line 361 of file class.ilLuceneSearchGUI.php.

                                            : void
    {
        $this->search_cache = ilUserSearchCache::_getInstance($this->user->getId());
        $this->search_cache->switchSearchType(ilUserSearchCache::LUCENE_DEFAULT);
        $page_number = $this->initPageNumberFromQuery();
 
        $item_filter_enabled = false;
        if ($this->http->wrapper()->post()->has('item_filter_enabled')) {
            $item_filter_enabled = $this->http->wrapper()->post()->retrieve(
                'item_filter_enabled',
                $this->refinery->kindlyTo()->bool()
            );
        }
        $post_filter_type = (array) ($this->http->request()->getParsedBody()['filter_type'] ?? []);
        if ($page_number) {
            $this->search_cache->setResultPageNumber($page_number);
        }
        if ($this->http->wrapper()->post()->has('term')) {
            $term = $this->http->wrapper()->post()->retrieve(
                'term',
                $this->refinery->kindlyTo()->string()
            );
            $this->search_cache->setQuery($term);
            if ($item_filter_enabled) {
                $filtered = array();
                foreach (ilSearchSettings::getInstance()->getEnabledLuceneItemFilterDefinitions() as $type => $data) {
                    if ($post_filter_type[$type] ?? false) {
                        $filtered[$type] = 1;
                    }
                }
                $this->search_cache->setItemFilter($filtered);
 
                // Mime filter
                $mime = array();
                foreach (ilSearchSettings::getInstance()->getEnabledLuceneMimeFilterDefinitions() as $type => $data) {
                    if ($post_filter_type[$type] ?? false) {
                        $mime[$type] = 1;
                    }
                }
                $this->search_cache->setMimeFilter($mime);
            }
            $this->search_cache->setCreationFilter($this->loadCreationFilter());
            if (!$item_filter_enabled) {
                // @todo: keep item filter settings
                $this->search_cache->setItemFilter(array());
                $this->search_cache->setMimeFilter(array());
            }
            $post_screation = (array) ($this->http->request()->getParsedBody()['screation'] ?? []);
            if (!count($post_screation)) {
                $this->search_cache->setCreationFilter([]);
            }
        }
    }

References $data, $type, ilUserSearchCache\_getInstance(), ilSearchSettings\getInstance(), ILIAS\FileDelivery\http(), ilSearchBaseGUI\initPageNumberFromQuery(), ilSearchBaseGUI\loadCreationFilter(), ilUserSearchCache\LUCENE_DEFAULT, 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:

parseCreationFilter()

ilLuceneSearchGUI::parseCreationFilter ( )

protected

Parse creation date.

Definition at line 567 of file class.ilLuceneSearchGUI.php.

                                            : string
    {
        $options = $this->search_cache->getCreationFilter();
 
        if (!($options['enabled'] ?? false)) {
            return '';
        }
        $limit = new ilDate($options['date'], IL_CAL_UNIX);
 
        switch ($options['ontype']) {
            case 1:
                // after
                $limit->increment(IL_CAL_DAY, 1);
                $now = new ilDate(time(), IL_CAL_UNIX);
                return '+(cdate:[' . $limit->get(IL_CAL_DATE) . ' TO ' . $now->get(IL_CAL_DATE) . '*]) ';
 
            case 2:
                // before
                return '+(cdate:[* TO ' . $limit->get(IL_CAL_DATE) . ']) ';
 
            case 3:
                // on
                return '+(cdate:' . $limit->get(IL_CAL_DATE) . '*) ';
 
        }
        return '';
    }

References IL_CAL_DATE, IL_CAL_DAY, and IL_CAL_UNIX.

Referenced by performSearch().

Here is the caller graph for this function:

performSearch()

ilLuceneSearchGUI::performSearch ( )

protected

Perform search.

Definition at line 235 of file class.ilLuceneSearchGUI.php.

                                      : void
    {
        ilSession::clear('vis_references');
        $filter_query = '';
        if ($this->search_cache->getItemFilter() and ilSearchSettings::getInstance()->isLuceneItemFilterEnabled()) {
            $filter_settings = ilSearchSettings::getInstance()->getEnabledLuceneItemFilterDefinitions();
            foreach ($this->search_cache->getItemFilter() as $obj => $value) {
                if (!$filter_query) {
                    $filter_query .= '+( ';
                } else {
                    $filter_query .= 'OR';
                }
                $filter_query .= (' ' . $filter_settings[$obj]['filter'] . ' ');
            }
            $filter_query .= ') ';
        }
        // begin-patch mime_filter
        $mime_query = '';
        if ($this->search_cache->getMimeFilter() and ilSearchSettings::getInstance()->isLuceneMimeFilterEnabled()) {
            $filter_settings = ilSearchSettings::getInstance()->getEnabledLuceneMimeFilterDefinitions();
            foreach ($this->search_cache->getMimeFilter() as $mime => $value) {
                if (!$mime_query) {
                    $mime_query .= '+( ';
                } else {
                    $mime_query .= 'OR';
                }
                $mime_query .= (' ' . $filter_settings[$mime]['filter'] . ' ');
            }
            $mime_query .= ') ';
        }
 
        // begin-patch creation_date
        $cdate_query = $this->parseCreationFilter();
 
 
 
        $filter_query = $filter_query . ' ' . $mime_query . ' ' . $cdate_query;
 
 
        $query = $this->search_cache->getQuery();
        if ($query) {
            $query = ' +(' . $query . ')';
        }
        $qp = new ilLuceneQueryParser($filter_query . $query);
        $qp->parse();
        $searcher = ilLuceneSearcher::getInstance($qp);
        $searcher->search();
 
        // Filter results
        $filter = ilLuceneSearchResultFilter::getInstance($this->user->getId());
        $filter->addFilter(new ilLucenePathFilter($this->search_cache->getRoot()));
        $filter->setCandidates($searcher->getResult());
        $filter->filter();
 
        if ($filter->getResultObjIds()) {
            $searcher->highlight($filter->getResultObjIds());
        }
 
        // Show results
        $this->showSearchForm();
 
        $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());
        } else {
            $this->tpl->setOnScreenMessage(
                'info',
                sprintf(
                    $this->lng->txt('search_no_match_hint'),
                    ilLegacyFormElementsUtil::prepareFormOutput($qp->getQuery())
                )
            );
        }
    }

References $query, ilSearchBaseGUI\addPager(), ilSession\clear(), ilSearchSettings\getInstance(), ilLuceneSearcher\getInstance(), ilLuceneSearchResultFilter\getInstance(), ILIAS\Repository\lng(), parseCreationFilter(), ilLegacyFormElementsUtil\prepareFormOutput(), showSearchForm(), and ILIAS\Repository\user().

Referenced by search(), and storeRoot().

Here is the call graph for this function:

Here is the caller graph for this function:

prepareOutput()

ilLuceneSearchGUI::prepareOutput

(

)

Add admin panel command.

Reimplemented from ilSearchBaseGUI.

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

ilLuceneSearchGUI::remoteSearch ( )

protected

Search from main menu.

Definition at line 139 of file class.ilLuceneSearchGUI.php.

                                     : void
    {
        $queryString = '';
        if ($this->http->wrapper()->post()->has('queryString')) {
            $queryString = $this->http->wrapper()->post()->retrieve(
                'queryString',
                $this->refinery->kindlyTo()->string()
            );
        }
        $root_id = ROOT_FOLDER_ID;
        if ($this->http->wrapper()->post()->has('root_id')) {
            $root_id = $this->http->wrapper()->post()->retrieve(
                'root_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        $qp = new ilLuceneQueryParser($queryString);
        $qp->parseAutoWildcard();
 
        $query = $qp->getQuery();
 
        $this->search_cache->setRoot($root_id);
        $this->search_cache->setQuery(ilUtil::stripSlashes($query));
        $this->search_cache->save();
 
        $this->search();
    }

References $query, ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), ROOT_FOLDER_ID, search(), and ilUtil\stripSlashes().

Here is the call graph for this function:

search()

ilLuceneSearchGUI::search ( )

protected

Search (button pressed)

Returns

void

Definition at line 215 of file class.ilLuceneSearchGUI.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:

setAdminViewButton()

ilLuceneSearchGUI::setAdminViewButton ( string  $a_link, string  $a_txt  )

protected

Show admin view button.

Definition at line 504 of file class.ilLuceneSearchGUI.php.

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

setPageFormAction()

ilLuceneSearchGUI::setPageFormAction ( string  $a_action )

protected

Definition at line 510 of file class.ilLuceneSearchGUI.php.

                                                          : void
    {
        $this->page_form_action = $a_action;
    }

showSavedResults()

ilLuceneSearchGUI::showSavedResults ( )

protected

Show saved results.

Definition at line 170 of file class.ilLuceneSearchGUI.php.

                                         : bool
    {
        if (!strlen($this->search_cache->getQuery())) {
            $this->showSearchForm();
            return false;
        }
 
        $qp = new ilLuceneQueryParser($this->search_cache->getQuery());
        $qp->parse();
        $searcher = ilLuceneSearcher::getInstance($qp);
        $searcher->search();
 
        // Load saved results
        $filter = ilLuceneSearchResultFilter::getInstance($this->user->getId());
        $filter->loadFromDb();
 
        // Highlight
        $searcher->highlight($filter->getResultObjIds());
 
        $presentation = new ilSearchResultPresentation($this);
        $presentation->setResults($filter->getResultIds());
        $presentation->setSearcher($searcher);
        $this->addPager($filter, 'max_page');
        $presentation->setPreviousNext($this->prev_link, $this->next_link);
 
        $this->showSearchForm();
 
        if ($presentation->render()) {
            $this->tpl->setVariable('SEARCH_RESULTS', $presentation->getHTML());
        } elseif (strlen($this->search_cache->getQuery())) {
            $this->tpl->setOnScreenMessage(
                'info',
                sprintf(
                    $this->lng->txt('search_no_match_hint'),
                    ilLegacyFormElementsUtil::prepareFormOutput($qp->getQuery())
                )
            );
        }
        return true;
    }

References ilSearchBaseGUI\addPager(), ilLuceneSearcher\getInstance(), ilLuceneSearchResultFilter\getInstance(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), showSearchForm(), and ILIAS\Repository\user().

Here is the call graph for this function:

showSearchForm()

ilLuceneSearchGUI::showSearchForm ( )

protected

Show search form.

Returns

void

Definition at line 519 of file class.ilLuceneSearchGUI.php.

                                       : void
    {
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lucene_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());
        $this->tpl->setVariable("TXT_OPTIONS", $this->lng->txt("options"));
        $this->tpl->setVariable("ARR_IMG", ilGlyphGUI::get(ilGlyphGUI::CARET));
        $this->tpl->setVariable("TXT_COMBINATION", $this->lng->txt("search_term_combination"));
        $this->tpl->setVariable('TXT_COMBINATION_DEFAULT', ilSearchSettings::getInstance()->getDefaultOperator() == ilSearchSettings::OPERATOR_AND ? $this->lng->txt('search_all_words') : $this->lng->txt('search_any_word'));
        $this->tpl->setVariable("TXT_AREA", $this->lng->txt("search_area"));
 
        if (ilSearchSettings::getInstance()->isLuceneItemFilterEnabled()) {
            $this->tpl->setCurrentBlock("type_sel");
            $this->tpl->setVariable('TXT_TYPE_DEFAULT', $this->lng->txt("search_off"));
            $this->tpl->setVariable("ARR_IMGT", ilGlyphGUI::get(ilGlyphGUI::CARET));
            $this->tpl->setVariable("TXT_FILTER_BY_TYPE", $this->lng->txt("search_filter_by_type"));
            $this->tpl->setVariable('FORM', $this->form->getHTML());
            $this->tpl->parseCurrentBlock();
        }
 
        // search area form
        $this->tpl->setVariable('SEARCH_AREA_FORM', $this->getSearchAreaForm()->getHTML());
        $this->tpl->setVariable("TXT_CHANGE", $this->lng->txt("change"));
 
        if (ilSearchSettings::getInstance()->isDateFilterEnabled()) {
            // begin-patch creation_date
            $this->tpl->setVariable('TXT_FILTER_BY_CDATE', $this->lng->txt('search_filter_cd'));
            $this->tpl->setVariable('TXT_CD_OFF', $this->lng->txt('search_off'));
            $this->tpl->setVariable('FORM_CD', $this->getCreationDateForm()->getHTML());
            $this->tpl->setVariable("ARR_IMG_CD", ilGlyphGUI::get(ilGlyphGUI::CARET));
            // end-patch creation_date
        }
    }

References ilGlyphGUI\CARET, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilGlyphGUI\get(), ilSearchBaseGUI\getCreationDateForm(), ilSearchSettings\getInstance(), ilSubmitButton\getInstance(), ilSearchBaseGUI\getSearchAreaForm(), ILIAS\Repository\lng(), ilSearchSettings\OPERATOR_AND, and ilLegacyFormElementsUtil\prepareFormOutput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

storeRoot()

ilLuceneSearchGUI::storeRoot ( )

protected

Store new root node.

Definition at line 321 of file class.ilLuceneSearchGUI.php.

                                  : void
    {
        $form = $this->getSearchAreaForm();
 
        $this->root_node = $form->getItemByPostVar('area')->getValue();
        $this->search_cache->setRoot($this->root_node);
        $this->search_cache->save();
        $this->search_cache->deleteCachedEntries();
 
        ilSubItemListGUI::resetDetails();
 
        $this->performSearch();
    }

References ilSearchBaseGUI\$form, ilPropertyFormGUI\getItemByPostVar(), ilSearchBaseGUI\getSearchAreaForm(), performSearch(), and ilSubItemListGUI\resetDetails().

Here is the call graph for this function:

Field Documentation

$admin_panel_commands

array ilLuceneSearchGUI::$admin_panel_commands = []

protected

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

$admin_view_button

array ilLuceneSearchGUI::$admin_view_button = []

protected

Definition at line 44 of file class.ilLuceneSearchGUI.php.

$creation_selector

array ilLuceneSearchGUI::$creation_selector = []

protected

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

Referenced by fillAdminPanel().

$fields

ilLuceneAdvancedSearchFields ilLuceneSearchGUI::$fields

protected

Definition at line 40 of file class.ilLuceneSearchGUI.php.

$help

ilHelpGUI ilLuceneSearchGUI::$help

protected

Definition at line 38 of file class.ilLuceneSearchGUI.php.

$page_form_action

string ilLuceneSearchGUI::$page_form_action = ''

protected

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

$root_node

int ilLuceneSearchGUI::$root_node

protected

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

$tabs

ilTabsGUI ilLuceneSearchGUI::$tabs

protected

Definition at line 37 of file class.ilLuceneSearchGUI.php.

---

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

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