ILIAS\Search\GUI\AbstractSearchStateHandlerImpl Class Reference

Inheritance diagram for ILIAS\Search\GUI\AbstractSearchStateHandlerImpl:

Collaboration diagram for ILIAS\Search\GUI\AbstractSearchStateHandlerImpl:

Public Member Functions
	__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 31 of file AbstractSearchStateHandlerImpl.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::__construct	(	protected HTTP	$http,
		protected Refinery	$refinery
	)

Definition at line 33 of file AbstractSearchStateHandlerImpl.php.

      {
    }

Member Function Documentation

fetchCache()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::fetchCache ( int  $usr_id )

abstract

Implements ILIAS\Search\GUI\SearchStateHandler.

Reimplemented in ILIAS\Search\GUI\Direct\SearchStateHandlerImpl, and ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl.

fetchFilter()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::fetchFilter ( URI  $action )

abstract

Implements ILIAS\Search\GUI\SearchStateHandler.

Reimplemented in ILIAS\Search\GUI\Direct\SearchStateHandlerImpl, and ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl.

fetchMaxPage()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::fetchMaxPage

(

)

Implements ILIAS\Search\GUI\SearchStateHandler.

Definition at line 39 of file AbstractSearchStateHandlerImpl.php.

                                  : int
    {
        return (int) (ilSession::get(Param::MAX_PAGE->value) ?? 1);
    }

References ilSession\get().

Here is the call graph for this function:

fetchRequestedAutoCompleteSearchTerm()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::fetchRequestedAutoCompleteSearchTerm

(

)

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

Implements ILIAS\Search\GUI\SearchStateHandler.

Definition at line 103 of file AbstractSearchStateHandlerImpl.php.

                                                          : string
    {
        if ($this->http->wrapper()->post()->has('term')) {
            return $this->http->wrapper()->post()->retrieve(
                'term',
                $this->refinery->kindlyTo()->string()
            );
        }
        return '';
    }

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

Here is the call graph for this function:

fetchRequestedPage()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::fetchRequestedPage

(

)

Implements ILIAS\Search\GUI\SearchStateHandler.

Definition at line 54 of file AbstractSearchStateHandlerImpl.php.

                                        : int
    {
        if ($this->http->wrapper()->query()->has(Param::PAGE_NUMBER->value)) {
            // pages in the view control are 0-indexed, in search 1-indexed
            return $this->http->wrapper()->query()->retrieve(
                Param::PAGE_NUMBER->value,
                $this->refinery->kindlyTo()->int()
            ) + 1;
        }
        return 1;
    }

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

Here is the call graph for this function:

fetchRequestedRemoteScope()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::fetchRequestedRemoteScope

(

)

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

Implements ILIAS\Search\GUI\SearchStateHandler.

Definition at line 118 of file AbstractSearchStateHandlerImpl.php.

                                               : int
    {
        if ($this->http->wrapper()->post()->has('root_id')) {
            return $this->http->wrapper()->post()->retrieve(
                'root_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return ROOT_FOLDER_ID;
    }

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

Here is the call graph for this function:

fetchRequestedRemoteSearchTerm()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::fetchRequestedRemoteSearchTerm ( )

abstract

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

Implements ILIAS\Search\GUI\SearchStateHandler.

Reimplemented in ILIAS\Search\GUI\Direct\SearchStateHandlerImpl, and ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl.

fetchRequestedSearchTerm()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::fetchRequestedSearchTerm

(

)

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

Implements ILIAS\Search\GUI\SearchStateHandler.

Definition at line 82 of file AbstractSearchStateHandlerImpl.php.

                                              : string
    {
        if ($this->http->wrapper()->post()->has('term')) {
            return $this->http->wrapper()->post()->retrieve(
                'term',
                $this->refinery->kindlyTo()->string()
            );
        }
        return '';
    }

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

Here is the call graph for this function:

fetchSortation()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::fetchSortation

(

)

Implements ILIAS\Search\GUI\SearchStateHandler.

Definition at line 66 of file AbstractSearchStateHandlerImpl.php.

                                    : Sortation
    {
        $sortation_string = '';
        if ($this->http->wrapper()->query()->has(Param::SORTATION->value)) {
            $sortation_string = $this->http->wrapper()->query()->retrieve(
                Param::SORTATION->value,
                $this->refinery->kindlyTo()->string()
            );
        }
        return Sortation::tryFrom($sortation_string) ?? Sortation::RELEVANCE_DESC;
    }

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

Here is the call graph for this function:

loadFilterToCache()

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

abstract

Implements ILIAS\Search\GUI\SearchStateHandler.

Reimplemented in ILIAS\Search\GUI\Direct\SearchStateHandlerImpl, and ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl.

resetMaxPage()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::resetMaxPage

(

)

Implements ILIAS\Search\GUI\SearchStateHandler.

Definition at line 44 of file AbstractSearchStateHandlerImpl.php.

                                  : void
    {
        ilSession::clear(Param::MAX_PAGE->value);
    }

References ilSession\clear().

Here is the call graph for this function:

updateMaxPage()

ILIAS\Search\GUI\AbstractSearchStateHandlerImpl::updateMaxPage

(

int

$max_page

)

Implements ILIAS\Search\GUI\SearchStateHandler.

Definition at line 49 of file AbstractSearchStateHandlerImpl.php.

                                                : void
    {
        ilSession::set(Param::MAX_PAGE->value, $max_page > 0 ? (string) $max_page : '1');
    }

References ilSession\set().

Here is the call graph for this function:

---

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

• components/ILIAS/Search/classes/GUI/AbstractSearchStateHandlerImpl.php