ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl Class Reference

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

Collaboration diagram for ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl:

Public Member Functions
	__construct (protected ilSearchSettings $settings, protected LOMServices $lom_services, HTTP $http, Refinery $refinery)
	fetchRequestedRemoteSearchTerm ()
	propably needs to be replaced with a completely different mechanism when switching to KS More...
	fetchFilter (URI $action)
	fetchCache (int $usr_id)
	loadFilterToCache (ilSearchFilterGUI $filter, ilUserSearchCache $cache)
Public Member Functions inherited from ILIAS\Search\GUI\AbstractSearchStateHandlerImpl
	__construct (protected HTTP $http, protected Refinery $refinery)
	fetchMaxPage ()
	resetMaxPage ()
	updateMaxPage (int $max_page)
	fetchRequestedPage ()
	fetchSortation ()
	fetchRequestedSearchTerm ()
	propably needs to be replaced with a completely different mechanism when switching to KS More...
	fetchRequestedRemoteSearchTerm ()
	propably needs to be replaced with a completely different mechanism when switching to KS More...
	fetchRequestedAutoCompleteSearchTerm ()
	propably needs to be replaced with a completely different mechanism when switching to KS More...
	fetchRequestedRemoteScope ()
	propably needs to be replaced with a completely different mechanism when switching to KS More...
	fetchCache (int $usr_id)
	fetchFilter (URI $action)
	loadFilterToCache (ilSearchFilterGUI $filter, ilUserSearchCache $cache)
	fetchMaxPage ()
	resetMaxPage ()
	updateMaxPage (int $max_page)
	fetchRequestedPage ()
	fetchSortation ()
	fetchRequestedSearchTerm ()
	fetchRequestedRemoteSearchTerm ()
	fetchRequestedAutoCompleteSearchTerm ()
	fetchRequestedRemoteScope ()
	fetchCache (int $usr_id)
	fetchFilter (URI $action)
	loadFilterToCache (ilSearchFilterGUI $filter, ilUserSearchCache $cache)

Detailed Description

Definition at line 33 of file SearchStateHandlerImpl.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl::__construct	(	protected ilSearchSettings	$settings,
		protected LOMServices	$lom_services,
		HTTP	$http,
		Refinery	$refinery
	)

Definition at line 35 of file SearchStateHandlerImpl.php.

      {
        parent::__construct($http, $refinery);
    }

References $http, ILIAS\UI\examples\Layout\Page\Mail\$refinery, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

fetchCache()

ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl::fetchCache

(

int

$usr_id

)

Reimplemented from ILIAS\Search\GUI\AbstractSearchStateHandlerImpl.

Definition at line 63 of file SearchStateHandlerImpl.php.

                                           : ilUserSearchCache
    {
        $cache = ilUserSearchCache::_getInstance($usr_id);
        $cache->switchSearchType(ilUserSearchCache::LUCENE_DEFAULT);
        return $cache;
    }

References ilUserSearchCache\_getInstance(), and ilUserSearchCache\LUCENE_DEFAULT.

Here is the call graph for this function:

fetchFilter()

ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl::fetchFilter

(

URI

$action

)

Reimplemented from ILIAS\Search\GUI\AbstractSearchStateHandlerImpl.

Definition at line 58 of file SearchStateHandlerImpl.php.

                                            : ilSearchFilterGUI
    {
        return new ilSearchFilterGUI($action, true);
    }

fetchRequestedRemoteSearchTerm()

ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl::fetchRequestedRemoteSearchTerm

(

)

propably needs to be replaced with a completely different mechanism when switching to KS

Reimplemented from ILIAS\Search\GUI\AbstractSearchStateHandlerImpl.

Definition at line 44 of file SearchStateHandlerImpl.php.

                                                    : string
    {
        if ($this->http->wrapper()->post()->has('queryString')) {
            $term = $this->http->wrapper()->post()->retrieve(
                'queryString',
                $this->refinery->kindlyTo()->string()
            );
            $qp = new ilLuceneQueryParser($term);
            $qp->parseAutoWildcard();
            return $qp->getQuery();
        }
        return '';
    }

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

Here is the call graph for this function:

loadFilterToCache()

ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl::loadFilterToCache	(	ilSearchFilterGUI	$filter,
		ilUserSearchCache	$cache
	)

Reimplemented from ILIAS\Search\GUI\AbstractSearchStateHandlerImpl.

Definition at line 70 of file SearchStateHandlerImpl.php.

                                                                                          : void
    {
        $search_filter_data = $filter->getData();
 
        $cache->setRoot((int) ($search_filter_data['search_scope'] ?? ROOT_FOLDER_ID));
 
        $creation_filter = [];
        if (
            $this->settings->isDateFilterEnabled() &&
            isset($search_filter_data['search_date'])
        ) {
            $creation_filter['date_start'] = $search_filter_data['search_date'][0];
            $creation_filter['date_end'] = $search_filter_data['search_date'][1];
        }
        $cache->setCreationFilter($creation_filter);
 
        $types_from_filter = (array) ($search_filter_data['search_type'] ?? []);
 
        $enabled_types = [];
        foreach ($this->settings->getEnabledLuceneItemFilterDefinitions() as $type => $data) {
            if (in_array($type, $types_from_filter)) {
                $enabled_types[$type] = 1;
            }
        }
        $cache->setItemFilter($enabled_types);
 
        $enabled_mime_types = [];
        foreach ($this->settings->getEnabledLuceneMimeFilterDefinitions() as $mime_type => $data) {
            if (in_array($mime_type, $types_from_filter)) {
                $enabled_mime_types[$mime_type] = 1;
            }
        }
        $cache->setMimeFilter($enabled_mime_types);
 
        $copyright_filter = [];
        if (
            $this->lom_services->copyrightHelper()->isCopyrightSelectionActive() &&
            isset($search_filter_data['search_copyright'])
        ) {
            $copyright_filter = $search_filter_data['search_copyright'];
        }
        $cache->setCopyrightFilter(...$copyright_filter);
    }

References $data, ilSearchFilterGUI\getData(), ROOT_FOLDER_ID, ilUserSearchCache\setCopyrightFilter(), ilUserSearchCache\setCreationFilter(), ilUserSearchCache\setItemFilter(), ilUserSearchCache\setMimeFilter(), ilUserSearchCache\setRoot(), and ILIAS\Repository\settings().

Here is the call graph for this function:

---

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

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