class.ilObjSearchSettingsGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
use ILIAS\HTTP\GlobalHttpState;
use ILIAS\Refinery\Factory;
use ILIAS\DI\UIServices;

class ilObjSearchSettingsGUI extends ilObjectGUI
{
    private GlobalHttpState $http;
    protected Factory $refinery;
    protected UIServices $ui;
    protected ilLogger $src_logger;
    protected ilObjUser $user;

    protected bool $read_only = true;

    public function __construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output = true)
    {
        global $DIC;

        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->ui = $DIC->ui();
        $this->src_logger = $DIC->logger()->src();
        $this->user = $DIC->user();

        $this->type = "seas";
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
        $this->lng->loadLanguageModule('search');
    }

    public function executeCommand(): void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();

        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->activateTab('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $ret = $this->ctrl->forwardCommand($perm_gui);
                return;

            case 'ilobjsearchsettingsformgui':
                $this->tabs_gui->activateTab('settings');
                $settings_gui = new ilObjSearchSettingsFormGUI(
                    $this->http,
                    $this->ctrl,
                    $this->lng,
                    $this->ui,
                    new ilObjSearchRpcClientCoordinator(
                        $this->settings,
                        $this->src_logger
                    )
                );
                $ret = $this->ctrl->forwardCommand($settings_gui);
                return;

            case 'ilobjsearchlucenesettingsformgui':
                $this->tabs_gui->activateTab('lucene_settings_tab');
                $luc_settings_gui = new ilObjSearchLuceneSettingsFormGUI(
                    $this->http,
                    $this->ctrl,
                    $this->lng,
                    $this->ui,
                    $this->refinery,
                    $this->user,
                    new ilObjSearchRpcClientCoordinator(
                        $this->settings,
                        $this->src_logger
                    )
                );
                $ret = $this->ctrl->forwardCommand($luc_settings_gui);
                return;
        }

        switch ($cmd) {
            case '':
            case 'view':
            case 'settings':
                $this->redirectToSettings();
                break;

            case 'luceneSettings':
                $this->redirectToLuceneSettings();
                break;

            case 'advancedLuceneSettings':
                $this->advancedLuceneSettingsObject();
                break;

            default:
                $cmd .= "Object";
                $this->$cmd();
        }
    }

    protected function redirectToSettings(): void
    {
        if (!$this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $this->tabs_gui->setTabActive('settings');

        if (!$this->rbac_system->checkAccess('write', $this->object->getRefId())) {
            $this->ctrl->redirectByClass(
                [get_class($this),'ilobjsearchsettingsformgui'],
                'readOnly'
            );
        }

        $this->ctrl->redirectByClass(
            [get_class($this),'ilobjsearchsettingsformgui'],
            'edit'
        );
    }

    protected function redirectToLuceneSettings(): void
    {
        if (!$this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $this->tabs_gui->setTabActive('lucene_settings_tab');

        if (!$this->rbac_system->checkAccess('write', $this->object->getRefId())) {
            $this->ctrl->redirectByClass(
                [get_class($this),'ilobjsearchlucenesettingsformgui'],
                'readOnly'
            );
        }

        $this->ctrl->redirectByClass(
            [get_class($this),'ilobjsearchlucenesettingsformgui'],
            'edit'
        );
    }

    public function getAdminTabs(): void
    {
        $this->getTabs();
    }

    protected function getTabs(): void
    {
        if ($this->rbac_system->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'settings',
                $this->lng->txt('settings'),
                $this->ctrl->getLinkTarget($this, 'settings')
            );
        }

        if ($this->rbac_system->checkAccess('read', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'lucene_advanced_settings',
                $this->lng->txt('lucene_advanced_settings'),
                $this->ctrl->getLinkTarget($this, 'advancedLuceneSettings')
            );
        }

        if ($this->rbac_system->checkAccess('read', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'lucene_settings_tab',
                $this->lng->txt('lucene_settings_tab'),
                $this->ctrl->getLinkTarget($this, 'luceneSettings')
            );
        }

        if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'perm_settings',
                $this->lng->txt('perm_settings'),
                $this->ctrl->getLinkTargetByClass(
                    [get_class($this),'ilpermissiongui'],
                    'perm'
                ),
            );
        }
    }

    protected function advancedLuceneSettingsObject(): void
    {
        $this->tabs_gui->setTabActive('lucene_advanced_settings');

        $table = new ilLuceneAdvancedSearchActivationTableGUI($this, 'advancedLuceneSettings');
        $table->setTitle($this->lng->txt('lucene_advanced_settings_table'));
        $table->parse(ilLuceneAdvancedSearchSettings::getInstance());

        $this->tpl->setContent($table->getHTML());
    }

    protected function saveAdvancedLuceneSettingsObject(): void
    {
        if (!$this->access->checkAccess('write', '', $this->object->getRefId())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->redirect($this, 'settings');
        }

        $enabled_md_ids = new SplFixedArray(0);
        if ($this->http->wrapper()->post()->has('fid')) {
            $enabled_md_ids = $this->http->wrapper()->post()->retrieve(
                'fid',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
            );
        }

        $settings = ilLuceneAdvancedSearchSettings::getInstance();
        foreach (ilLuceneAdvancedSearchFields::getFields() as $field => $translation) {
            $settings->setActive($field, in_array($field, (array) $enabled_md_ids));
        }
        $settings->save();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'advancedLuceneSettings');
    }
}