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

Inheritance diagram for ilLuceneAdvancedSearchGUI:

Collaboration diagram for ilLuceneAdvancedSearchGUI:

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

	executeCommand ()
	Execute Command. More...

	showSavedResults ()
	Show saved results. More...

	prepareOutput ()
	Add admin panel command. More...

Public Member Functions inherited from ilSearchBaseGUI
	__construct ()

	prepareOutput ()

	initStandardSearchForm (int $a_mode)

	getSearchAreaForm ()

	handleCommand (string $a_cmd)

	addToDeskObject ()

	removeFromDeskObject ()

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

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	initFormSearch ()
	Show search form. More...

	remoteSearch ()
	Search from main menu. More...

	search ()

	reset ()
	Reset search form. More...

	performSearch ()
	Perform search. More...

	getTabs ()
	get tabs More...

	initUserSearchCache ()
	Init user search cache. More...

	fillAdminPanel ()

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_gui

ilHelpGUI	$help

ilLuceneAdvancedSearchFields	$fields

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 Meta Data search GUI

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

ilLuceneAdvancedSearchGUI: ilSearchControllerGUI ilLuceneAdvancedSearchGUI: ilObjectGUI, ilContainerGUI ilLuceneAdvancedSearchGUI: ilObjCategoryGUI, ilObjCourseGUI, ilObjFolderGUI, ilObjGroupGUI ilLuceneAdvancedSearchGUI: ilObjStudyProgrammeGUI ilLuceneAdvancedSearchGUI: ilObjRootFolderGUI, ilObjectCopyGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilLuceneAdvancedSearchGUI::__construct ( )

Constructor.

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ilLuceneAdvancedSearchFields\getInstance(), ILIAS\Repository\help(), and initUserSearchCache().

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

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilLuceneAdvancedSearchGUI::executeCommand ( )

Execute Command.

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

References ILIAS\Repository\ctrl(), ilSearchBaseGUI\handleCommand(), and prepareOutput().

                                     : void
     {
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
 
         $this->prepareOutput();
         switch ($next_class) {
             case 'ilobjectcopygui':
                 $this->ctrl->setReturn($this);
                 $cp = new ilObjectCopyGUI($this);
                 $this->ctrl->forwardCommand($cp);
                 break;
 
 
             default:
                 if (!$cmd) {
                     $cmd = "showSavedResults";
                 }
                 $this->handleCommand($cmd);
                 break;
         }
     }

Here is the call graph for this function:

◆ fillAdminPanel()

ilLuceneAdvancedSearchGUI::fillAdminPanel ( )

protected

Todo:: Couldn't find any of these template variables anywhere.

Is this still currently used?

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

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

Referenced by performSearch(), and showSavedResults().

                                        : void
     {
         $adm_view_cmp = $adm_cmds = $creation_selector = $adm_view = false;
 
         // admin panel commands
         if (isset($this->admin_panel_commands) && (count((array) $this->admin_panel_commands) > 0)) {
             foreach ($this->admin_panel_commands as $cmd) {
                 $this->tpl->setCurrentBlock("lucene_admin_panel_cmd");
                 $this->tpl->setVariable("LUCENE_PANEL_CMD", $cmd["cmd"]);
                 $this->tpl->setVariable("LUCENE_TXT_PANEL_CMD", $cmd["txt"]);
                 $this->tpl->parseCurrentBlock();
             }
 
             $adm_cmds = true;
         }
         if ($adm_cmds) {
             $this->tpl->setCurrentBlock("lucene_adm_view_components");
             $this->tpl->setVariable("LUCENE_ADM_IMG_ARROW", ilUtil::getImagePath("nav/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 (isset($this->admin_view_button) && 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 (isset($this->creation_selector) && is_array($this->creation_selector)) {
             $this->tpl->setCurrentBlock("lucene_add_commands");
             if ($adm_cmds) {
                 $this->tpl->setVariable("LUCENE_ADD_COM_WIDTH", 'width="1"');
             }
             $this->tpl->setVariable(
                 "LUCENE_SELECT_OBJTYPE_REPOS",
                 $this->creation_selector["options"]
             );
             $this->tpl->setVariable(
                 "LUCENE_BTN_NAME_REPOS",
                 $this->creation_selector["command"]
             );
             $this->tpl->setVariable(
                 "LUCENE_TXT_ADD_REPOS",
                 $this->creation_selector["txt"]
             );
             $this->tpl->parseCurrentBlock();
             $creation_selector = true;
         }
         if ($adm_view || $creation_selector) {
             $this->tpl->setCurrentBlock("lucene_adm_panel");
             if ($adm_view_cmp) {
                 $this->tpl->setVariable("LUCENE_ADM_TBL_WIDTH", 'width:"100%";');
             }
             $this->tpl->parseCurrentBlock();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTabs()

ilLuceneAdvancedSearchGUI::getTabs ( )

protected

get tabs

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

References ILIAS\Repository\ctrl(), ilSearchSettings\getInstance(), and ILIAS\Repository\help().

Referenced by prepareOutput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFormSearch()

ilLuceneAdvancedSearchGUI::initFormSearch ( )

protected

Show search form.

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

References ilSearchBaseGUI\$form, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), and ILIAS\Repository\lng().

Referenced by performSearch(), and showSavedResults().

                                        : void
     {
         $this->form = new ilPropertyFormGUI();
         $this->form->setFormAction($this->ctrl->getFormAction($this, 'search'));
         $this->form->setTitle($this->lng->txt('search_advanced'));
         $this->form->addCommandButton('search', $this->lng->txt('search'));
         $this->form->addCommandButton('reset', $this->lng->txt('reset'));
 
         foreach ($this->fields->getActiveSections() as $definition) {
             if ($definition['name'] != 'default') {
                 $section = new ilFormSectionHeaderGUI();
                 $section->setTitle($definition['name']);
                 $this->form->addItem($section);
             }
 
             foreach ($definition['fields'] as $field_name) {
                 if (is_object($element = $this->fields->getFormElement($this->search_cache->getQuery(), $field_name, $this->form))) {
                     $this->form->addItem($element);
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserSearchCache()

ilLuceneAdvancedSearchGUI::initUserSearchCache ( )

protected

Init user search cache.

private

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

References ilUserSearchCache\_getInstance(), ILIAS\FileDelivery\http(), ilSearchBaseGUI\initPageNumberFromQuery(), ilUserSearchCache\LUCENE_ADVANCED, and ILIAS\Repository\user().

Referenced by __construct().

                                             : void
     {
         $this->search_cache = ilUserSearchCache::_getInstance($this->user->getId());
         $this->search_cache->switchSearchType(ilUserSearchCache::LUCENE_ADVANCED);
         $page_number = $this->initPageNumberFromQuery();
         if ($page_number) {
             $this->search_cache->setResultPageNumber($page_number);
         }
         if ($this->http->wrapper()->post()->has('query')) {
             $this->search_cache->setQuery($this->http->request()->getParsedBody()['query'] ?? []);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performSearch()

ilLuceneAdvancedSearchGUI::performSearch ( )

protected

Perform search.

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

References ilSearchBaseGUI\addPager(), ilSession\clear(), fillAdminPanel(), ILIAS\Repository\form(), ilLuceneSearcher\getInstance(), ilLuceneSearchResultFilter\getInstance(), initFormSearch(), ILIAS\Repository\lng(), ilLuceneAdvancedQueryParser\parse(), showSavedResults(), and ILIAS\Repository\user().

Referenced by search().

                                       : void
     {
         ilSession::clear('vis_references');
         $qp = new ilLuceneAdvancedQueryParser($this->search_cache->getQuery());
         $qp->parse();
         if (!strlen(trim($qp->getQuery()))) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('msg_no_search_string'));
             $this->showSavedResults();
             return;
         }
 
         $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->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lucene_adv_search.html', 'Services/Search');
         $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', $this->lng->txt('search_no_match'));
         }
 
         // and finally add search form
         $this->initFormSearch();
         $this->tpl->setVariable('SEARCH_TABLE', $this->form->getHTML());
 
         if ($filter->getResultIds()) {
             $this->fillAdminPanel();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareOutput()

ilLuceneAdvancedSearchGUI::prepareOutput ( )

Add admin panel command.

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

References getTabs().

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remoteSearch()

ilLuceneAdvancedSearchGUI::remoteSearch ( )

protected

Search from main menu.

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

References ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and search().

                                      : void
     {
         $root_id = 0;
         if ($this->http->wrapper()->post()->has('root_id')) {
             $root_id = $this->http->wrapper()->post()->retrieve(
                 'root_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         $queryString = '';
         if ($this->http->wrapper()->post()->has('queryString')) {
             $queryString = $this->http->wrapper()->post()->retrieve(
                 'queryString',
                 $this->refinery->kindlyTo()->string()
             );
         }
         $this->search_cache->setRoot($root_id);
         $this->search_cache->setQuery(['lom_content' => $queryString]);
         $this->search_cache->save();
         $this->search();
     }

Here is the call graph for this function:

◆ reset()

ilLuceneAdvancedSearchGUI::reset ( )

protected

Reset search form.

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

References showSavedResults().

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

Here is the call graph for this function:

◆ search()

ilLuceneAdvancedSearchGUI::search ( )

protected

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

References ilSession\clear(), ILIAS\Repository\lng(), performSearch(), ilSubItemListGUI\resetDetails(), and showSavedResults().

Referenced by remoteSearch().

                                : void
     {
         if (!is_array($this->search_cache->getQuery())) {
             // TOD: handle empty advances search
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('msg_no_search_string'));
             $this->showSavedResults();
             return;
         }
         ilSession::clear('max_page');
         $this->search_cache->deleteCachedEntries();
 
         // Reset details
         ilSubItemListGUI::resetDetails();
 
         $this->performSearch();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSavedResults()

ilLuceneAdvancedSearchGUI::showSavedResults ( )

Show saved results.

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

References ilSearchBaseGUI\addPager(), fillAdminPanel(), ILIAS\Repository\form(), ilLuceneSearcher\getInstance(), ilLuceneSearchResultFilter\getInstance(), initFormSearch(), ILIAS\Repository\lng(), ilLuceneAdvancedQueryParser\parse(), and ILIAS\Repository\user().

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

                                       : void
     {
         $qp = new ilLuceneAdvancedQueryParser($this->search_cache->getQuery());
         $qp->parse();
         $searcher = ilLuceneSearcher::getInstance($qp);
         $searcher->search();
 
         // Load saved results
         $filter = ilLuceneSearchResultFilter::getInstance($this->user->getId());
         $filter->loadFromDb();
 
         // Highlight
         if ($filter->getResultObjIds()) {
             $searcher->highlight($filter->getResultObjIds());
         }
 
         $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lucene_adv_search.html', 'Services/Search');
         $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());
         } elseif (strlen(trim($qp->getQuery()))) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('search_no_match'));
         }
 
         // and finally add search form
         $this->initFormSearch();
         $this->tpl->setVariable('SEARCH_TABLE', $this->form->getHTML());
 
         if ($filter->getResultIds()) {
             $this->fillAdminPanel();
         }
     }