class.ilObjFileAccessSettingsGUI.php

Go to the documentation of this file.

<?php

use ILIAS\components\File\Preview\Form;
use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use ILIAS\UI\Component\Input\Container\Form\Standard;
use ILIAS\HTTP\Services;
use ILIAS\File\Icon\ilObjFileIconsOverviewGUI;
use ILIAS\components\File\Preview\Settings;
use ILIAS\components\File\Settings\General;

class ilObjFileAccessSettingsGUI extends ilObjectGUI
{
    public const CMD_EDIT_SETTINGS = 'editSettings';
    public const CMD_SHOW_PREVIEW_RENDERERS = 'showPreviewRenderers';
    public const SUBTAB_SUFFIX_SPECIFIC_ICONS = 'suffix_specific_icons';
    public const CMD_SAVE_SETTINGS = 'saveSettings';
    public const CMD_VIEW = 'view';
    private ilLanguage $language;
    private Form $preview_settings;
    private \ILIAS\components\File\Settings\Form $file_object_settings;
    protected Factory $ui_factory;
    protected Renderer $ui_renderer;

    public function __construct($a_data, int $a_id, bool $a_call_by_reference)
    {
        global $DIC;
        $this->type = "facs";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->preview_settings = new Form(new Settings());
        $this->file_object_settings = new \ILIAS\components\File\Settings\Form(new General());
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->language = $DIC->language();
    }

    protected function checkAccess(string $permission): void
    {
        if (!$this->access->checkAccess($permission, '', $this->object->getRefId())) {
            $this->ilias->raiseError(
                $this->lng->txt('no_permission'),
                $this->ilias->error_obj->MESSAGE
            );
        }
    }

    private function buildForm(): Standard
    {
        return $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getLinkTarget($this, self::CMD_SAVE_SETTINGS),
            [
                $this->file_object_settings->asFormSection(),
                $this->preview_settings->asFormSection(),
            ]
        );
    }

    #[\Override]
    public function executeCommand(): void
    {
        $this->lng->loadLanguageModule("file");

        $this->prepareOutput();

        $this->checkAccess('read');

        switch ($this->ctrl->getNextClass($this)) {
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            case strtolower(ilObjFileIconsOverviewGUI::class):
                $this->tabs_gui->setTabActive('file_objects');
                $this->addFileObjectsSubTabs();
                $this->tabs_gui->setSubTabActive(self::SUBTAB_SUFFIX_SPECIFIC_ICONS);
                $icon_overview = new ilObjFileIconsOverviewGUI();
                $this->ctrl->forwardCommand($icon_overview);
                break;
            default:
                $cmd = $this->ctrl->getCmd(self::CMD_EDIT_SETTINGS);
                $this->tabs_gui->setTabActive('file_objects');
                switch ($cmd) {
                    case self::CMD_VIEW:
                    case self::CMD_EDIT_SETTINGS:
                        $this->checkAccess('read');
                        $this->editSettings();
                        break;
                    case self::CMD_SAVE_SETTINGS:
                        $this->checkAccess('write');
                        $this->saveSettings();
                        break;
                    default:
                        throw new ilException("ilObjFileAccessSettingsGUI: Command not found: $cmd");
                }
                break;
        }
    }

    #[\Override]
    public function getAdminTabs(): void
    {
        if ($this->rbac_system->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'file_objects',
                $this->ctrl->getLinkTarget($this, self::CMD_EDIT_SETTINGS),
                [self::CMD_EDIT_SETTINGS, self::CMD_VIEW]
            );
        }
        if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "perm_settings",
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm"),
                [],
                'ilpermissiongui'
            );
        }
    }

    protected function addFileObjectsSubTabs(): void
    {
        $this->tabs_gui->addSubTabTarget(
            "settings",
            $this->ctrl->getLinkTarget($this, self::CMD_EDIT_SETTINGS),
            [self::CMD_EDIT_SETTINGS, "view"]
        );
        $this->tabs_gui->addSubTabTarget(
            self::SUBTAB_SUFFIX_SPECIFIC_ICONS,
            $this->ctrl->getLinkTargetByClass(ilObjFileIconsOverviewGUI::class, ilObjFileIconsOverviewGUI::CMD_INDEX),
            [ilObjFileIconsOverviewGUI::CMD_INDEX, "view"]
        );
    }


    protected function editSettings(): void
    {
        $this->addFileObjectsSubTabs();
        $this->tabs_gui->setSubTabActive("settings");
        $form = $this->buildForm();
        $this->tpl->setContent($this->ui_renderer->render($this->buildForm()));
    }

    protected function saveSettings(): void
    {
        $form = $this->buildForm();
        $form = $form->withRequest($this->http->request());

        if ($form->getData() === null) {
            $this->tpl->setContent($this->ui_renderer->render($form));
            return;
        }

        $this->tpl->setOnScreenMessage(
            'success',
            $this->language->txt('settings_saved'),
            true
        );
        $this->ctrl->redirect($this, self::CMD_EDIT_SETTINGS);
    }
}