class.ilObjStudyProgrammeAdminGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilObjStudyProgrammeAdminGUI extends ilMembershipAdministrationGUI
{
    protected ilErrorHandling $error;
    protected ilStudyProgrammeTypeGUI $type_gui;

    public function __construct($data, int $id, bool $call_by_reference = true, bool $prepare_output = true)
    {
        parent::__construct($data, $id, $call_by_reference, $prepare_output);

        $this->type = 'prgs';
        $this->lng->loadLanguageModule('prg');
        $this->type_gui = ilStudyProgrammeDIC::dic()['ilStudyProgrammeTypeGUI'];
    }

    protected function getType(): string
    {
        return "prgs";
    }

    protected function getParentObjType(): string
    {
        return "prg";
    }

    protected function getAdministrationFormId(): int
    {
        return ilAdministrationSettingsFormHandler::FORM_PRG;
    }

    protected function addChildContentsTo(ilPropertyFormGUI $form): ilPropertyFormGUI
    {
        return $form;
    }

    protected function saveChildSettings(ilPropertyFormGUI $form): void
    {
    }

    protected function getChildSettingsInfo($a_form_id): array
    {
        return [];
    }

    public function executeCommand(): void
    {
        //Check Permissions globally for all SubGUIs. We only check write permissions
        if (!$this->rbac_system->checkAccess("visible,read", $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt("no_permission"), $this->error->WARNING);
        }
        $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);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            case 'ilstudyprogrammetypegui':
                $this->tabs_gui->activateTab('prg_subtypes');
                $this->type_gui->setParentGUI($this);
                $this->ctrl->forwardCommand($this->type_gui);
                break;
            default:
                if (!$cmd || $cmd === "view") {
                    $cmd = "editSettings";
                }
                $this->$cmd();
                break;
        }
    }

    public function editSettings(?ilPropertyFormGUI $form = null): void
    {
        $this->tabs_gui->activateTab('settings');
        if (is_null($form)) {
            $form = $this->initFormSettings();
        }
        $this->tpl->setContent($form->getHTML());
    }

    public function initFormSettings(): ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "saveSettings"));
        $form->setTitle($this->lng->txt("settings"));

        $this->addFieldsToForm($form);

        ilAdministrationSettingsFormHandler::addFieldsToForm(
            $this->getAdministrationFormId(),
            $form,
            $this
        );

        $radio_grp = new ilRadioGroupInputGUI($this->lng->txt("prg_show_programmes"), "visible_on_personal_desktop");
        $radio_grp->addOption(new ilRadioOption(
            $this->lng->txt("prg_show_programmes_on_pd_always"),
            ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_ALLWAYS
        ));
        $radio_grp->addOption(new ilRadioOption(
            $this->lng->txt("prg_show_programmes_on_pd_only_read"),
            ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_READ
        ));
        $value = $this->settings->get(ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD);
        $value = ($value) ?: ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_READ;
        $radio_grp->setValue($value);
        $form->addItem($radio_grp);

        if ($this->access->checkAccess("write", "", $this->object->getRefId())) {
            $form->addCommandButton("saveSettings", $this->lng->txt("save"));
            $form->addCommandButton("view", $this->lng->txt("cancel"));
        }

        return $form;
    }

    public function saveSettings(): void
    {
        $this->checkPermission("write");

        $form = $this->initFormSettings();
        if ($form->checkInput()) {
            if ($this->save($form)) {
                $this->settings->set(
                    ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD,
                    $form->getInput('visible_on_personal_desktop')
                );

                $this->tpl->setOnScreenMessage("success", $this->lng->txt("settings_saved"), true);
                $this->ctrl->redirect($this, "editSettings");
            }
        }

        $form->setValuesByPost();
        $this->editSettings($form);
    }

    public function getAdminTabs(): void
    {
        if ($this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'settings',
                $this->ctrl->getLinkTargetByClass('ilObjStudyProgrammeAdminGUI', 'view')
            );

            $this->tabs_gui->addTarget(
                'prg_subtypes',
                $this->ctrl->getLinkTargetByClass(
                    array('ilObjStudyProgrammeAdminGUI', 'ilStudyProgrammeTypeGUI'),
                    'listTypes'
                )
            );
        }
        if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'perm_settings',
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', 'perm'),
                array(),
                'ilpermissiongui'
            );
        }
    }

    public function _goto($ref_id): void
    {
        $this->ctrl->setTargetScript('ilias.php');
        $this->ctrl->setParameterByClass("ilObjStudyProgrammeAdminGUI", "ref_id", $ref_id);
        $this->ctrl->setParameterByClass("ilObjStudyProgrammeAdminGUI", "admin_mode", "settings");
        $this->ctrl->redirectByClass(array("ilAdministrationGUI", "ilObjStudyProgrammeAdminGUI"), "view");
    }

    protected function save(ilPropertyFormGUI $form): bool
    {
        return true;
    }
}