Inheritance diagram for ilSearchGUI:

Collaboration diagram for ilSearchGUI:

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

	executeCommand ()
	Control public. More...

	setType ($a_type)
	Set/get type of search (detail or 'fast' search) public. More...

	getType ()

	setCombination ($a_combination)
	Set/get combination of search ('and' or 'or') public. More...

	getCombination ()

	setString ($a_str)
	Set/get search string public. More...

	getString ()

	setDetails ($a_details)
	Set/get details (object types for details search) public. More...

	getDetails ()

	getRootNode ()

	setRootNode ($a_node_id)

	remoteSearch ()

	autoComplete ()
	Data resource for autoComplete. More...

	showSearch ()

	showSavedResults ()

	performSearch ()
	Perform search. More...

	prepareOutput ()

&	__performDetailsSearch (&$query_parser, &$result)

&	__parseQueryString ()
	parse query string, using query parser instance More...

&	__searchObjects (&$query_parser)
	Search in obect title,desctiption. More...

	parseCreationFilter (ilObjectSearch $search)

&	__searchMeta (&$query_parser, $a_type)
	Search in object meta data (keyword) More...

	__getFilter ()
	Get object type for filter (If detail search is enabled) 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...

	addLocator ()
	Add Locator. More...

	autoComplete ()
	Data resource for autoComplete. More...

Data Fields
	$root_node

	$combination

	$string

	$type

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

Protected Member Functions
	storeRoot ()
	Store new root node. More...

	initUserSearchCache ()
	Init user search cache. 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
	$search_cache = null

Protected Attributes inherited from ilSearchBaseGUI
	$settings = null

	$ctrl = null

Detailed Description

Class ilSearchGUI.

GUI class for 'simple' search

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$ ilSearchGUI: ilPropertyFormGUI ilSearchGUI: ilObjectGUI, ilContainerGUI ilSearchGUI: ilObjCategoryGUI, ilObjCourseGUI, ilObjFolderGUI, ilObjGroupGUI ilSearchGUI: ilObjRootFolderGUIGUI, ilObjectCopyGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilSearchGUI::__construct ( )

Constructor public.

Definition at line 36 of file class.ilSearchGUI.php.

References $_POST, $_SESSION, $ilUser, ilSearchBaseGUI\$lng, $type, ilSearchSettings\getInstance(), ilSearchBaseGUI\initStandardSearchForm(), ilSearchBaseGUI\SEARCH_FORM_STANDARD, setCombination(), setDetails(), setString(), and setType().

         {
                 global $ilUser, $lng;
 
                 $lng->loadLanguageModule("search");
                 
                 // put form values into "old" post variables
                 $this->initStandardSearchForm(ilSearchBaseGUI::SEARCH_FORM_STANDARD);
                 $this->form->checkInput();
                 
                 $new_search = isset($_POST['cmd']['performSearch']) ? true : false;
 
                 $enabled_types = ilSearchSettings::getInstance()->getEnabledLuceneItemFilterDefinitions();
                 foreach($enabled_types as $type => $pval)
                 {
                         if($_POST['filter_type'][$type] == 1)
                         {
                                 $_POST["search"]["details"][$type] = $_POST['filter_type'][$type];
                         }
                 }
 
                 $_POST["search"]["string"] = $_POST["term"];
                 $_POST["search"]["combination"] = $_POST["combination"];
                 $_POST["search"]["type"] = $_POST["type"];
                 $_SESSION['search_root'] = $_POST["area"];
 
                 $this->root_node = $_SESSION['search_root'] ? $_SESSION['search_root'] : ROOT_FOLDER_ID;
                 $this->setType($_POST['search']['type'] ? $_POST['search']['type'] : $_SESSION['search']['type']);
                 $this->setCombination($_POST['search']['combination'] ? $_POST['search']['combination'] : $_SESSION['search']['combination']);
                 $this->setString($_POST['search']['string'] ? $_POST['search']['string'] : $_SESSION['search']['string']);
                 #$this->setDetails($_POST['search']['details'] ? $_POST['search']['details'] : $_SESSION['search']['details']);
                 $this->setDetails($new_search ? $_POST['search']['details'] : $_SESSION['search']['details']);
                 parent::__construct();
         }

Here is the call graph for this function:

Member Function Documentation

◆ __getFilter()

ilSearchGUI::__getFilter ( )

Get object type for filter (If detail search is enabled)

Returns: array object types public

Definition at line 653 of file class.ilSearchGUI.php.

References array, getDetails(), getType(), and ilSearchBaseGUI\SEARCH_DETAILS.

Referenced by __performDetailsSearch(), __searchMeta(), and __searchObjects().

         {
                 if($this->getType() != ilSearchBaseGUI::SEARCH_DETAILS)
                 {
                         return false;
                 }
                 
                 foreach($this->getDetails() as $key => $detail_type)
                 {
                         if(!$detail_type)
                         {
                                 continue;
                         }
                         
                         switch($key)
                         {
                                 case 'lms':
                                         $filter[] = 'lm';
                                         $filter[] = 'dbk';
                                         $filter[] = 'pg';
                                         $filter[] = 'st';
                                         $filter[] = 'sahs';
                                         $filter[] = 'htlm';
                                         break;
 
                                 case 'frm':
                                         $filter[] = 'frm';
                                         break;
 
                                 case 'glo':
                                         $filter[] = 'glo';
                                         break;
 
                                 case 'exc':
                                         $filter[] = 'exc';
                                         break;
 
                                 case 'mcst':
                                         $filter[] = 'mcst';
                                         break;
 
                                 case 'tst':
                                         $filter[] = 'tst';
                                         $filter[] = 'svy';
                                         $filter[] = 'qpl';
                                         $filter[] = 'spl';
                                         break;
 
                                 case 'mep':
                                         $filter[] = 'mep';
                                         $filter[] = 'mob';
                                         break;
 
                                 case 'fil':
                                         $filter[] = 'file';
                                         break;
                                         
                                 case 'wiki':
                                         $filter[] = 'wpg';
                                         break;
                                 
                                 default:
                                         $filter[] = $key;
                         }
                 }
                 return $filter ? $filter : array();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __parseQueryString()

& ilSearchGUI::__parseQueryString ( )

parse query string, using query parser instance

Returns: object of query parser or error message if an error occured public

Definition at line 551 of file class.ilSearchGUI.php.

References getCombination(), getString(), and ilUtil\stripSlashes().

Referenced by performSearch().

         {
                 include_once 'Services/Search/classes/class.ilQueryParser.php';
 
                 $query_parser = new ilQueryParser(ilUtil::stripSlashes($this->getString()));
                 $query_parser->setCombination($this->getCombination());
                 $query_parser->parse();
 
                 if(!$query_parser->validate())
                 {
                         return $query_parser->getMessage();
                 }
                 return $query_parser;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __performDetailsSearch()

& ilSearchGUI::__performDetailsSearch	(	&	$query_parser,
		&	$result
	)

Definition at line 456 of file class.ilSearchGUI.php.

References $result, __getFilter(), ilObjectSearchFactory\_getExerciseSearchInstance(), ilObjectSearchFactory\_getForumSearchInstance(), ilObjectSearchFactory\_getGlossaryDefinitionSearchInstance(), ilObjectSearchFactory\_getLMContentSearchInstance(), ilObjectSearchFactory\_getMediaPoolSearchInstance(), ilObjectSearchFactory\_getObjectSearchInstance(), ilObjectSearchFactory\_getTestSearchInstance(), ilObjectSearchFactory\_getWikiContentSearchInstance(), array, and getDetails().

Referenced by performSearch().

         {
                 foreach($this->getDetails() as $type => $enabled)
                 {
                         if(!$enabled)
                         {
                                 continue;
                         }
 
                         switch($type)
                         {
                                 case 'crs':
                                         $crs_search = ilObjectSearchFactory::_getObjectSearchInstance($query_parser);
                                         $crs_search->setFilter(array('crs'));
                                         $result->mergeEntries($crs_search->performSearch());
                                         break;
                                 
                                 case 'grp':
                                         $grp_search = ilObjectSearchFactory::_getObjectSearchInstance($query_parser);
                                         $grp_search->setFilter(array('grp'));
                                         $result->mergeEntries($grp_search->performSearch());
                                         break;
                                 
                                 case 'lms':
                                         $content_search =& ilObjectSearchFactory::_getLMContentSearchInstance($query_parser);
                                         $content_search->setFilter($this->__getFilter());
                                         $result->mergeEntries($content_search->performSearch());
                                         break;
 
                                 case 'frm':
                                         $forum_search =& ilObjectSearchFactory::_getForumSearchInstance($query_parser);
                                         $forum_search->setFilter($this->__getFilter());
                                         $result->mergeEntries($forum_search->performSearch());
                                         break;
 
                                 case 'glo':
                                         // Glossary term definition pages
                                         $gdf_search =& ilObjectSearchFactory::_getLMContentSearchInstance($query_parser);
                                         $gdf_search->setFilter(array('gdf'));
                                         $result->mergeEntries($gdf_search->performSearch());
                                         // Glossary terms
                                         $gdf_term_search =& ilObjectSearchFactory::_getGlossaryDefinitionSearchInstance($query_parser);
                                         $result->mergeEntries($gdf_term_search->performSearch());
                                         break;
 
                                 case 'exc':
                                         $exc_search =& ilObjectSearchFactory::_getExerciseSearchInstance($query_parser);
                                         $exc_search->setFilter($this->__getFilter());
                                         $result->mergeEntries($exc_search->performSearch());
                                         break;
 
                                 case 'mcst':
                                         $mcst_search =& ilObjectSearchFactory::_getMediaCastSearchInstance($query_parser);
                                         $result->mergeEntries($mcst_search->performSearch());
                                         break;
 
                                 case 'tst':
                                         $tst_search =& ilObjectSearchFactory::_getTestSearchInstance($query_parser);
                                         $tst_search->setFilter($this->__getFilter());
                                         $result->mergeEntries($tst_search->performSearch());
                                         break;
 
                                 case 'mep':
                                         $mep_search =& ilObjectSearchFactory::_getMediaPoolSearchInstance($query_parser);
                                         $mep_search->setFilter($this->__getFilter());
                                         $result->mergeEntries($mep_search->performSearch());
                                         
                                         // Mob keyword search
                                         $mob_search = ilObjectSearchFactory::_getMediaPoolSearchInstance($query_parser);
                                         $mob_search->setFilter($this->__getFilter());
                                         $result->mergeEntries($mob_search->performKeywordSearch());
                                         
                                         break;
 
                                 case 'wiki':
                                         $wiki_search =& ilObjectSearchFactory::_getWikiContentSearchInstance($query_parser);
                                         $wiki_search->setFilter($this->__getFilter());
                                         $result->mergeEntries($wiki_search->performSearch());
 
                                         /*$result_meta =& $this->__searchMeta($query_parser,'title');
                                         $result->mergeEntries($result_meta);
                                         $result_meta =& $this->__searchMeta($query_parser,'description');
                                         $result->mergeEntries($result_meta);*/
                                         break;
 
                         }
                 }
                 return $result;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __searchMeta()

& ilSearchGUI::__searchMeta	(	&	$query_parser,
			$a_type
	)

Search in object meta data (keyword)

Returns: object result object public

Definition at line 619 of file class.ilSearchGUI.php.

References $a_type, __getFilter(), ilObjectSearchFactory\_getMetaDataSearchInstance(), getType(), and ilSearchBaseGUI\SEARCH_DETAILS.

Referenced by performSearch().

         {
                 include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
 
                 $meta_search =& ilObjectSearchFactory::_getMetaDataSearchInstance($query_parser);
                 if($this->getType() == ilSearchBaseGUI::SEARCH_DETAILS)
                 {
                         $meta_search->setFilter($this->__getFilter());
                 }
                 switch($a_type)
                 {
                         case 'keyword':
                                 $meta_search->setMode('keyword');
                                 break;
 
                         case 'contribute':
                                 $meta_search->setMode('contribute');
                                 break;
 
                         case 'title':
                                 $meta_search->setMode('title');
                                 break;
 
                         case 'description':
                                 $meta_search->setMode('description');
                                 break;
                 }
             return $meta_search->performSearch();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __searchObjects()

& ilSearchGUI::__searchObjects ( & $query_parser )

Search in obect title,desctiption.

Returns: object result object public

Definition at line 570 of file class.ilSearchGUI.php.

References __getFilter(), ilObjectSearchFactory\_getObjectSearchInstance(), getType(), parseCreationFilter(), and ilSearchBaseGUI\SEARCH_DETAILS.

Referenced by performSearch().

         {
                 include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
 
                 $obj_search =& ilObjectSearchFactory::_getObjectSearchInstance($query_parser);
                 if($this->getType() == ilSearchBaseGUI::SEARCH_DETAILS)
                 {
                         $obj_search->setFilter($this->__getFilter());
                 }
                 
                 $this->parseCreationFilter($obj_search);
                 return $obj_search->performSearch();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ autoComplete()

ilSearchGUI::autoComplete ( )

Data resource for autoComplete.

Definition at line 204 of file class.ilSearchGUI.php.

References $res, array, ilLogLevel\DEBUG, exit, ilSearchAutoComplete\getList(), and ilLoggerFactory\getLogger().

         {
                 if((int) $_REQUEST['search_type'] == -1)
                 {
                         $a_fields = array('login','firstname','lastname','email');
                         $result_field = 'login';
 
                         // Starting user autocomplete search
                         include_once './Services/User/classes/class.ilUserAutoComplete.php';
                         $auto = new ilUserAutoComplete();
 
 
                         $auto->setMoreLinkAvailable(true);
                         $auto->setSearchFields($a_fields);
                         $auto->setResultField($result_field);
                         $auto->enableFieldSearchableCheck(true);
                         $auto->setUserLimitations(true);
 
                         $res = $auto->getList($_REQUEST['term']);
                         
                         $res_obj = json_decode($res);
                         
                         ilLoggerFactory::getLogger('sea')->debug($res);
                         
                         
                         ilLoggerFactory::getLogger('sea')->dump($res_obj->items, ilLogLevel::DEBUG);
                         if(is_array($res_obj->items))
                         {
                                 echo json_encode($res_obj->items);
                                 exit;
                         }
                         
                 }
                 else
                 {
                         $q = $_REQUEST["term"];
                         include_once("./Services/Search/classes/class.ilSearchAutoComplete.php");
                         $list = ilSearchAutoComplete::getList($q);
                         ilLoggerFactory::getLogger('sea')->dump(json_decode($list));
                         echo $list;
                         exit;
                 }
         }

Here is the call graph for this function:

◆ executeCommand()

ilSearchGUI::executeCommand ( )

Control public.

Definition at line 76 of file class.ilSearchGUI.php.

References $cmd, $ilCtrl, ilSearchBaseGUI\getSearchAreaForm(), ilSearchBaseGUI\handleCommand(), initUserSearchCache(), and prepareOutput().

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

Here is the call graph for this function:

◆ getCombination()

ilSearchGUI::getCombination ( )

Definition at line 135 of file class.ilSearchGUI.php.

References ilSearchBaseGUI\SEARCH_OR.

Referenced by __parseQueryString().

         {
                 return $this->combination ? $this->combination : ilSearchBaseGUI::SEARCH_OR;
         }

Here is the caller graph for this function:

◆ getDetails()

ilSearchGUI::getDetails ( )

Definition at line 159 of file class.ilSearchGUI.php.

References array.

Referenced by __getFilter(), __performDetailsSearch(), and performSearch().

         {
                 return $this->details ? $this->details : array();
         }

Here is the caller graph for this function:

◆ getRootNode()

ilSearchGUI::getRootNode ( )

Definition at line 165 of file class.ilSearchGUI.php.

Referenced by performSearch(), and showSavedResults().

         {
                 return $this->root_node ? $this->root_node : ROOT_FOLDER_ID;
         }

Here is the caller graph for this function:

◆ getString()

ilSearchGUI::getString ( )

Definition at line 147 of file class.ilSearchGUI.php.

References $string.

Referenced by __parseQueryString(), and showSearch().

         {
                 return $this->string;
         }

Here is the caller graph for this function:

◆ getType()

ilSearchGUI::getType ( )

Definition at line 123 of file class.ilSearchGUI.php.

References ilSearchBaseGUI\SEARCH_FAST.

Referenced by __getFilter(), __searchMeta(), __searchObjects(), and performSearch().

         {
                 return $this->type ? $this->type : ilSearchBaseGUI::SEARCH_FAST;
         }

Here is the caller graph for this function:

◆ initUserSearchCache()

ilSearchGUI::initUserSearchCache ( )

protected

Init user search cache.

private

Definition at line 727 of file class.ilSearchGUI.php.

References $_GET, $_POST, $ilUser, ilUserSearchCache\_getInstance(), ilUserSearchCache\DEFAULT_SEARCH, ilSearchBaseGUI\loadCreationFilter(), and ilUtil\stripSlashes().

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseCreationFilter()

ilSearchGUI::parseCreationFilter ( ilObjectSearch $search )

Definition at line 584 of file class.ilSearchGUI.php.

References $options, ilObjectSearch\CDATE_OPERATOR_AFTER, ilObjectSearch\CDATE_OPERATOR_BEFORE, ilObjectSearch\CDATE_OPERATOR_ON, ilSearchBaseGUI\getSearchCache(), IL_CAL_UNIX, ilObjectSearch\setCreationDateFilterDate(), and ilObjectSearch\setCreationDateFilterOperator().

Referenced by __searchObjects().

         {
                 $options = $this->getSearchCache()->getCreationFilter();
                 
                 if(!$options['enabled'])
                 {
                         return TRUE;
                 }
                 $limit = new ilDate($options['date'],IL_CAL_UNIX);
                 $search->setCreationDateFilterDate($limit);
                 
                 switch($options['ontype'])
                 {
                         case 1:
                                 $search->setCreationDateFilterOperator(ilObjectSearch::CDATE_OPERATOR_AFTER);
                                 break;
                                 
                         case 2:
                                 $search->setCreationDateFilterOperator(ilObjectSearch::CDATE_OPERATOR_BEFORE);
                                 break;
                                 
                         case 3:
                                 $search->setCreationDateFilterOperator(ilObjectSearch::CDATE_OPERATOR_ON);
                                 break;
                 }
                 
                 return TRUE;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performSearch()

ilSearchGUI::performSearch ( )

Perform search.

Definition at line 341 of file class.ilSearchGUI.php.

References $_GET, $_SESSION, $ilUser, $result, __parseQueryString(), __performDetailsSearch(), __searchMeta(), __searchObjects(), ilSearchBaseGUI\addPager(), getDetails(), getRootNode(), getType(), ilSearchResultPresentation\MODE_STANDARD, ilSearchResult\read(), ilSearchBaseGUI\SEARCH_DETAILS, ilUtil\sendInfo(), and showSearch().

Referenced by remoteSearch(), and storeRoot().

         {
                 global $ilUser;
                 
                 if(!isset($_GET['page_number']) and $this->search_mode != 'in_results' )
                 {
                         unset($_SESSION['max_page']);
                         $this->search_cache->deleteCachedEntries();
                 }
 
                 if($this->getType() == ilSearchBaseGUI::SEARCH_DETAILS and !$this->getDetails())
                 {
                         ilUtil::sendInfo($this->lng->txt('search_choose_object_type'));
                         $this->showSearch();
                         return false;
                 }
 
                 // Step 1: parse query string
                 if(!is_object($query_parser =& $this->__parseQueryString()))
                 {
                         ilUtil::sendInfo($query_parser);
                         $this->showSearch();
                         
                         return false;
                 }
                 // Step 2: perform object search. Get an ObjectSearch object via factory. Depends on fulltext or like search type.
                 $result =& $this->__searchObjects($query_parser);
 
                 // Step 3: perform meta keyword search. Get an MetaDataSearch object.
                 $result_meta =& $this->__searchMeta($query_parser,'keyword');
                 $result->mergeEntries($result_meta);
 
                 $result_meta =& $this->__searchMeta($query_parser,'contribute');
                 $result->mergeEntries($result_meta);
         
                 $result_meta =& $this->__searchMeta($query_parser,'title');
                 $result->mergeEntries($result_meta);
         
                 $result_meta =& $this->__searchMeta($query_parser,'description');
                 $result->mergeEntries($result_meta);
         
                 // Perform details search in object specific tables
                 if($this->getType() == ilSearchBaseGUI::SEARCH_DETAILS)
                 {
                         $result = $this->__performDetailsSearch($query_parser,$result);
                 }
                 // Step 5: Search in results
                 if($this->search_mode == 'in_results')
                 {
                         include_once 'Services/Search/classes/class.ilSearchResult.php';
 
                         $old_result_obj = new ilSearchResult($ilUser->getId());
                         $old_result_obj->read();
 
                         $result->diffEntriesFromResult($old_result_obj);
                 }
                         
 
                 // Step 4: merge and validate results
                 $result->filter($this->getRootNode(),$query_parser->getCombination() == 'and');
                 $result->save();
                 $this->showSearch();
 
                 if(!count($result->getResults()))
                 {
                         ilUtil::sendInfo($this->lng->txt('search_no_match'));
                 }
 
                 if($result->isLimitReached())
                 {
                         #$message = sprintf($this->lng->txt('search_limit_reached'),$this->settings->getMaxHits());
                         #ilUtil::sendInfo($message);
                 }
 
                 // Step 6: show results
                 $this->addPager($result,'max_page');
                 
                 include_once './Services/Search/classes/class.ilSearchResultPresentation.php';
                 $presentation = new ilSearchResultPresentation($this, ilSearchResultPresentation::MODE_STANDARD);
                 $presentation->setResults($result->getResultsForPresentation());
                 $presentation->setSubitemIds($result->getSubitemIds());
                 $presentation->setPreviousNext($this->prev_link, $this->next_link);
 
                 if($presentation->render())
                 {
 //                      $this->tpl->setVariable('SEARCH_RESULTS',$presentation->getHTML());
                         $this->tpl->setVariable('RESULTS_TABLE',$presentation->getHTML(true));
                 }
 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareOutput()

ilSearchGUI::prepareOutput ( )

Definition at line 435 of file class.ilSearchGUI.php.

References settings().

Referenced by executeCommand().

         {
                 global $ilTabs, $ilHelp;
                 
                 parent::prepareOutput();
                 
                 $ilHelp->setScreenIdComponent("src");
 
                 $ilTabs->addTab("search", $this->lng->txt("search"),
                         $this->ctrl->getLinkTarget($this));
                 
                 if (!$this->settings->getHideAdvancedSearch())
                 {
                         $ilTabs->addTab("adv_search", $this->lng->txt("search_advanced"),
                                 $this->ctrl->getLinkTargetByClass('iladvancedsearchgui'));
                 }
                 
                 $ilTabs->activateTab("search");
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remoteSearch()

ilSearchGUI::remoteSearch ( )

Definition at line 175 of file class.ilSearchGUI.php.

References $_POST, performSearch(), setRootNode(), setString(), and ilUtil\stripSlashes().

         {
                 $this->setString(ilUtil::stripSlashes($_POST['queryString']));
                 $this->setRootNode((int) $_POST['root_id']);
                 $this->performSearch();
                 
         }

Here is the call graph for this function:

◆ setCombination()

ilSearchGUI::setCombination ( $a_combination )

Set/get combination of search ('and' or 'or') public.

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

References $_SESSION.

Referenced by __construct().

         {
                 $_SESSION['search']['combination'] = $this->combination = $a_combination;
         }

Here is the caller graph for this function:

◆ setDetails()

ilSearchGUI::setDetails ( $a_details )

Set/get details (object types for details search) public.

Definition at line 155 of file class.ilSearchGUI.php.

References $_SESSION.

Referenced by __construct().

         {
                 $_SESSION['search']['details'] = $this->details = $a_details;
         }

Here is the caller graph for this function:

◆ setRootNode()

ilSearchGUI::setRootNode ( $a_node_id )

Definition at line 169 of file class.ilSearchGUI.php.

References $_SESSION.

Referenced by remoteSearch().

         {
                 $_SESSION['search_root'] = $this->root_node = $a_node_id;
         }

Here is the caller graph for this function:

◆ setString()

ilSearchGUI::setString ( $a_str )

Set/get search string public.

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

References $_SESSION.

Referenced by __construct(), and remoteSearch().

         {
                 $_SESSION['search']['string'] = $this->string = $a_str;
         }

Here is the caller graph for this function:

◆ setType()

ilSearchGUI::setType ( $a_type )

Set/get type of search (detail or 'fast' search) public.

Definition at line 119 of file class.ilSearchGUI.php.

References $_SESSION, and $a_type.

Referenced by __construct().

         {
                 $_SESSION['search']['type'] = $this->type = $a_type;
         }

Here is the caller graph for this function:

◆ showSavedResults()

ilSearchGUI::showSavedResults ( )

Definition at line 302 of file class.ilSearchGUI.php.

References $ilUser, ilSearchBaseGUI\addPager(), getRootNode(), ilSearchResultPresentation\MODE_STANDARD, ilSearchResult\read(), and showSearch().

         {
                 global $ilUser;
 
                 // Read old result sets
                 include_once 'Services/Search/classes/class.ilSearchResult.php';
         
                 $result_obj = new ilSearchResult($ilUser->getId());
                 $result_obj->read();
                 $result_obj->filterResults($this->getRootNode());
 
                 $this->showSearch();
 
                 // Show them
                 if(count($result_obj->getResults()))
                 {
                         $this->addPager($result_obj,'max_page');
 
                         include_once './Services/Search/classes/class.ilSearchResultPresentation.php';
                         $presentation = new ilSearchResultPresentation($this, ilSearchResultPresentation::MODE_STANDARD);
                         $presentation->setResults($result_obj->getResultsForPresentation());
                         $presentation->setSubitemIds($result_obj->getSubitemIds());
                         $presentation->setPreviousNext($this->prev_link, $this->next_link);
                         #$presentation->setSearcher($searcher);
 
                         if($presentation->render())
                         {
 //                              $this->tpl->setVariable('SEARCH_RESULTS',$presentation->getHTML());
                                 $this->tpl->setVariable('RESULTS_TABLE',$presentation->getHTML(true));
                         }
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ showSearch()

ilSearchGUI::showSearch ( )

Definition at line 248 of file class.ilSearchGUI.php.

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

Referenced by performSearch(), and showSavedResults().

         {
                 global $ilLocator, $ilCtrl, $lng;
                 
                 // 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->addBlockFile('ADM_CONTENT','adm_content','tpl.search.html','Services/Search');
                 $this->tpl->setVariable("FORM_ACTION", $ilCtrl->getFormAction($this,'performSearch'));
                 $this->tpl->setVariable("TERM", ilUtil::prepareFormOutput($this->getString()));
                 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'));
 
                 if (ilSearchSettings::getInstance()->isLuceneItemFilterEnabled())
                 {
                         $this->tpl->setCurrentBlock("type_sel");
                         $this->tpl->setVariable('TXT_TYPE_DEFAULT',$lng->txt("search_fast_info"));
                         $this->tpl->setVariable("TXT_TYPE", $lng->txt("search_type"));
                         $this->initStandardSearchForm(ilSearchBaseGUI::SEARCH_FORM_STANDARD);
                         $this->tpl->setVariable("ARR_IMGT", ilGlyphGUI::get(ilGlyphGUI::CARET));
                         $this->tpl->setVariable("FORM", $this->form->getHTML());
                         $this->tpl->parseCurrentBlock();
                 }
                 
                 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
                 }
                 
 
                 $this->tpl->setVariable("TXT_AREA", $lng->txt("search_area"));
 
                 // search area form
                 $this->tpl->setVariable('SEARCH_AREA_FORM', $this->getSearchAreaForm()->getHTML());
 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeRoot()

ilSearchGUI::storeRoot ( )

protected

Store new root node.

Definition at line 186 of file class.ilSearchGUI.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

◆ $combination

ilSearchGUI::$combination

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

◆ $root_node

ilSearchGUI::$root_node

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

◆ $search_cache

ilSearchGUI::$search_cache = null

protected

Definition at line 24 of file class.ilSearchGUI.php.

◆ $string

ilSearchGUI::$string

Definition at line 28 of file class.ilSearchGUI.php.

Referenced by getString().

◆ $type

ilSearchGUI::$type

Definition at line 29 of file class.ilSearchGUI.php.

Referenced by __construct().

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

Services/Search/classes/class.ilSearchGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __getFilter()

◆ __parseQueryString()

◆ __performDetailsSearch()

◆ __searchMeta()

◆ __searchObjects()

◆ autoComplete()

◆ executeCommand()

◆ getCombination()

◆ getDetails()

◆ getRootNode()

◆ getString()

◆ getType()

◆ initUserSearchCache()

◆ parseCreationFilter()

◆ performSearch()

◆ prepareOutput()

◆ remoteSearch()

◆ setCombination()

◆ setDetails()

◆ setRootNode()

◆ setString()

◆ setType()

◆ showSavedResults()

◆ showSearch()

◆ storeRoot()

Field Documentation

◆ $combination

◆ $root_node

◆ $search_cache

◆ $string

◆ $type