ilSearchGUI Class Reference

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

Inheritance diagram for ilSearchGUI:

Collaboration diagram for ilSearchGUI:

Public Member Functions
	__construct ()
	Constructor public. More...
	executeCommand ()
	Control public. More...
	setType (int $a_type)
	Set/get type of search (detail or 'fast' search) public. More...
	getType ()
	setCombination (string $a_combination)
	Set/get combination of search ('and' or 'or') public. More...
	getCombination ()
	setString (string $a_str)
	Set/get search string public. More...
	getString ()
	setDetails (array $a_details)
	Set/get details (object types for details search) public. More...
	getDetails ()
	getRootNode ()
	setRootNode (int $a_node_id)
	remoteSearch ()
	autoComplete ()
	Data resource for autoComplete. More...
	showSearch ()
	showSavedResults ()
	performSearch ()
	Perform search. More...
	prepareOutput ()
	__parseQueryString ()
	parse query string, using query parser instance More...
	__searchObjects (ilQueryParser $query_parser)
	Search in obect title,desctiption. More...
	parseCreationFilter (ilObjectSearch $search)
	__searchMeta (ilQueryParser $query_parser, string $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 ()
	prepareOutput ()
	initStandardSearchForm (int $a_mode)
	getSearchAreaForm ()
	handleCommand (string $a_cmd)
	addToDeskObject ()
	Add desktop item public. More...
	removeFromDeskObject ()
	Remove from desktop public. More...
	delete ()
	Show delete confirmation. More...
	cancelDelete ()
	Cancel delete. More...
	cancelObject ()
	cancelMoveLinkObject ()
	performDelete ()
	cut ()
	link ()
	paste ()
	showLinkIntoMultipleObjectsTree ()
	showPasteTree ()
	showMoveIntoObjectTree ()
	performPasteIntoMultipleObjects ()
	clear ()
	clear clipboard More...
	enableAdministrationPanel ()
	disableAdministrationPanel ()
	keepObjectsInClipboardObject ()
	addLocator ()
	autoComplete ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Data Fields
int	$root_node
string	$combination
string	$string
int	$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

Protected Member Functions
	storeRoot ()
	Store new root node. More...
	__performDetailsSearch (ilQueryParser $query_parser, ilSearchResult $result)
	parseDateFromCreationFilter ()
	parseOperatorFromCreationFilter ()
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_gui
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 = ''

Private Attributes
array	$details

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 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 ilSearchGUI: ilPropertyFormGUI ilSearchGUI: ilObjectGUI, ilContainerGUI ilSearchGUI: ilObjCategoryGUI, ilObjCourseGUI, ilObjFolderGUI, ilObjGroupGUI ilSearchGUI: ilObjStudyProgrammeGUI ilSearchGUI: ilObjRootFolderGUI, ilObjectCopyGUI

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

Constructor & Destructor Documentation

__construct()

ilSearchGUI::__construct

(

)

Constructor public.

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

References $DIC, $type, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\form(), ilSession\get(), ilSearchSettings\getInstance(), ilSearchBaseGUI\getSearchCache(), ILIAS\FileDelivery\http(), ilSearchBaseGUI\initStandardSearchForm(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilSearchBaseGUI\loadCreationFilter(), ilSearchSettings\OPERATOR_AND, ILIAS\Repository\refinery(), ROOT_FOLDER_ID, ilSearchBaseGUI\SEARCH_FAST, ilSearchBaseGUI\SEARCH_FORM_STANDARD, ilSession\set(), setCombination(), setDetails(), setString(), setType(), and ilUtil\stripSlashes().

    {
        global $DIC;
        parent::__construct();
        $this->tabs_gui = $DIC->tabs();
        $this->help_gui = $DIC->help();
        $this->lng->loadLanguageModule("search");

        $post_search = (array) ($this->http->request()->getParsedBody()['search'] ?? []);
        $post_filter_type = (array) ($this->http->request()->getParsedBody()['filter_type'] ?? []);
        $post_cmd = (array) ($this->http->request()->getParsedBody()['cmd'] ?? []);
        $new_search = (bool) ($post_cmd['performSearch'] ?? false);

        // put form values into "old" post variables
        $this->initStandardSearchForm(ilSearchBaseGUI::SEARCH_FORM_STANDARD);

        if ($new_search) {
            // Only call `checkInput` if this is a new POST request, otherwise a `failure` will be shown (red message)
            $this->form->checkInput();
        }

        $enabled_types = ilSearchSettings::getInstance()->getEnabledLuceneItemFilterDefinitions();
        foreach ($enabled_types as $type => $pval) {
            if (isset($post_filter_type[$type]) && $post_filter_type[$type] == 1) {
                $post_search["details"][$type] = $post_filter_type[$type];
            }
        }

        $post_term = $this->http->wrapper()->post()->retrieve(
            'term',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always(null)
            ])
        );
        $post_combination = $this->http->wrapper()->post()->retrieve(
            'combination',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always(null)
            ])
        );
        $post_type = $this->http->wrapper()->post()->retrieve(
            'type',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->int(),
                $this->refinery->always(null)
            ])
        );
        $post_area = $this->http->wrapper()->post()->retrieve(
            'area',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->int(),
                $this->refinery->always(null)
            ])
        );

        if ($new_search) {
            ilSession::set('search_root', $post_area);
        }

        $post_search["string"] = $post_term;
        $post_search["combination"] = $post_combination;
        $post_search["type"] = $post_type;

        $this->root_node = (int) (ilSession::get('search_root') ?? ROOT_FOLDER_ID);

        $session_search = ilSession::get('search') ?? [];
        $this->setType((int) ($post_search['type'] ?? ($session_search['type'] ?? ilSearchBaseGUI::SEARCH_FAST)));

        $this->setCombination(
            ilSearchSettings::getInstance()->getDefaultOperator() == ilSearchSettings::OPERATOR_AND ?
                self::SEARCH_AND :
                self::SEARCH_OR
        );
        $this->setString((string) ($post_search['string'] ?? ($session_search['string'] ?? '')));
        $this->setDetails(
            $new_search ?
                ($post_search['details'] ?? []) :
                ($session_search['details'] ?? [])
        );

        if ($new_search) {
            $this->getSearchCache()->setQuery(ilUtil::stripSlashes($post_term));
            $this->getSearchCache()->setCreationFilter($this->loadCreationFilter());
            $this->getSearchCache()->save();
        }
    }

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

string[]

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

References ILIAS\LTI\ToolProvider\$key, getDetails(), getType(), and ilSearchBaseGUI\SEARCH_DETAILS.

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

                                 : array
    {
        if ($this->getType() != ilSearchBaseGUI::SEARCH_DETAILS) {
            return [];
        }

        $filter = [];
        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;
    }

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

ilQueryParser | string

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

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

Referenced by performSearch().

    {
        $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 ( ilQueryParser  $query_parser, ilSearchResult  $result  )

protected

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

References ILIAS\LTI\ToolProvider\$enabled, __getFilter(), ilObjectSearchFactory\_getExerciseSearchInstance(), ilObjectSearchFactory\_getForumSearchInstance(), ilObjectSearchFactory\_getGlossaryDefinitionSearchInstance(), ilObjectSearchFactory\_getLMContentSearchInstance(), ilObjectSearchFactory\_getMediacastSearchInstance(), ilObjectSearchFactory\_getMediaPoolSearchInstance(), ilObjectSearchFactory\_getObjectSearchInstance(), ilObjectSearchFactory\_getTestSearchInstance(), ilObjectSearchFactory\_getWikiContentSearchInstance(), getDetails(), and ilSearchResult\mergeEntries().

Referenced by performSearch().

                                                                                                  : ilSearchResult
    {
        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	(	ilQueryParser	$query_parser,
		string	$a_type
	)

Search in object meta data (keyword)

Returns

ilSearchResult result object public

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

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

Referenced by performSearch().

                                                                             : ilSearchResult
    {
        $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

(

ilQueryParser

$query_parser

)

Search in obect title,desctiption.

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

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

Referenced by performSearch().

                                                                : ilSearchResult
    {
        $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 284 of file class.ilSearchGUI.php.

References $query, $res, exit, ilSearchAutoComplete\getList(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                  : void
    {
        $query = '';
        if ($this->http->wrapper()->post()->has('term')) {
            $query = $this->http->wrapper()->post()->retrieve(
                'term',
                $this->refinery->kindlyTo()->string()
            );
        } elseif ($this->http->wrapper()->query()->has('term')) {
            $query = $this->http->wrapper()->query()->retrieve(
                'term',
                $this->refinery->kindlyTo()->string()
            );
        }
        $search_type = 0;
        if ($this->http->wrapper()->post()->has('search_type')) {
            $search_type = $this->http->wrapper()->post()->retrieve(
                'search_type',
                $this->refinery->kindlyTo()->int()
            );
        } elseif ($this->http->wrapper()->query()->has('search_type')) {
            $search_type = $this->http->wrapper()->query()->retrieve(
                'search_type',
                $this->refinery->kindlyTo()->int()
            );
        }
        if ((int) $search_type === -1) {
            $a_fields = array('login','firstname','lastname','email');
            $result_field = 'login';

            // Starting user autocomplete search
            $auto = new ilUserAutoComplete();


            $auto->setMoreLinkAvailable(true);
            $auto->setSearchFields($a_fields);
            $auto->setResultField($result_field);
            $auto->enableFieldSearchableCheck(true);
            $auto->setUserLimitations(true);

            $res = $auto->getList($query);
            $res_obj = json_decode($res);
            if (is_array($res_obj->items)) {
                echo json_encode($res_obj->items);
                exit;
            }
        } else {
            $list = ilSearchAutoComplete::getList($query);
            echo $list;
            exit;
        }
    }

Here is the call graph for this function:

executeCommand()

ilSearchGUI::executeCommand

(

)

Control public.

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

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

                                    : void
    {
        $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();
                $this->ctrl->setReturn($this, 'storeRoot');
                $this->ctrl->forwardCommand($form);
                return;

            case 'ilobjectcopygui':
                $this->prepareOutput();
                $this->ctrl->setReturn($this, '');
                $cp = new ilObjectCopyGUI($this);
                $this->ctrl->forwardCommand($cp);
                break;

            default:
                if (!$cmd) {
                    $cmd = "showSavedResults";
                }
                $this->prepareOutput();
                $this->handleCommand($cmd);
                break;
        }
    }

Here is the call graph for this function:

getCombination()

ilSearchGUI::getCombination

(

)

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

References ilSearchBaseGUI\SEARCH_OR.

Referenced by __parseQueryString().

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

Here is the caller graph for this function:

getDetails()

ilSearchGUI::getDetails

(

)

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

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

                                : array
    {
        return $this->details ?? [];
    }

Here is the caller graph for this function:

getRootNode()

ilSearchGUI::getRootNode

(

)

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

References ROOT_FOLDER_ID.

Referenced by performSearch(), and showSavedResults().

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

Here is the caller graph for this function:

getString()

ilSearchGUI::getString

(

)

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

References $string.

Referenced by __parseQueryString(), and showSearch().

                               : string
    {
        return $this->string;
    }

Here is the caller graph for this function:

getType()

ilSearchGUI::getType

(

)

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

References ilSearchBaseGUI\SEARCH_FAST.

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

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

Here is the caller graph for this function:

parseCreationFilter()

ilSearchGUI::parseCreationFilter

(

ilObjectSearch

$search

)

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

References parseDateFromCreationFilter(), parseOperatorFromCreationFilter(), ilObjectSearch\setCreationDateFilterDate(), and ilObjectSearch\setCreationDateFilterOperator().

Referenced by __searchObjects().

                                                               : bool
    {
        $date = $this->parseDateFromCreationFilter();
        $operator = $this->parseOperatorFromCreationFilter();

        if (is_null($date) || is_null($operator)) {
            return true;
        }

        $search->setCreationDateFilterDate($date);
        $search->setCreationDateFilterOperator($operator);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseDateFromCreationFilter()

ilSearchGUI::parseDateFromCreationFilter ( )

protected

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

References ilSearchBaseGUI\getSearchCache(), and IL_CAL_UNIX.

Referenced by parseCreationFilter(), and performSearch().

                                                    : ?ilDate
    {
        $options = $this->getSearchCache()->getCreationFilter();
        if (!($options['enabled'] ?? false)) {
            return null;
        }
        return new ilDate($options['date'] ?? 0, IL_CAL_UNIX);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseOperatorFromCreationFilter()

ilSearchGUI::parseOperatorFromCreationFilter ( )

protected

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

References ilObjectSearch\CDATE_OPERATOR_AFTER, ilObjectSearch\CDATE_OPERATOR_BEFORE, ilObjectSearch\CDATE_OPERATOR_ON, and ilSearchBaseGUI\getSearchCache().

Referenced by parseCreationFilter(), and performSearch().

                                                        : ?int
    {
        $options = $this->getSearchCache()->getCreationFilter();
        if (!($options['enabled'] ?? false)) {
            return null;
        }

        switch ($options['ontype'] ?? 0) {
            case 1:
                return ilObjectSearch::CDATE_OPERATOR_AFTER;

            case 2:
                return ilObjectSearch::CDATE_OPERATOR_BEFORE;

            case 3:
                return ilObjectSearch::CDATE_OPERATOR_ON;

            default:
                return null;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

performSearch()

ilSearchGUI::performSearch

(

)

Perform search.

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

References __parseQueryString(), __performDetailsSearch(), __searchMeta(), __searchObjects(), ilSearchBaseGUI\addPager(), ilSession\clear(), getDetails(), ilSearchSettings\getInstance(), getRootNode(), getType(), ilSearchBaseGUI\initPageNumberFromQuery(), ILIAS\Repository\lng(), ilSearchResultPresentation\MODE_STANDARD, ilSearchSettings\OPERATOR_AND, parseDateFromCreationFilter(), parseOperatorFromCreationFilter(), ilSearchResult\read(), ilSearchBaseGUI\SEARCH_DETAILS, showSearch(), and ILIAS\Repository\user().

Referenced by remoteSearch(), and storeRoot().

                                   : bool
    {
        $page_number = $this->initPageNumberFromQuery();
        if (!$page_number and $this->search_mode != 'in_results') {
            ilSession::clear('max_page');
            $this->search_cache->deleteCachedEntries();
        }

        $this->search_cache->setResultPageNumber($page_number);

        if ($this->getType() == ilSearchBaseGUI::SEARCH_DETAILS and !$this->getDetails()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('search_choose_object_type'));
            $this->showSearch();
            return false;
        }

        // Step 1: parse query string
        if (!is_object($query_parser = $this->__parseQueryString())) {
            $this->tpl->setOnScreenMessage('info', $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') {
            $old_result_obj = new ilSearchResult($this->user->getId());
            $old_result_obj->read();

            $result->diffEntriesFromResult();
        }


        // Step 4: merge and validate results
        $result->filter(
            $this->getRootNode(),
            ilSearchSettings::getInstance()->getDefaultOperator() == ilSearchSettings::OPERATOR_AND,
            $this->parseDateFromCreationFilter(),
            $this->parseOperatorFromCreationFilter()
        );
        $result->save();
        $this->showSearch();

        if (!count($result->getResults())) {
            $this->tpl->setOnScreenMessage('info', $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');

        $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('RESULTS_TABLE', $presentation->getHTML());
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareOutput()

ilSearchGUI::prepareOutput

(

)

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Referenced by executeCommand().

                                   : void
    {
        parent::prepareOutput();

        $this->help_gui->setScreenIdComponent("src");

        $this->tabs_gui->addTab(
            "search",
            $this->lng->txt("search"),
            $this->ctrl->getLinkTarget($this)
        );

        if (!$this->settings->getHideAdvancedSearch()) {
            $this->tabs_gui->addTab(
                "adv_search",
                $this->lng->txt("search_advanced"),
                $this->ctrl->getLinkTargetByClass('iladvancedsearchgui')
            );
        }

        $this->tabs_gui->activateTab("search");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

remoteSearch()

ilSearchGUI::remoteSearch

(

)

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

References ILIAS\FileDelivery\http(), performSearch(), ILIAS\Repository\refinery(), setRootNode(), and setString().

                                  : 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->setString($queryString);
        $this->setRootNode($root_id);
        $this->performSearch();
    }

Here is the call graph for this function:

setCombination()

ilSearchGUI::setCombination

(

string

$a_combination

)

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

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

References ilSession\get(), and ilSession\set().

Referenced by __construct().

                                                         : void
    {
        $session_search = ilSession::get('search') ?? [];
        $session_search['combination'] = $this->combination = $a_combination;
        ilSession::set('search', $session_search);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDetails()

ilSearchGUI::setDetails

(

array

$a_details

)

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

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

References ilSession\get(), and ilSession\set().

Referenced by __construct().

                                                : void
    {
        $session_search = ilSession::get('search') ?? [];
        $session_search['details'] = $this->details = $a_details;
        ilSession::set('search', $session_search);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setRootNode()

ilSearchGUI::setRootNode

(

int

$a_node_id

)

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

References ilSession\set().

Referenced by remoteSearch().

                                               : void
    {
        ilSession::set('search_root', $this->root_node = $a_node_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setString()

ilSearchGUI::setString

(

string

$a_str

)

Set/get search string public.

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

References ilSession\get(), and ilSession\set().

Referenced by __construct(), and remoteSearch().

                                            : void
    {
        $session_search = ilSession::get('search') ?? [];
        $session_search['string'] = $this->string = $a_str;
        ilSession::set('search', $session_search);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setType()

ilSearchGUI::setType

(

int

$a_type

)

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

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

References ilSession\get(), and ilSession\set().

Referenced by __construct().

                                        : void
    {
        $session_search = ilSession::get('search');
        $session_search['type'] = $this->type = $a_type;
        ilSession::set('search', $session_search);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showSavedResults()

ilSearchGUI::showSavedResults

(

)

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

References ilSearchBaseGUI\addPager(), getRootNode(), ilSearchResultPresentation\MODE_STANDARD, ilSearchResult\read(), showSearch(), and ILIAS\Repository\user().

                                      : void
    {

        // Read old result sets

        $result_obj = new ilSearchResult($this->user->getId());
        $result_obj->read();
        $result_obj->filterResults($this->getRootNode());

        $this->showSearch();

        // Show them
        if (count($result_obj->getResults())) {
            $this->addPager($result_obj, 'max_page');

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

Here is the call graph for this function:

showSearch()

ilSearchGUI::showSearch

(

)

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

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

Referenced by performSearch(), and showSavedResults().

                                : void
    {
        ilOverlayGUI::initJavascript();
        $this->tpl->addJavascript("./Services/Search/js/Search.js");


        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.search.html', 'Services/Search');
        $this->tpl->setVariable("FORM_ACTION", $this->ctrl->getFormAction($this, 'performSearch'));
        $this->tpl->setVariable("TERM", ilLegacyFormElementsUtil::prepareFormOutput($this->getString()));
        $this->tpl->setVariable("SEARCH_LABEL", $this->lng->txt("search"));
        $btn = ilSubmitButton::getInstance();
        $btn->setCommand("performSearch");
        $btn->setCaption("search");
        $this->tpl->setVariable("SUBMIT_BTN", $btn->render());
        $this->tpl->setVariable("TXT_OPTIONS", $this->lng->txt("options"));
        $this->tpl->setVariable("ARR_IMG", ilGlyphGUI::get(ilGlyphGUI::CARET));
        $this->tpl->setVariable("TXT_COMBINATION", $this->lng->txt("search_term_combination"));
        $this->tpl->setVariable('TXT_COMBINATION_DEFAULT', ilSearchSettings::getInstance()->getDefaultOperator() == ilSearchSettings::OPERATOR_AND ? $this->lng->txt('search_all_words') : $this->lng->txt('search_any_word'));

        if (ilSearchSettings::getInstance()->isLuceneItemFilterEnabled()) {
            $this->tpl->setCurrentBlock("type_sel");
            $this->tpl->setVariable('TXT_TYPE_DEFAULT', $this->lng->txt("search_fast_info"));
            $this->tpl->setVariable("TXT_TYPE", $this->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", $this->lng->txt("search_area"));

        // search area form
        $this->tpl->setVariable('SEARCH_AREA_FORM', $this->getSearchAreaForm()->getHTML());
    }

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 269 of file class.ilSearchGUI.php.

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

                                  : void
    {
        $form = $this->getSearchAreaForm();

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

Here is the call graph for this function:

Field Documentation

$combination

string ilSearchGUI::$combination

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

$details

array ilSearchGUI::$details

private

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

$help_gui

ilHelpGUI ilSearchGUI::$help_gui

protected

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

$root_node

int ilSearchGUI::$root_node

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

$string

string ilSearchGUI::$string

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

Referenced by getString().

$tabs_gui

ilTabsGUI ilSearchGUI::$tabs_gui

protected

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

$type

int ilSearchGUI::$type

Definition at line 41 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