ILIAS\Search\GUI\Lucene\SearcherImpl Class Reference

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

Collaboration diagram for ILIAS\Search\GUI\Lucene\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 (ilLuceneSearchResultFilter $filter, ?ilLuceneHighlighterResultParser $highlighter, string $term, ViewControlInfos $view_control_infos)
	parseCreationFilter (ilUserSearchCache $cache)
	parseCopyrightFilter (ilUserSearchCache $cache)

Detailed Description

Definition at line 40 of file SearcherImpl.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Search\GUI\Lucene\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

parseCopyrightFilter()

ILIAS\Search\GUI\Lucene\SearcherImpl::parseCopyrightFilter ( ilUserSearchCache  $cache )

protected

Definition at line 222 of file SearcherImpl.php.

                                                                     : string
    {
        $identifiers = $cache->getCopyrightFilter();
        if ($identifiers === []) {
            return '';
        }
 
        $conditions = [];
        foreach ($identifiers as $identifier) {
            $conditions[] = 'lomCopyright:"' . $identifier . '"';
        }
        return '+(' . implode(' OR ', $conditions) . ')';
    }

References ilUserSearchCache\getCopyrightFilter().

Here is the call graph for this function:

parseCreationFilter()

ILIAS\Search\GUI\Lucene\SearcherImpl::parseCreationFilter ( ilUserSearchCache  $cache )

protected

Definition at line 193 of file SearcherImpl.php.

                                                                    : string
    {
        $options = $cache->getCreationFilter();
 
        if (!($options['date_start'] ?? false) && !($options['date_end'] ?? false)) {
            return '';
        }
 
        $start = null;
        $end = null;
        if (($options['date_start'] ?? false)) {
            $start = new ilDate($options['date_start'] ?? "", IL_CAL_DATE);
        }
        if (($options['date_end'] ?? false)) {
            $end = new ilDate($options['date_end'] ?? "", IL_CAL_DATE);
        }
 
        if ($start && is_null($end)) {
            $now = new ilDate(time(), IL_CAL_UNIX);
            return '+(cdate:[' . $start->get(IL_CAL_DATE) . ' TO ' . $now->get(IL_CAL_DATE) . '*]) ';
        } elseif ($end && is_null($start)) {
            return '+(cdate:[* TO ' . $end->get(IL_CAL_DATE) . ']) ';
        } else {
            return '+(cdate:[' . $start->get(IL_CAL_DATE) . ' TO ' . $end->get(IL_CAL_DATE) . '*]) ';
        }
 
        return '';
    }

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

Here is the call graph for this function:

performSearchAndRenderResults()

ILIAS\Search\GUI\Lucene\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 {
        $filter_query = '';
        if ($cache->getItemFilter() and ilSearchSettings::getInstance()->isLuceneItemFilterEnabled()) {
            $filter_settings = ilSearchSettings::getInstance()->getEnabledLuceneItemFilterDefinitions();
            foreach ($cache->getItemFilter() as $obj => $value) {
                if (!$filter_query) {
                    $filter_query .= '+( ';
                } else {
                    $filter_query .= 'OR';
                }
                $filter_query .= (' ' . $filter_settings[$obj]['filter'] . ' ');
            }
            $filter_query .= ') ';
        }
 
        $mime_query = '';
        if ($cache->getMimeFilter() and ilSearchSettings::getInstance()->isLuceneMimeFilterEnabled()) {
            $filter_settings = ilSearchSettings::getInstance()->getEnabledLuceneMimeFilterDefinitions();
            foreach ($cache->getMimeFilter() as $mime => $value) {
                if (!$mime_query) {
                    $mime_query .= '+( ';
                } else {
                    $mime_query .= 'OR';
                }
                $mime_query .= (' ' . $filter_settings[$mime]['filter'] . ' ');
            }
            $mime_query .= ') ';
        }
 
        $cdate_query = $this->parseCreationFilter($cache);
        $copyright_query = $this->parseCopyrightFilter($cache);
 
        $filter_query = $filter_query . ' ' . $mime_query . ' ' . $cdate_query . ' ' . $copyright_query;
 
        $query = $cache->getQuery();
        if ($query) {
            $query = ' +(' . $query . ')';
        }
        $qp = new ilLuceneQueryParser($filter_query . $query);
        $qp->parse();
        $searcher = ilLuceneSearcher::getInstance($qp);
        $searcher->search();
 
        // Filter results
        $filter = ilLuceneSearchResultFilter::getInstance($usr_id);
        $filter->addFilter(new ilLucenePathFilter($cache->getRoot()));
        $filter->setCandidates($searcher->getResult());
        $filter->filter();
 
        if ($filter->getResultObjIds()) {
            $searcher->highlight($filter->getResultObjIds());
        }
 
        if (
            $view_control_infos->currentPage() === $view_control_infos->maxPages() &&
            $filter->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($filter, $searcher->getHighlighter(), $cache->getQuery(), $view_control_infos);
    }

References ilSearchSettings\getInstance(), and ilUserSearchCache\getItemFilter().

Here is the call graph for this function:

readSavedResultsAndRenderResults()

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

Implements ILIAS\Search\GUI\Searcher.

Definition at line 133 of file SearcherImpl.php.

     : void {
        if (!strlen($cache->getQuery())) {
            $this->tpl->setOnScreenMessage(
                GlobalTemplate::MESSAGE_TYPE_INFO,
                $this->lng->txt('search_no_match')
            );
            return;
        }
 
        $qp = new ilLuceneQueryParser($cache->getQuery());
        $qp->parse();
        $searcher = ilLuceneSearcher::getInstance($qp);
        $searcher->search();
 
        // Load saved results
        $filter = ilLuceneSearchResultFilter::getInstance($usr_id);
        $filter->loadFromDb();
 
        // Highlight
        $searcher->highlight($filter->getResultObjIds());
 
        $this->renderResults($filter, $searcher->getHighlighter(), $cache->getQuery(), $view_control_infos);
    }

References ILIAS\Repository\lng(), and ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_INFO.

Here is the call graph for this function:

renderResults()

ILIAS\Search\GUI\Lucene\SearcherImpl::renderResults ( ilLuceneSearchResultFilter  $filter, ?ilLuceneHighlighterResultParser  $highlighter, string  $term, ViewControlInfos  $view_control_infos  )

protected

Definition at line 161 of file SearcherImpl.php.

     : void {
        if ($filter->getResults() && $highlighter !== null) {
            $result_panel_and_modals = $this->presenter->getLuceneSearchResultAsPanel(
                $filter,
                $highlighter,
                $view_control_infos
            );
            $this->tpl->setVariable(
                'SEARCH_RESULTS',
                $this->presenter->replacePlaceholders($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')
            );
        }
    }

---

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

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