AbstractSearchStateHandlerImpl.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Search\GUI;
 
use ILIAS\Search\Presentation\Result\Sortation;
use ilSearchFilterGUI;
use ilUserSearchCache;
use ILIAS\Data\URI;
use ilSession;
use ILIAS\HTTP\Services as HTTP;
use ILIAS\Refinery\Factory as Refinery;
 
abstract class AbstractSearchStateHandlerImpl implements SearchStateHandler
{
    public function __construct(
        protected HTTP $http,
        protected Refinery $refinery
    ) {
    }
 
    public function fetchMaxPage(): int
    {
        return (int) (ilSession::get(Param::MAX_PAGE->value) ?? 1);
    }
 
    public function resetMaxPage(): void
    {
        ilSession::clear(Param::MAX_PAGE->value);
    }
 
    public function updateMaxPage(int $max_page): void
    {
        ilSession::set(Param::MAX_PAGE->value, $max_page > 0 ? (string) $max_page : '1');
    }
 
    public function fetchRequestedPage(): 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;
    }
 
    public function fetchSortation(): 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;
    }
 
    public function fetchRequestedSearchTerm(): string
    {
        if ($this->http->wrapper()->post()->has('term')) {
            return $this->http->wrapper()->post()->retrieve(
                'term',
                $this->refinery->kindlyTo()->string()
            );
        }
        return '';
    }
 
    abstract public function fetchRequestedRemoteSearchTerm(): string;
 
    public function fetchRequestedAutoCompleteSearchTerm(): string
    {
        if ($this->http->wrapper()->post()->has('term')) {
            return $this->http->wrapper()->post()->retrieve(
                'term',
                $this->refinery->kindlyTo()->string()
            );
        }
        return '';
    }
 
    public function fetchRequestedRemoteScope(): 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;
    }
 
    abstract public function fetchCache(int $usr_id): ilUserSearchCache;
 
    abstract public function fetchFilter(URI $action): ilSearchFilterGUI;
 
    abstract public function loadFilterToCache(ilSearchFilterGUI $filter, ilUserSearchCache $cache): void;
}