ILIAS\Search\GUI\Direct\SearcherImpl Class Reference

Inheritance diagram for ILIAS\Search\GUI\Direct\SearcherImpl:

Collaboration diagram for ILIAS\Search\GUI\Direct\SearcherImpl:

Public Member Functions
	__construct (protected ilSearchSettings $settings, protected ilGlobalTemplateInterface $tpl, protected UIRenderer $ui_renderer, protected ResultPresenter $presenter, protected ilLanguage $lng)
	performSearchAndRenderResults (int $usr_id, ilUserSearchCache $cache, ViewControlInfos $view_control_infos, SearchStateHandler $state_handler)
	Note that the cache doubles here as an actual cache, but also as a data object bundling all inputs needed to search. More...
	readSavedResultsAndRenderResults (int $usr_id, ilUserSearchCache $cache, ViewControlInfos $view_control_infos)
	performSearchAndRenderResults (int $usr_id, ilUserSearchCache $cache, ViewControlInfos $view_control_infos, SearchStateHandler $state_handler)
	Note that the cache doubles here as an actual cache, but also as a data object bundling all inputs needed to search. More...
	readSavedResultsAndRenderResults (int $usr_id, ilUserSearchCache $cache, ViewControlInfos $view_control_infos)

Protected Member Functions
	renderResults (ilSearchResult $results, string $term, ViewControlInfos $view_control_infos)
	parseQueryString (string $term)
	searchObjects (ilQueryParser $query_parser, ilUserSearchCache $cache)
	Search in object title, desctiption. More...
	searchLOM (string $field, ilQueryParser $query_parser, ilUserSearchCache $cache)
	searchDetails (ilQueryParser $query_parser, ilUserSearchCache $cache, ilSearchResult $result)
	parseCreationFilter (ilObjectSearch $search, ilUserSearchCache $cache)
	parseStartDateFromCreationFilter (ilUserSearchCache $cache)
	parseEndDateFromCreationFilter (ilUserSearchCache $cache)
	parseTypeFilter (ilUserSearchCache $cache)

Detailed Description

Definition at line 40 of file SearcherImpl.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Search\GUI\Direct\SearcherImpl::__construct	(	protected ilSearchSettings	$settings,
		protected ilGlobalTemplateInterface	$tpl,
		protected UIRenderer	$ui_renderer,
		protected ResultPresenter	$presenter,
		protected ilLanguage	$lng
	)

Definition at line 42 of file SearcherImpl.php.

      {
    }

Member Function Documentation

parseCreationFilter()

ILIAS\Search\GUI\Direct\SearcherImpl::parseCreationFilter ( ilObjectSearch  $search, ilUserSearchCache  $cache  )

protected

Definition at line 300 of file SearcherImpl.php.

     : void {
        $date_start = $this->parseStartDateFromCreationFilter($cache);
        $date_end = $this->parseEndDateFromCreationFilter($cache);
 
        if (is_null($date_start) && is_null($date_end)) {
            return;
        }
 
        $search->setCreationDateFilterStartDate($date_start);
        $search->setCreationDateFilterEndDate($date_end);
    }

parseEndDateFromCreationFilter()

ILIAS\Search\GUI\Direct\SearcherImpl::parseEndDateFromCreationFilter ( ilUserSearchCache  $cache )

protected

Definition at line 324 of file SearcherImpl.php.

                                                                               : ?ilDate
    {
        $options = $cache->getCreationFilter();
        if (!($options['date_end'] ?? false)) {
            return null;
        }
        return new ilDate($options['date_end'], IL_CAL_DATE);
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, ilUserSearchCache\getCreationFilter(), and IL_CAL_DATE.

Here is the call graph for this function:

parseQueryString()

ILIAS\Search\GUI\Direct\SearcherImpl::parseQueryString ( string  $term )

protected

Definition at line 157 of file SearcherImpl.php.

                                                     : ilQueryParser|string
    {
        $query_parser = new ilQueryParser(ilUtil::stripSlashes($term));
        $query_parser->setCombination(
            $this->settings->getDefaultOperator() === ilSearchSettings::OPERATOR_AND ?
                ilQueryParser::QP_COMBINATION_AND : ilQueryParser::QP_COMBINATION_OR
        );
        $query_parser->parse();
 
        if (!$query_parser->validate()) {
            return $query_parser->getMessage();
        }
        return $query_parser;
    }

References ilSearchSettings\OPERATOR_AND, ilQueryParser\QP_COMBINATION_AND, ilQueryParser\QP_COMBINATION_OR, ILIAS\Repository\settings(), and ilUtil\stripSlashes().

Here is the call graph for this function:

parseStartDateFromCreationFilter()

ILIAS\Search\GUI\Direct\SearcherImpl::parseStartDateFromCreationFilter ( ilUserSearchCache  $cache )

protected

Definition at line 315 of file SearcherImpl.php.

                                                                                 : ?ilDate
    {
        $options = $cache->getCreationFilter();
        if (!($options['date_start'] ?? false)) {
            return null;
        }
        return new ilDate($options['date_start'], IL_CAL_DATE);
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, ilUserSearchCache\getCreationFilter(), and IL_CAL_DATE.

Here is the call graph for this function:

parseTypeFilter()

ILIAS\Search\GUI\Direct\SearcherImpl::parseTypeFilter ( ilUserSearchCache  $cache )

protected

Definition at line 333 of file SearcherImpl.php.

                                                                : array
    {
        $filter = [];
        foreach ($cache->getItemFilter() as $type => $enabled) {
            if (!$enabled) {
                continue;
            }
 
            switch ($type) {
                case 'lms':
                    $filter[] = 'lm';
                    $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[] = 'wiki';
                    $filter[] = 'wpg';
                    break;
 
                default:
                    $filter[] = $type;
            }
        }
        return $filter;
    }

References ilUserSearchCache\getItemFilter().

Here is the call graph for this function:

performSearchAndRenderResults()

ILIAS\Search\GUI\Direct\SearcherImpl::performSearchAndRenderResults	(	int	$usr_id,
		ilUserSearchCache	$cache,
		ViewControlInfos	$view_control_infos,
		SearchStateHandler	$state_handler
	)

Note that the cache doubles here as an actual cache, but also as a data object bundling all inputs needed to search.

Maybe split that up in the future?

This should not be here. As soon as we have a unified format for search results, this should be done by the GUI.

Implements ILIAS\Search\GUI\Searcher.

Definition at line 51 of file SearcherImpl.php.

     : void {
        // Step 1: parse query string
        if (!is_object($query_parser = $this->parseQueryString($cache->getQuery()))) {
            $this->tpl->setOnScreenMessage(GlobalTemplate::MESSAGE_TYPE_INFO, $query_parser);
            return;
        }
        // Step 2: perform object search. Get an ObjectSearch object via factory. Depends on fulltext or like search type.
        $result = $this->searchObjects($query_parser, $cache);
 
        // Step 3: perform meta keyword search. Get an MetaDataSearch object.
        $result_meta = $this->searchLOM('keyword', $query_parser, $cache);
        $result->mergeEntries($result_meta);
 
        $result_meta = $this->searchLOM('contribute', $query_parser, $cache);
        $result->mergeEntries($result_meta);
 
        $result_meta = $this->searchLOM('title', $query_parser, $cache);
        $result->mergeEntries($result_meta);
 
        $result_meta = $this->searchLOM('description', $query_parser, $cache);
        $result->mergeEntries($result_meta);
 
        // Step 4: Perform details search in object specific tables
        $result = $this->searchDetails($query_parser, $cache, $result);
 
 
        // Step 5: merge and validate results
        $result->filter(
            $cache->getRoot(),
            ilSearchSettings::getInstance()->getDefaultOperator() == ilSearchSettings::OPERATOR_AND,
            $this->parseStartDateFromCreationFilter($cache),
            $this->parseEndDateFromCreationFilter($cache),
            $cache->getCopyrightFilter()
        );
        $result->save();
 
        if (
            $view_control_infos->currentPage() === $view_control_infos->maxPages() &&
            $result->isLimitReached()
        ) {
            $view_control_infos = $this->presenter->getViewControlInfos(
                $view_control_infos->sortation(),
                $view_control_infos->currentPage(),
                $view_control_infos->maxPages() + 1,
                $view_control_infos->pageSize(),
                $view_control_infos->paginationAction(),
                $view_control_infos->pageParam(),
                $view_control_infos->sortationAction(),
                $view_control_infos->sortationParam()
            );
            $state_handler->updateMaxPage($view_control_infos->maxPages());
        }
 
        $this->renderResults($result, $cache->getQuery(), $view_control_infos);
    }

References ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_INFO.

readSavedResultsAndRenderResults()

ILIAS\Search\GUI\Direct\SearcherImpl::readSavedResultsAndRenderResults	(	int	$usr_id,
		ilUserSearchCache	$cache,
		ViewControlInfos	$view_control_infos
	)

Implements ILIAS\Search\GUI\Searcher.

Definition at line 116 of file SearcherImpl.php.

     : void {
        $results = new ilSearchResult($usr_id);
        $results->read();
        $results->filterResults($cache->getRoot());
        $this->renderResults($results, $cache->getQuery(), $view_control_infos);
    }

renderResults()

ILIAS\Search\GUI\Direct\SearcherImpl::renderResults ( ilSearchResult  $results, string  $term, ViewControlInfos  $view_control_infos  )

protected

Definition at line 127 of file SearcherImpl.php.

     : void {
        if ($results->getResults()) {
            $result_panel_and_modals = $this->presenter->getDirectSearchResultAsPanel(
                $results,
                $view_control_infos
            );
            $this->tpl->setVariable(
                'SEARCH_RESULTS',
                $this->ui_renderer->render($result_panel_and_modals)
            );
        } elseif ($term !== '') {
            $this->tpl->setOnScreenMessage(
                GlobalTemplate::MESSAGE_TYPE_INFO,
                sprintf(
                    $this->lng->txt('search_no_match_hint'),
                    $term
                )
            );
        } else {
            $this->tpl->setOnScreenMessage(
                GlobalTemplate::MESSAGE_TYPE_INFO,
                $this->lng->txt('search_no_match')
            );
        }
    }

References $results.

searchDetails()

ILIAS\Search\GUI\Direct\SearcherImpl::searchDetails ( ilQueryParser  $query_parser, ilUserSearchCache  $cache, ilSearchResult  $result  )

protected

Definition at line 216 of file SearcherImpl.php.

     : ilSearchResult {
        foreach ($cache->getItemFilter() as $type => $enabled) {
            if (!$enabled) {
                continue;
            }
 
            switch ($type) {
                case 'crs':
                    $crs_search = ilObjectSearchFactory::_getObjectSearchInstance($query_parser);
                    $crs_search->setFilter(['crs']);
                    $result->mergeEntries($crs_search->performSearch());
                    break;
 
                case 'grp':
                    $grp_search = ilObjectSearchFactory::_getObjectSearchInstance($query_parser);
                    $grp_search->setFilter(['grp']);
                    $result->mergeEntries($grp_search->performSearch());
                    break;
 
                case 'lms':
                    $content_search = ilObjectSearchFactory::_getLMContentSearchInstance($query_parser);
                    $content_search->setFilter($this->parseTypeFilter($cache));
                    $result->mergeEntries($content_search->performSearch());
                    break;
 
                case 'frm':
                    $forum_search = ilObjectSearchFactory::_getForumSearchInstance($query_parser);
                    $forum_search->setFilter($this->parseTypeFilter($cache));
                    $result->mergeEntries($forum_search->performSearch());
                    break;
 
                case 'glo':
                    // Glossary term definition pages
                    $gdf_search = ilObjectSearchFactory::_getLMContentSearchInstance($query_parser);
                    $gdf_search->setFilter(['term']);
                    $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->parseTypeFilter($cache));
                    $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->parseTypeFilter($cache));
                    $result->mergeEntries($tst_search->performSearch());
                    break;
 
                case 'mep':
                    $mep_search = ilObjectSearchFactory::_getMediaPoolSearchInstance($query_parser);
                    $mep_search->setFilter($this->parseTypeFilter($cache));
                    $result->mergeEntries($mep_search->performSearch());
 
                    // Mob keyword search
                    $mob_search = ilObjectSearchFactory::_getMediaPoolSearchInstance($query_parser);
                    $mob_search->setFilter($this->parseTypeFilter($cache));
                    $result->mergeEntries($mob_search->performKeywordSearch());
 
                    break;
 
                case 'wiki':
                    $wiki_search = ilObjectSearchFactory::_getWikiContentSearchInstance($query_parser);
                    $wiki_search->setFilter($this->parseTypeFilter($cache));
                    $result->mergeEntries($wiki_search->performSearch());
                    break;
            }
        }
        return $result;
    }

References ilObjectSearchFactory\_getExerciseSearchInstance(), ilObjectSearchFactory\_getForumSearchInstance(), ilObjectSearchFactory\_getGlossaryDefinitionSearchInstance(), ilObjectSearchFactory\_getLMContentSearchInstance(), ilObjectSearchFactory\_getMediacastSearchInstance(), ilObjectSearchFactory\_getMediaPoolSearchInstance(), ilObjectSearchFactory\_getObjectSearchInstance(), ilObjectSearchFactory\_getTestSearchInstance(), ilObjectSearchFactory\_getWikiContentSearchInstance(), and ilSearchResult\mergeEntries().

Here is the call graph for this function:

searchLOM()

ILIAS\Search\GUI\Direct\SearcherImpl::searchLOM ( string  $field, ilQueryParser  $query_parser, ilUserSearchCache  $cache  )

protected

Definition at line 187 of file SearcherImpl.php.

     : ilSearchResult {
        $meta_search = ilObjectSearchFactory::_getMetaDataSearchInstance($query_parser);
        if (($type_filter = $this->parseTypeFilter($cache)) !== []) {
            $meta_search->setFilter($type_filter);
        }
        switch ($field) {
            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();
    }

searchObjects()

ILIAS\Search\GUI\Direct\SearcherImpl::searchObjects ( ilQueryParser  $query_parser, ilUserSearchCache  $cache  )

protected

Search in object title, desctiption.

Definition at line 175 of file SearcherImpl.php.

     : ilSearchResult {
        $obj_search = ilObjectSearchFactory::_getObjectSearchInstance($query_parser);
        if (($type_filter = $this->parseTypeFilter($cache)) !== []) {
            $obj_search->setFilter($type_filter);
        }
        $this->parseCreationFilter($obj_search, $cache);
        return $obj_search->performSearch();
    }

---

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

• components/ILIAS/Search/classes/GUI/Direct/SearcherImpl.php