class.ilSearchGUI.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Search\GUI\Searcher;
use ILIAS\Search\GUI\SearchStateHandler;
use ILIAS\Search\Presentation\Result\ResultPresenter;
use ILIAS\Search\Presentation\Result\ViewControlInfos;
use ILIAS\Search\GUI\Actions;
use ILIAS\Search\Presentation\Result\Sortation;
use ILIAS\Search\GUI\Param;
use ILIAS\Search\Service\Service;
 
class ilSearchGUI
{
    protected ilGlobalTemplateInterface $tpl;
    protected ilObjUser $user;
    protected ilLanguage $lng;
    protected ilCtrlInterface $ctrl;
    protected ilTabsGUI $tabs;
    protected ilHelpGUI $help;
    protected ilSearchSettings $settings;
    protected ResultPresenter $result_presenter;
    protected Actions $actions;
    protected Searcher $searcher;
    protected SearchStateHandler $state_handler;
 
    public function __construct()
    {
        global $DIC;
 
        $service = new Service($DIC);
 
        $this->tpl = $service->dic()->ui()->mainTemplate();
        $this->user = $service->dic()->user();
        $this->lng = $service->dic()->language();
        $this->ctrl = $service->dic()->ctrl();
        $this->tabs = $service->dic()->tabs();
        $this->help = $service->dic()->help();
        $this->settings = ilSearchSettings::getInstance();
        $this->result_presenter = $service->presentation()->result();
        $this->actions = $service->gui()->actions();
 
        $this->initByMode($service);
        $this->tpl->loadStandardTemplate();
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.search.html', 'components/ILIAS/Search');
    }
 
    protected function initByMode(Service $service): void
    {
        if ($this->settings->enabledLucene()) {
            $this->searcher = $service->gui()->luceneSearcher();
            $this->state_handler = $service->gui()->luceneSearchStateHandler();
        } else {
            $this->searcher = $service->gui()->directSearcher();
            $this->state_handler = $service->gui()->directSearchStateHandler();
        }
    }
 
    public function executeCommand(): void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            default:
                if (!$this->actions->isValidCommand($cmd)) {
                    $cmd = 'showSavedResults';
                }
                $this->$cmd();
                break;
        }
    }
 
    protected function search(): void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $term = $this->state_handler->fetchRequestedSearchTerm();
        $scope = $cache->getRoot();
        $sortation = Sortation::RELEVANCE_DESC;
        $page = 1;
        $max_page = 1;
 
        $this->state_handler->resetMaxPage();
        $cache->deleteCachedEntries();
        $cache->setQuery($term);
        $cache->save();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->performSearchAndRenderResults($this->user->getId(), $cache, $view_control_infos, $this->state_handler);
    }
 
    protected function remoteSearch(): void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $term = $this->state_handler->fetchRequestedRemoteSearchTerm();
        $scope = $this->state_handler->fetchRequestedRemoteScope();
        $sortation = Sortation::RELEVANCE_DESC;
        $page = 1;
        $max_page = 1;
 
        $this->state_handler->resetMaxPage();
        $cache->deleteCachedEntries();
        $cache->setQuery($term);
        $cache->setRoot($scope);
        $cache->save();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->performSearchAndRenderResults($this->user->getId(), $cache, $view_control_infos, $this->state_handler);
    }
 
    protected function showSavedResults(): void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $term = $cache->getQuery();
        $scope = $cache->getRoot();
        $sortation = Sortation::RELEVANCE_DESC;
        $page = $cache->getResultPageNumber();
        $max_page = $this->state_handler->fetchMaxPage();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->readSavedResultsAndRenderResults($this->user->getId(), $cache, $view_control_infos);
    }
 
    protected function applyFilter(): void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $this->state_handler->loadFilterToCache($filter, $cache);
 
        $term = $cache->getQuery();
        $scope = $cache->getRoot();
        $sortation = Sortation::RELEVANCE_DESC;
        $page = 1;
        $max_page = 1;
 
        $this->state_handler->resetMaxPage();
        $cache->deleteCachedEntries();
        $cache->save();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->performSearchAndRenderResults($this->user->getId(), $cache, $view_control_infos, $this->state_handler);
    }
 
    protected function switchResultPage(): void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $term = $cache->getQuery();
        $scope = $cache->getRoot();
        $sortation = $this->state_handler->fetchSortation();
        $page = $this->state_handler->fetchRequestedPage();
        $max_page = max($this->state_handler->fetchMaxPage(), $page);
 
        $this->state_handler->updateMaxPage($max_page);
        $cache->setResultPageNumber($page);
        $cache->save();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->performSearchAndRenderResults($this->user->getId(), $cache, $view_control_infos, $this->state_handler);
    }
 
    protected function sortResultPage(): void
    {
        $cache = $this->state_handler->fetchCache($this->user->getId());
        $filter = $this->state_handler->fetchFilter($this->actions->applyFilter());
 
        $term = $cache->getQuery();
        $scope = $cache->getRoot();
        $sortation = $this->state_handler->fetchSortation();
        $page = $cache->getResultPageNumber();
        $max_page = $this->state_handler->fetchMaxPage();
 
        $this->fillHeaderAndTabs();
        $this->renderSearchInput($term);
        $this->renderFilter($filter, $scope);
        $view_control_infos = $this->buildViewControlInfos($sortation, $page, $max_page);
        $this->searcher->readSavedResultsAndRenderResults($this->user->getId(), $cache, $view_control_infos);
    }
 
    protected function autoComplete(): void
    {
        $term = $this->state_handler->fetchRequestedAutoCompleteSearchTerm();
        $list = ilSearchAutoComplete::getList($term);
        echo $list;
        exit;
    }
 
    protected function renderSearchInput(string $term): void
    {
        $this->tpl->addJavascript("assets/js/Search.js");
 
        $this->tpl->setVariable("FORM_ACTION", $this->actions->search());
        $this->tpl->setVariable("TERM", ilLegacyFormElementsUtil::prepareFormOutput($term));
        $this->tpl->setVariable("SEARCH_LABEL", $this->lng->txt("search"));
        $btn = ilSubmitButton::getInstance();
        $btn->setCommand("performSearch");
        $btn->setCaption("search");
        $this->tpl->setVariable("SUBMIT_BTN", $btn->render());
    }
 
    protected function renderFilter(
        ilSearchFilterGUI $filter,
        int $scope
    ): void {
        $filter_html = $filter->getHTML();
        preg_match('/id="([^"]+)"/', $filter_html, $matches);
        $filter_id = $matches[1];
        $this->tpl->setVariable("SEARCH_FILTER", $filter_html);
        // scope in filter must be manipulated by JS if search is triggered in meta bar
        $this->tpl->addOnLoadCode("il.Search.syncFilterScope('" . $filter_id . "', '" . $scope . "');");
    }
 
    protected function fillHeaderAndTabs(): void
    {
        // tabs
        $this->tabs->addTab(
            'search',
            $this->lng->txt('search'),
            (string) $this->actions->showSavedResults()
        );
        if ($this->settings->enabledLucene() && $this->settings->isLuceneUserSearchEnabled()) {
            $this->tabs->addTarget(
                'search_user',
                $this->ctrl->getLinkTargetByClass(ilLuceneUserSearchGUI::class)
            );
        }
        $this->tabs->activateTab('search');
 
        // help
        if ($this->settings->enabledLucene()) {
            $this->help->setScreenIdComponent('src_luc');
        } else {
            $this->help->setScreenIdComponent('src');
 
        }
 
        // header
        $this->tpl->setTitleIcon(
            ilObject::_getIcon(0, "big", "src"),
            ""
        );
        $this->tpl->setTitle($this->lng->txt("search"));
    }
 
    protected function buildViewControlInfos(
        Sortation $sortation,
        int $page,
        int $max_page
    ): ViewControlInfos {
        return $this->result_presenter->getViewControlInfos(
            $sortation,
            $page,
            $max_page,
            $this->settings->getMaxHits(),
            $this->actions->switchResultPage($sortation),
            Param::PAGE_NUMBER,
            $this->actions->sortResultPage(),
            Param::SORTATION
        );
    }
}