class.ilObjSearchSettingsFormGUI.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\HTTP\GlobalHttpState;
use ILIAS\DI\UIServices;
use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use ILIAS\UI\Component\Input\Container\Form\Standard as StandardForm;
use ILIAS\Search\ObjGUI\Readme\Helper as ServerReadmeHelper;
 
class ilObjSearchSettingsFormGUI
{
    protected GlobalHttpState $http;
    protected ilCtrlInterface $ctrl;
    protected ilLanguage $lng;
    protected ilGlobalTemplateInterface $tpl;
    protected Factory $factory;
    protected Renderer $renderer;
 
    protected ilObjSearchRpcClientCoordinator $coordinator;
    protected ServerReadmeHelper $readme_helper;
 
    public function __construct(
        GlobalHttpState $http,
        ilCtrlInterface $ctrl,
        ilLanguage $lng,
        UIServices $ui,
        ilObjSearchRpcClientCoordinator $coordinator,
        ServerReadmeHelper $readme_helper
    ) {
        $this->http = $http;
        $this->ctrl = $ctrl;
        $this->lng = $lng;
        $this->tpl = $ui->mainTemplate();
        $this->factory = $ui->factory();
        $this->renderer = $ui->renderer();
        $this->coordinator = $coordinator;
        $this->readme_helper = $readme_helper;
    }
 
    public function executeCommand(): void
    {
        $cmd = $this->ctrl->getCmd();
 
        switch ($cmd) {
            case 'readOnly':
                $this->showForm(true);
                break;
 
            case 'edit':
                $this->showForm(false);
                break;
 
            case 'permDenied':
                $this->showPermissionDenied();
                break;
 
            case 'update':
                $this->update();
                break;
 
            default:
                throw new ilObjSearchSettingsGUIException(
                    'Invalid command for ilObjSearchSettingsFormGUI: ' . $cmd
                );
        }
    }
 
    protected function showForm(
        bool $read_only,
        bool $get_from_post = false,
        string $error_message = ''
    ): void {
        $content = [];
        if ($error_message !== '') {
            $content[] = $this->readme_helper->getServerErrorMessageBox($error_message);
        }
 
        $form = $this->initForm($read_only);
        if ($get_from_post) {
            $form = $form->withRequest($this->http->request());
        }
        $content[] = $form;
 
        $this->tpl->setContent($this->renderer->render($content));
    }
 
    protected function update(): void
    {
        $form = $this->initForm(false)
                     ->withRequest($this->http->request());
 
        if (!$form->getData()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
            $this->showForm(false, true);
            return;
        }
 
        $settings = $this->getSettings();
 
        $main_data = $form->getData()['section'];
        $filter_data = $form->getData()['filter_section'];
        $user_data = $form->getData()['user_section'];
 
        $settings->setMaxHits((int) $main_data['max_hits']);
 
        switch ((int) $main_data['search_type']) {
            case ilSearchSettings::LIKE_SEARCH:
                $settings->enableLucene(false);
                break;
            case ilSearchSettings::LUCENE_SEARCH:
                $settings->enableLucene(true);
                break;
        }
        $settings->setDefaultOperator((int) $main_data['operator']);
        $settings->enableLuceneItemFilter(!is_null($filter_data['filter']));
        if (!is_null($filter_data['filter'])) {
            $settings->setLuceneItemFilter((array) $filter_data['filter']);
        }
        $settings->enableDateFilter((bool) $filter_data['cdate']);
        $settings->setAutoCompleteLength((int) $user_data['auto_complete_length']);
        $settings->showInactiveUser((bool) $user_data['inactive_user']);
        $settings->showLimitedUser((bool) $user_data['limited_user']);
        $settings->update();
 
        // refresh lucene server
        try {
            if ($settings->enabledLucene()) {
                $this->coordinator->refreshLuceneSettings();
            }
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'edit');
        } catch (Exception $exception) {
            $this->showForm(false, false, $exception->getMessage());
        }
    }
 
    protected function showPermissionDenied(): void
    {
        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
        $this->ctrl->redirect($this, 'readOnly');
    }
 
    protected function initForm(bool $read_only): StandardForm
    {
        $settings = $this->getSettings();
        $field_factory = $this->factory->input()->field();
 
        // Max hits
        $values = [];
        for ($value = 5; $value <= 50; $value += 5) {
            $values[$value] = $value;
        }
        $hits = $field_factory->select(
            $this->lng->txt('seas_max_hits'),
            $values,
            $this->lng->txt('seas_max_hits_info')
        )->withValue($settings->getMaxHits())
         ->withRequired(true);
 
        // Search type
        $type = $field_factory->radio(
            $this->lng->txt('seas_search_type')
        )->withOption(
            (string) ilSearchSettings::LIKE_SEARCH,
            $this->lng->txt('search_direct'),
            $this->lng->txt('search_like_info')
        )->withOption(
            (string) ilSearchSettings::LUCENE_SEARCH,
            $this->lng->txt('search_lucene'),
            $this->lng->txt('java_server_info')
        )->withRequired(true);
 
        if ($settings->enabledLucene()) {
            $type = $type->withValue((string) ilSearchSettings::LUCENE_SEARCH);
        } else {
            $type = $type->withValue((string) ilSearchSettings::LIKE_SEARCH);
        }
 
        // Default operator
        $operator = $field_factory->radio(
            $this->lng->txt('lucene_default_operator'),
            $this->lng->txt('lucene_default_operator_info')
        )->withOption(
            (string) ilSearchSettings::OPERATOR_AND,
            $this->lng->txt('lucene_and')
        )->withOption(
            (string) ilSearchSettings::OPERATOR_OR,
            $this->lng->txt('lucene_or')
        )->withRequired(true)
         ->withValue((string) $settings->getDefaultOperator());
 
        // Item filter
        $filter = $settings->getLuceneItemFilter();
        $checks = [];
        foreach (ilSearchSettings::getLuceneItemFilterDefinitions() as $obj => $def) {
            $checks[$obj] = $field_factory->checkbox(
                $this->lng->txt($def['trans'])
            )->withValue(isset($filter[$obj]) && $filter[$obj]);
        }
 
        $item_filter = $field_factory->optionalGroup(
            $checks,
            $this->lng->txt('search_item_filter_form'),
            $this->lng->txt('search_item_filter_form_info')
        );
        if (!$settings->isLuceneItemFilterEnabled()) {
            $item_filter = $item_filter->withValue(null);
        }
 
        // Filter by date
        $cdate = $field_factory->checkbox(
            $this->lng->txt('search_cdate_filter'),
            $this->lng->txt('search_cdate_filter_info')
        )->withValue($settings->isDateFilterEnabled());
 
        // number of auto complete entries
        $options = [
            0 => 0,
            5 => 5,
            10 => 10,
            20 => 20,
            30 => 30
        ];
        $auto_complete = $field_factory->select(
            $this->lng->txt('search_auto_complete_length'),
            $options,
            $this->lng->txt('search_auto_complete_length_info'),
        )->withRequired(true)->withValue($settings->getAutoCompleteLength());
 
        // Show inactive users
        $inactive_user = $field_factory->checkbox(
            $this->lng->txt('search_show_inactive_user'),
            $this->lng->txt('search_show_inactive_user_info')
        )->withValue($settings->isInactiveUserVisible());
 
        // Show limited users
        $limited_user = $field_factory->checkbox(
            $this->lng->txt('search_show_limited_user'),
            $this->lng->txt('search_show_limited_user_info')
        )->withValue($settings->isLimitedUserVisible());
 
        $section = $this->factory->input()->field()->section(
            [
                'search_type' => $type,
                'max_hits' => $hits,
                'operator' => $operator
            ],
            $this->lng->txt('seas_settings')
        )->withDisabled($read_only);
 
        $filter_section = $this->factory->input()->field()->section(
            [
                'filter' => $item_filter,
                'cdate' => $cdate
            ],
            $this->lng->txt('search_filter_settings_section')
        )->withDisabled($read_only);
 
        $user_section = $this->factory->input()->field()->section(
            [
                'auto_complete_length' => $auto_complete,
                'inactive_user' => $inactive_user,
                'limited_user' => $limited_user
            ],
            $this->lng->txt('user_search_settings_section')
        )->withDisabled($read_only);
 
        if ($read_only) {
            $action = $this->ctrl->getFormAction($this, 'permDenied');
        } else {
            $action = $this->ctrl->getFormAction($this, 'update');
        }
 
        return $this->factory->input()->container()->form()->standard(
            $action,
            [
                'section' => $section,
                'filter_section' => $filter_section,
                'user_section' => $user_section
            ]
        );
    }
 
    protected function getSettings(): ilSearchSettings
    {
        return ilSearchSettings::getInstance();
    }
}