GUI for simple Lucene search 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
	ilSearchBaseGUI ()
	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...

	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...

	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 ($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)

	showSearchForm ()
	Show search form. More...

	parseCreationFilter ()
	Parse creation date. 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 ()

Protected Attributes
	$ilTabs

Protected Attributes inherited from ilSearchBaseGUI
	$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

	$settings = null

	$ilias = null

	$lng = null

	$tpl = null

Detailed Description

GUI for simple Lucene search

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

Version: $Id$

ilLuceneSearchGUI: ilSearchController ilLuceneSearchGUI: ilPropertyFormGUI ilLuceneSearchGUI: ilObjectGUI, ilContainerGUI ilLuceneSearchGUI: ilObjCategoryGUI, ilObjCourseGUI, ilObjFolderGUI, ilObjGroupGUI ilLuceneSearchGUI: ilObjRootFolderGUI, ilObjectCopyGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilLuceneSearchGUI::__construct ( )

Constructor.

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

References $ilTabs, fields, ilLuceneAdvancedSearchFields\getInstance(), and initUserSearchCache().

         {
                 global $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()

ilLuceneSearchGUI::addAdminPanelCommand	(	$a_cmd,
		$a_txt
	)

protected

Add a command to the admin panel.

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

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

◆ executeCommand()

ilLuceneSearchGUI::executeCommand ( )

Execute Command.

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

References $cmd, $ilBench, $ilCtrl, ilSearchBaseGUI\getSearchAreaForm(), ilSearchBaseGUI\handleCommand(), ilSearchBaseGUI\initStandardSearchForm(), prepareOutput(), and ilSearchBaseGUI\SEARCH_FORM_LUCENE.

         {
                 global $ilBench, $ilCtrl;
                 
                 $ilBench->start('Lucene','0900_executeCommand');
                 $next_class = $this->ctrl->getNextClass($this);
                 $cmd = $this->ctrl->getCmd();
 
                 $this->prepareOutput();
                 switch($next_class)
                 {
                         case "ilpropertyformgui":
                                 /*$this->initStandardSearchForm(ilSearchBaseGUI::SEARCH_FORM_LUCENE);
                                 $ilCtrl->setReturn($this, 'storeRoot');
                                 $ilCtrl->forwardCommand($this->form);*/
                                 $form = $this->getSearchAreaForm();
                                 $ilCtrl->setReturn($this, 'storeRoot');
                                 $ilCtrl->forwardCommand($form);
                                 break;
                         
                         case 'ilobjectcopygui':
                                 $this->ctrl->setReturn($this,'');
                                 include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
                                 $cp = new ilObjectCopyGUI($this);
                                 $this->ctrl->forwardCommand($cp);
                                 break;
                         
                         default:
                                 $this->initStandardSearchForm(ilSearchBaseGUI::SEARCH_FORM_LUCENE);
                                 if(!$cmd)
                                 {
                                         $cmd = "showSavedResults";
                                 }
                                 $this->handleCommand($cmd);
                                 break;
                 }
                 $ilBench->stop('Lucene','0900_executeCommand');
                 return true;
         }

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 458 of file class.ilLuceneSearchGUI.php.

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

         {
                 global $lng;
                 
                 $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", $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:

◆ getDetails()

ilLuceneSearchGUI::getDetails ( )

protected

Needed for base class search form.

Todo:: rename

Returns: type

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

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

◆ getMimeDetails()

ilLuceneSearchGUI::getMimeDetails ( )

protected

Needed for base class search form.

Todo:: rename

Returns: type

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

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

◆ getTabs()

ilLuceneSearchGUI::getTabs ( )

protected

get tabs

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

References fields, and ilSearchSettings\getInstance().

Referenced by prepareOutput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilLuceneSearchGUI::getType ( )

protected

Get type of search (details | fast)

Todo:: rename Needed for base class search form

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

References ilSearchBaseGUI\SEARCH_DETAILS, and ilSearchBaseGUI\SEARCH_FAST.

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

◆ initUserSearchCache()

ilLuceneSearchGUI::initUserSearchCache ( )

protected

Init user search cache.

private

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

References $_GET, $_POST, $data, $ilUser, ilUserSearchCache\_getInstance(), ilSearchSettings\getInstance(), ilSearchBaseGUI\loadCreationFilter(), ilUserSearchCache\LUCENE_DEFAULT, 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_DEFAULT);
                 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']));
                         if($_POST['item_filter_enabled'])
                         {
                                 $filtered = array();
                                 foreach(ilSearchSettings::getInstance()->getEnabledLuceneItemFilterDefinitions() as $type => $data)
                                 {
                                         if($_POST['filter_type'][$type])
                                         {
                                                 $filtered[$type] = 1;
                                         }
                                 }
                                 $this->search_cache->setItemFilter($filtered);
 
                                 // Mime filter
                                 $mime = array();
                                 foreach(ilSearchSettings::getInstance()->getEnabledLuceneMimeFilterDefinitions() as $type => $data)
                                 {
                                         if($_POST['filter_type'][$type])
                                         {
                                                 $mime[$type] = 1;
                                         }
                                 }
                                 $this->search_cache->setMimeFilter($mime);
                                 
                                 
                         }
                         $this->search_cache->setCreationFilter($this->loadCreationFilter());
                         if(!$_POST['item_filter_enabled'])
                         {
                                 // @todo: keep item filter settings
                                 $this->search_cache->setItemFilter(array());
                                 $this->search_cache->setMimeFilter(array());
                         }
                         if(!$_POST['screation'])
                         {
                                 $this->search_cache->setCreationFilter(array());
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseCreationFilter()

ilLuceneSearchGUI::parseCreationFilter ( )

protected

Parse creation date.

Returns: string

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

References $options, IL_CAL_DATE, IL_CAL_DAY, and IL_CAL_UNIX.

Referenced by performSearch().

         {
                 $options = $this->search_cache->getCreationFilter();
                 
                 if(!$options['enabled'])
                 {
                         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 '';
         }

Here is the caller graph for this function:

◆ performSearch()

ilLuceneSearchGUI::performSearch ( )

protected

Perform search.

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

References $_SESSION, $ilBench, $ilUser, $query, ilSearchBaseGUI\addPager(), ilSearchSettings\getInstance(), ilLuceneSearcher\getInstance(), ilLuceneSearchResultFilter\getInstance(), parseCreationFilter(), ilUtil\sendInfo(), and showSearchForm().

Referenced by search(), and storeRoot().

         {
                 global $ilUser,$ilBench;
                 
                 unset($_SESSION['vis_references']);
 
                 $filter_query = '';
                 if($this->search_cache->getItemFilter() and ilSearchSettings::getInstance()->isLuceneItemFilterEnabled())
                 {
                         $filter_settings = ilSearchSettings::getInstance()->getEnabledLuceneItemFilterDefinitions();
                         foreach((array) $this->search_cache->getItemFilter() as $obj => $value)
                         {
                                 if(!$filter_query)
                                 {
                                         $filter_query .= '+( ';
                                 }
                                 else
                                 {
                                         $filter_query .= 'OR';
                                 }
                                 $filter_query .= (' '. (string) $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 .= (' '. (string) $filter_settings[$mime]['filter'].' ');
                         }
                         $mime_query .= ') ';
                 }
                 
                 // begin-patch creation_date
                 $cdate_query = $this->parseCreationFilter();
                 
                 
                 
                 $filter_query = $filter_query . ' '. $mime_query.' '.$cdate_query;
                 
                 include_once './Services/Search/classes/Lucene/class.ilLuceneSearcher.php';
                 include_once './Services/Search/classes/Lucene/class.ilLuceneQueryParser.php';
                 
                 $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
                 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();
                                 
                 if($filter->getResultObjIds()) {
                         $searcher->highlight($filter->getResultObjIds());
                 }
 
                 // Show results
                 $this->showSearchForm();
 
                 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(sprintf($this->lng->txt('search_no_match_hint'),$this->search_cache->getQuery()));
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareOutput()

ilLuceneSearchGUI::prepareOutput ( )

Add admin panel command.

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

ilLuceneSearchGUI::remoteSearch ( )

protected

Search from main menu.

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

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

         {
                 $query = trim(ilUtil::stripSlashes($_POST['queryString']));
 
                 include_once './Services/Search/classes/Lucene/class.ilLuceneQueryParser.php';
                 $qp = new ilLuceneQueryParser($query);
                 $qp->parseAutoWildcard();
                 
                 $query = $qp->getQuery();
                 
                 $this->search_cache->setRoot((int) $_POST['root_id']);
                 $this->search_cache->setQuery(ilUtil::stripSlashes($query));
                 $this->search_cache->save();
                 
                 $this->search();
         }

Here is the call graph for this function:

◆ search()

ilLuceneSearchGUI::search ( )

protected

Search (button pressed)

Returns

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

◆ setAdminViewButton()

ilLuceneSearchGUI::setAdminViewButton	(	$a_link,
		$a_txt
	)

protected

Show admin view button.

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

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

◆ setPageFormAction()

ilLuceneSearchGUI::setPageFormAction ( $a_action )

protected

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

         {
                 $this->page_form_action = $a_action;
         }

◆ showSavedResults()

ilLuceneSearchGUI::showSavedResults ( )

protected

Show saved results.

Returns

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

References $ilBench, $ilUser, ilSearchBaseGUI\addPager(), ilLuceneSearcher\getInstance(), ilLuceneSearchResultFilter\getInstance(), ilLuceneQueryParser\parse(), ilUtil\sendInfo(), and showSearchForm().

         {
                 global $ilUser,$ilBench;
                 
                 if(!strlen($this->search_cache->getQuery()))
                 {
                         $this->showSearchForm();
                         return false;
                 }
 
                 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->search();
 
                 // Load saved results
                 include_once './Services/Search/classes/Lucene/class.ilLuceneSearchResultFilter.php';
                 $filter = ilLuceneSearchResultFilter::getInstance($ilUser->getId());
                 $filter->loadFromDb();
 
                 // Highlight
                 $searcher->highlight($filter->getResultObjIds());
                 
                 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);
                         
                 $this->showSearchForm();        
 
                 if($presentation->render())
                 {
                         $this->tpl->setVariable('SEARCH_RESULTS',$presentation->getHTML(true));
                 }
                 elseif(strlen($this->search_cache->getQuery()))
                 {
                         ilUtil::sendInfo(sprintf($this->lng->txt('search_no_match_hint'),$qp->getQuery()));
                 }
         }

Here is the call graph for this function:

◆ showSearchForm()

ilLuceneSearchGUI::showSearchForm ( )

protected

Show search form.

Returns: boolean

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

References $ilCtrl, ilSearchBaseGUI\$lng, ilGlyphGUI\CARET, ilGlyphGUI\get(), ilSearchBaseGUI\getCreationDateForm(), ilSubmitButton\getInstance(), ilSearchSettings\getInstance(), ilSearchBaseGUI\getSearchAreaForm(), ilOverlayGUI\initJavascript(), ilSearchSettings\OPERATOR_AND, and ilUtil\prepareFormOutput().

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

         {
                 global $ilCtrl, $lng;
                 
                 $this->tpl->addBlockFile('ADM_CONTENT','adm_content','tpl.lucene_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");
 
                 include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
 
                 $this->tpl->setVariable("FORM_ACTION", $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());
                 $this->tpl->setVariable("TXT_OPTIONS", $lng->txt("options"));
                 $this->tpl->setVariable("ARR_IMG", ilGlyphGUI::get(ilGlyphGUI::CARET));
                 $this->tpl->setVariable("TXT_COMBINATION", $lng->txt("search_term_combination"));
                 $this->tpl->setVariable('TXT_COMBINATION_DEFAULT', ilSearchSettings::getInstance()->getDefaultOperator() == ilSearchSettings::OPERATOR_AND ? $lng->txt('search_all_words') : $lng->txt('search_any_word'));
                 $this->tpl->setVariable("TXT_AREA", $lng->txt("search_area"));
 
                 if (ilSearchSettings::getInstance()->isLuceneItemFilterEnabled())
                 {
                         $this->tpl->setCurrentBlock("type_sel");
                         $this->tpl->setVariable('TXT_TYPE_DEFAULT',$lng->txt("search_off"));
                         $this->tpl->setVariable("ARR_IMGT", ilGlyphGUI::get(ilGlyphGUI::CARET));
                         $this->tpl->setVariable("TXT_FILTER_BY_TYPE", $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", $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
                 }
                 
                 
                 return true;
         }

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 354 of file class.ilLuceneSearchGUI.php.

References ilSearchBaseGUI\getSearchAreaForm(), performSearch(), and ilSubItemListGUI\resetDetails().

         {
                 $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();
 
                 include_once './Services/Object/classes/class.ilSubItemListGUI.php';
                 ilSubItemListGUI::resetDetails();
 
                 $this->performSearch();
         }

Here is the call graph for this function:

Field Documentation

◆ $ilTabs

ilLuceneSearchGUI::$ilTabs

protected

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

Referenced by __construct().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdminPanelCommand()

◆ executeCommand()

◆ fillAdminPanel()

◆ getDetails()

◆ getMimeDetails()

◆ getTabs()

◆ getType()

◆ initUserSearchCache()

◆ parseCreationFilter()

◆ performSearch()

◆ prepareOutput()

◆ remoteSearch()

◆ search()

◆ setAdminViewButton()

◆ setPageFormAction()

◆ showSavedResults()

◆ showSearchForm()

◆ storeRoot()

Field Documentation

◆ $ilTabs