class.ilObjStudyProgrammeGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2015 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */

require_once("./Services/Container/classes/class.ilContainerGUI.php");
require_once("./Services/AccessControl/classes/class.ilObjRole.php");
require_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
require_once("./Services/AccessControl/classes/class.ilPermissionGUI.php");
require_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
require_once("./Services/Object/classes/class.ilObjectAddNewItemGUI.php");
require_once("./Modules/StudyProgramme/classes/class.ilObjStudyProgrammeTreeGUI.php");
require_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
require_once("./Modules/StudyProgramme/classes/types/class.ilStudyProgrammeTypeGUI.php");
require_once("./Modules/StudyProgramme/classes/model/class.ilStudyProgrammeAdvancedMetadataRecord.php");
require_once("./Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordGUI.php");
require_once("./Services/Object/classes/class.ilObjectCopyGUI.php");
require_once("./Services/Repository/classes/class.ilRepUtil.php");

class ilObjStudyProgrammeGUI extends ilContainerGUI
{
    public $ctrl;

    public $tpl;

    public $tabs_gui;

    protected $ilAccess;

    protected $toolbar;

    protected $ilLocator;

    public $tree;

    public $object;

    protected $ilLog;

    public $ilias;

    protected $help;


    public function __construct()
    {
        global $DIC;
        $tpl = $DIC['tpl'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilAccess = $DIC['ilAccess'];
        $ilToolbar = $DIC['ilToolbar'];
        $ilLocator = $DIC['ilLocator'];
        $tree = $DIC['tree'];
        $lng = $DIC['lng'];
        $ilLog = $DIC['ilLog'];
        $ilias = $DIC['ilias'];
        $ilHelp = $DIC['ilHelp'];

        parent::__construct(array(), (int) $_GET['ref_id'], true, false);

        $this->tpl = $tpl;
        $this->ctrl = $ilCtrl;
        $this->ilAccess = $ilAccess;
        $this->ilLocator = $ilLocator;
        $this->tree = $tree;
        $this->toolbar = $ilToolbar;
        $this->ilLog = $ilLog;
        $this->ilias = $ilias;
        $this->type = "prg";
        $this->help = $ilHelp;

        $lng->loadLanguageModule("prg");
    }


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

        if ($cmd == "") {
            $cmd = "view";
        }

        $this->addToNavigationHistory();

        parent::prepareOutput();

        // show repository tree
        $this->showRepTree();

        switch ($next_class) {
            case "ilinfoscreengui":
                $this->tabs_gui->setTabActive(self::TAB_INFO);
                $this->denyAccessIfNotAnyOf(array("read", "visible"));
                $info = new ilInfoScreenGUI($this);
                $this->fillInfoScreen($info);
                $this->ctrl->forwardCommand($info);

                // I guess this is how it was supposed to work, but it doesn't... it won't respect our sub-id and sub-type when creating the objects!
                // So we reimplemented the stuff in the method parseInfoScreen()
                //                $info = new ilInfoScreenGUI($this);
                //                $amd_gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_INFO, 'orgu', $this->object->getId(), 'orgu_type', $this->object->getOrgUnitTypeId());
                //                $amd_gui->setInfoObject($info);
                //                $amd_gui->setSelectedOnly(true);
                //                $amd_gui->parse();
                //                $this->ctrl->forwardCommand($info);
                break;
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                $ilPermissionGUI = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($ilPermissionGUI);
                break;
            case "ilcommonactiondispatchergui":
                require_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
            case "ilobjstudyprogrammesettingsgui":
                $this->denyAccessIfNot("write");

                $this->getSubTabs('settings');
                $this->tabs_gui->setTabActive(self::TAB_SETTINGS);
                $this->tabs_gui->setSubTabActive('settings');

                require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgrammeSettingsGUI.php");
                $gui = new ilObjStudyProgrammeSettingsGUI($this, $this->ref_id);
                $this->ctrl->forwardCommand($gui);
                break;
            /*case 'iltranslationgui':
                $this->denyAccessIfNot("write");

                $this->getSubTabs('settings');
                $this->tabs_gui->setTabActive("settings");
                $this->tabs_gui->setSubTabActive('edit_translations');

                $ilTranslationGui = new ilTranslationGUI($this);
                $this->ctrl->forwardCommand($ilTranslationGui);
                break;*/
            case "ilobjstudyprogrammemembersgui":
                $this->denyAccessIfNot("manage_members");
                $this->tabs_gui->setTabActive(self::TAB_MEMBERS);
                require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgrammeMembersGUI.php");
                $gui = new ilObjStudyProgrammeMembersGUI($this, $this->ref_id, ilObjStudyProgramme::_getStudyProgrammeUserProgressDB());
                $this->ctrl->forwardCommand($gui);
                break;
            case "ilobjstudyprogrammetreegui":
                $this->denyAccessIfNot("write");

                $this->getSubTabs($cmd);
                $this->setContentSubTabs();
                $this->tabs_gui->setTabActive(self::TAB_VIEW_CONTENT);
                $this->tabs_gui->setSubTabActive(self::SUBTAB_VIEW_TREE);

                // disable admin panel
                $_SESSION["il_cont_admin_panel"] = false;

                $gui = new ilObjStudyProgrammeTreeGUI($this->id);
                $this->ctrl->forwardCommand($gui);
                break;
            case 'ilstudyprogrammetypegui':
                $this->tabs_gui->setTabActive('subtypes');

                $types_gui = new ilStudyProgrammeTypeGUI($this);
                $this->ctrl->forwardCommand($types_gui);
                break;
            case 'ilobjectcopygui':
                $gui = new ilobjectcopygui($this);
                $this->ctrl->forwardCommand($gui);
                break;
            case false:
                $this->getSubTabs($cmd);
                switch ($cmd) {
                    case "cancelDelete":
                        $cmd = "view";
                        // no break
                    case "create":
                    case "save":
                    case "view":
                    case "cancel":
                    case "edit":
                        $this->$cmd();
                        break;
                    case "delete":
                        $this->tabs_gui->clearTargets();
                        $this->tabs_gui->setBackTarget($this->lng->txt("back"), $this->ctrl->getLinkTarget($this));
                        parent::deleteObject();
                        break;
                    case 'confirmedDelete':
                        parent::confirmedDeleteObject();
                        break;
                    case 'editAdvancedSettings':
                        $this->tabs_gui->setTabActive("settings");
                        $this->tabs_gui->setSubTabActive('edit_advanced_settings');
                        //$this->setSubTabsSettings('edit_advanced_settings');
                        $this->editAdvancedSettings();
                        break;
                    case 'updateAdvancedSettings':
                        $this->tabs_gui->setTabActive("settings");
                        $this->tabs_gui->setSubTabActive('edit_advanced_settings');
                        //$this->setSubTabsSettings('edit_advanced_settings');
                        $this->updateAdvancedSettings();
                        break;
                    case "infoScreen":
                        $this->ctrl->redirectByClass("ilInfoScreenGUI", "showSummary");
                        break;
                    case 'getAsynchItemList':
                        parent::getAsynchItemListObject();
                        break;
                    case 'trash':
                    case 'undelete':
                    case 'confirmRemoveFromSystem':
                    case 'removeFromSystem':
                        $cmd .= "Object";
                        $this->$cmd();
                        break;
                    /*case 'editSettings':
                        $this->tabs_gui->setTabActive("settings");
                        $this->setSubTabsSettings('edit_settings');
                        $this->editSettings();
                        break;
                    case '':
                    case 'view':
                    case 'render':
                    case 'cancel':
                    case 'cancelDelete':
                        $this->view();
                        break;
                    case 'create':

                        parent::createObject();
                        break;
                    case 'save':
                        parent::saveObject();
                        break;
                    case 'delete':
                        $this->tabs_gui->clearTargets();
                        $this->tabs_gui->setBackTarget($this->lng->txt("back"), $this->ctrl->getLinkTarget($this));
                        parent::deleteObject();
                        break;
                    case 'confirmedDelete':
                        parent::confirmedDeleteObject();
                        break;
                    case 'cut':
                        $this->tabs_gui->clearTargets();
                        $this->tabs_gui->setBackTarget($this->lng->txt("back"), $this->ctrl->getLinkTarget($this));
                        parent::cutObject();
                        break;
                    case 'clear':
                        parent::clearObject();
                        break;
                    case 'enableAdministrationPanel':
                        parent::enableAdministrationPanelObject();
                        break;
                    case 'disableAdministrationPanel':
                        parent::disableAdministrationPanelObject();
                        break;
                    case 'editSettings':
                        $this->tabs_gui->setTabActive("settings");
                        $this->setSubTabsSettings('edit_settings');
                        $this->editSettings();
                        break;
                    case 'updateSettings':
                        $this->tabs_gui->setTabActive("settings");
                        $this->setSubTabsSettings('edit_settings');
                        $this->updateSettings();
                        break;
                    case 'editAdvancedSettings':
                        $this->tabs_gui->setTabActive("settings");
                        $this->setSubTabsSettings('edit_advanced_settings');
                        $this->editAdvancedSettings();
                        break;
                    case 'updateAdvancedSettings':
                        $this->tabs_gui->setTabActive("settings");
                        $this->setSubTabsSettings('edit_advanced_settings');
                        $this->updateAdvancedSettings();
                        break;*/
                    default:
                        throw new ilException("ilObjStudyProgrammeGUI: Command not supported: $cmd");
                }
                break;
            default:
                throw new ilException("ilObjStudyProgrammeGUI: Can't forward to next class $next_class");
        }
    }


    protected function create()
    {
        parent::createObject();
    }


    protected function save()
    {
        parent::saveObject();

        if ($this->ctrl->isAsynch()) {
            $form = $this->getAsyncCreationForm();
            $form->setValuesByPost();
            echo ilAsyncOutputHandler::encodeAsyncResponse(array("cmd" =>$this->ctrl->getCmd(), "success"=>false, "errors"=>$form->getErrors()));
            exit();
        }
    }


    protected function cancel()
    {
        $async_response = ilAsyncOutputHandler::encodeAsyncResponse(array("cmd" =>"cancel", "success"=>false));

        ilAsyncOutputHandler::handleAsyncOutput("", $async_response, false);

        parent::cancelCreation();
    }


    protected function afterSave(ilObject $a_new_object)
    {
        // set default sort to manual
        $settings = new ilContainerSortingSettings($a_new_object->getId());
        $settings->setSortMode(ilContainer::SORT_MANUAL);
        $settings->setSortDirection(ilContainer::SORT_DIRECTION_ASC);
        $settings->setSortNewItemsOrder(ilContainer::SORT_NEW_ITEMS_ORDER_CREATION);
        $settings->setSortNewItemsPosition(ilContainer::SORT_NEW_ITEMS_POSITION_BOTTOM);
        $settings->save();

        $async_response = ilAsyncOutputHandler::encodeAsyncResponse(array("cmd" =>"cancel", "success"=>true, "message"=>$this->lng->txt("object_added")));

        ilAsyncOutputHandler::handleAsyncOutput("", $async_response, false);

        ilUtil::sendSuccess($this->lng->txt("object_added"), true);

        $this->ctrl->setParameter($this, "ref_id", $a_new_object->getRefId());
        ilUtil::redirect($this->getReturnLocation(
            "save",
            $this->ctrl->getLinkTarget($this, "edit", "", false, false)
        ));
    }


    protected function view()
    {
        $this->denyAccessIfNot("read");
        $this->tabs_gui->setTabActive(self::TAB_VIEW_CONTENT);

        parent::renderObject();
    }

    protected function initAdvancedSettingsForm()
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->addCommandButton('updateAdvancedSettings', $this->lng->txt('save'));
        $form->addCommandButton('editAdvancedSettings', $this->lng->txt('cancel'));

        return $form;
    }

    protected function editAdvancedSettings()
    {
        if (!$this->ilAccess->checkAccess("write", "", $this->ref_id)) {
            ilUtil::sendFailure($this->lng->txt("permission_denied"), true);
            $this->ctrl->redirect($this);
        }
        $form = $this->initAdvancedSettingsForm();
        $gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_EDITOR, 'prg', $this->object->getId(), 'prg_type', $this->object->getSubtypeId());
        $gui->setPropertyForm($form);
        $gui->parse();
        $this->tpl->setContent($form->getHTML());
    }


    protected function updateAdvancedSettings()
    {
        if (!$this->ilAccess->checkAccess("write", "", $this->ref_id)) {
            ilUtil::sendFailure($this->lng->txt("permission_denied"), true);
            $this->ctrl->redirect($this);
        }

        $form = $this->initAdvancedSettingsForm();
        $gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_EDITOR, 'prg', $this->object->getId(), 'prg_type', $this->object->getSubtypeId());
        $gui->setPropertyForm($form);
        $form->checkInput();
        $gui->parse();
        if ($gui->importEditFormPostValues()) {
            $gui->writeEditForm();
            ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'editAdvancedSettings');
        } else {
            $this->tpl->setContent($form->getHTML());
        }
    }


    protected function initCreationForms($a_new_type)
    {
        return array( self::CFORM_NEW => $this->initCreateForm($a_new_type));
    }


    public function getAsyncCreationForm()
    {
        $asyncForm = new ilAsyncPropertyFormGUI();

        $tmp_forms = $this->initCreationForms('prg');
        $asyncForm->cloneForm($tmp_forms[self::CFORM_NEW]);
        $asyncForm->setAsync(true);

        return $asyncForm;
    }

    // HELPERS

    protected function checkAccess($a_which)
    {
        return $this->ilAccess->checkAccess($a_which, "", $this->ref_id);
    }

    protected function denyAccessIfNot($a_perm)
    {
        return $this->denyAccessIfNotAnyOf(array($a_perm));
    }

    protected function denyAccessIfNotAnyOf($a_perms)
    {
        foreach ($a_perms as $perm) {
            if ($this->checkAccess($perm)) {
                return;
            }
        }

        if ($this->checkAccess("visible")) {
            ilUtil::sendFailure($this->lng->txt("msg_no_perm_write"));
            $this->ctrl->redirectByClass('ilinfoscreengui', '');
        }

        $this->ilias->raiseError($this->lng->txt("msg_no_perm_read"), $this->ilias->error_obj->WARNING);
    }

    const TAB_VIEW_CONTENT = "view_content";
    const SUBTAB_VIEW_TREE = "view_tree";
    const TAB_INFO = "info_short";
    const TAB_SETTINGS = "settings";
    const TAB_MEMBERS = "members";
    const TAB_SUBTYPES = "subtypes";

    public function getTabs()
    {
        $this->help->setScreenIdComponent("prg");
        if ($this->checkAccess("read")) {
            $this->tabs_gui->addTab(self::TAB_VIEW_CONTENT, $this->lng->txt("content"), $this->getLinkTarget("view"));
        }

        if ($this->checkAccess("read")) {
            $this->tabs_gui->addTab(
                self::TAB_INFO,
                $this->lng->txt("info_short"),
                $this->getLinkTarget("info_short")
            );
        }

        if ($this->checkAccess("write")) {
            $this->tabs_gui->addTab(
                self::TAB_SETTINGS,
                $this->lng->txt("settings"),
                $this->getLinkTarget("settings")
            );
        }

        if ($this->checkAccess("manage_members")) {
            $this->tabs_gui->addTab(
                self::TAB_MEMBERS,
                $this->lng->txt("members"),
                $this->getLinkTarget("members")
            );
        }
        parent::getTabs();
    }

    public function getSubTabs($a_parent_tab)
    {
        switch ($a_parent_tab) {
            case self::TAB_VIEW_CONTENT:
            case self::SUBTAB_VIEW_TREE:
            case 'view':
                if ($this->checkAccess("read")) {
                    $this->tabs_gui->addSubTab(self::TAB_VIEW_CONTENT, $this->lng->txt("view"), $this->getLinkTarget("view"));
                }

                if ($this->checkAccess("write")) {
                    $this->tabs_gui->addSubTab(self::SUBTAB_VIEW_TREE, $this->lng->txt("cntr_manage"), $this->getLinkTarget(self::SUBTAB_VIEW_TREE));
                }
                break;
            case 'settings':
            case 'editAdvancedSettings':
                $this->tabs_gui->addSubTab('settings', $this->lng->txt('settings'), $this->getLinkTarget('settings'));
                //$this->tabs_gui->addSubTab("edit_translations", $this->lng->txt("obj_multilinguality"), $this->ctrl->getLinkTargetByClass("iltranslationgui", "editTranslations"));

                $type = ilStudyProgrammeType::find($this->object->getSubtypeId());

                if (!is_null($type) && count($type->getAssignedAdvancedMDRecords(true))) {
                    $this->tabs_gui->addSubTab('edit_advanced_settings', $this->lng->txt('prg_adv_settings'), $this->ctrl->getLinkTarget($this, 'editAdvancedSettings'));
                }
                break;
        }
    }


    public function setContentSubTabs()
    {
        return;
    }


    protected function getLinkTarget($a_cmd)
    {
        if ($a_cmd == "info_short") {
            return $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary");
        }
        if ($a_cmd == "settings") {
            return $this->ctrl->getLinkTargetByClass("ilobjstudyprogrammesettingsgui", "view");
        }
        if ($a_cmd == self::SUBTAB_VIEW_TREE) {
            return $this->ctrl->getLinkTargetByClass("ilobjstudyprogrammetreegui", "view");
        }
        if ($a_cmd == "members") {
            return $this->ctrl->getLinkTargetByClass("ilobjstudyprogrammemembersgui", "view");
        }
        if ($a_cmd == "subtypes") {
            return $this->ctrl->getLinkTargetByClass("ilstudyprogrammetypegui", "listTypes");
        }

        return $this->ctrl->getLinkTarget($this, $a_cmd);
    }


    protected function fillInfoScreen($a_info_screen)
    {
        require_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
        require_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
        require_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordGUI.php');
        require_once('./Services/ADT/classes/class.ilADTFactory.php');

        $type = ilStudyProgrammeType::find($this->object->getSubtypeId());
        if (!$type) {
            return;
        }

        $record_gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_INFO, 'prg', $this->object->getId(), 'prg_type', $this->object->getSubtypeId());
        $record_gui->setInfoObject($a_info_screen);
        $record_gui->parse();
    }

    protected function edit()
    {
        $this->denyAccessIfNot("write");

        $this->getSubTabs('settings');
        $this->tabs_gui->setTabActive(self::TAB_SETTINGS);
        $this->tabs_gui->setSubTabActive('settings');

        require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgrammeSettingsGUI.php");
        $gui = new ilObjStudyProgrammeSettingsGUI($this, $this->ref_id);
        $this->ctrl->setCmd("view");
        $this->ctrl->forwardCommand($gui);
    }

    public static function _goto($a_target)
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];
        $ilErr = $DIC['ilErr'];
        $ilCtrl = $DIC['ilCtrl'];
        $id = explode("_", $a_target);
        $ilCtrl->setTargetScript("ilias.php");
        $ilCtrl->initBaseClass("ilRepositoryGUI");
        $ilCtrl->setParameterByClass("ilobjstudyprogrammegui", "ref_id", $id[0]);

        $ilCtrl->redirectByClass(array( "ilRepositoryGUI", "ilobjstudyprogrammegui" ), "view");
    }

    public function addToNavigationHistory()
    {
        global $DIC;
        $ilNavigationHistory = $DIC['ilNavigationHistory'];

        if (!$this->getCreationMode() &&
            $this->ilAccess->checkAccess('read', '', $_GET['ref_id'])) {
            $link = ilLink::_getLink($_GET["ref_id"], "iass");

            $ilNavigationHistory->addItem(
                $_GET['ref_id'],
                $link,
                'prg'
            );
        }
    }
}