class.ilObjIndividualAssessmentGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilObjIndividualAssessmentGUI extends ilObjectGUI
{
    public const TAB_SETTINGS = 'settings';
    public const TAB_INFO = 'info_short';
    public const TAB_PERMISSION = 'perm_settings';
    public const TAB_MEMBERS = 'members';
    public const TAB_LP = 'learning_progress';
    public const TAB_EXPORT = 'export';
    public const TAB_META_DATA = "meta_data";

    protected ilNavigationHistory $ilNavigationHistory;
    protected ilObjUser $usr;
    protected ilErrorHandling $error_object;
    protected ilAccessHandler $ilAccess;
    protected ILIAS\Refinery\Factory $refinery;
    protected ILIAS\HTTP\Wrapper\RequestWrapper $request_wrapper;
    protected ILIAS\ResourceStorage\Services $irss;


    public function __construct($data, int $id = 0, bool $call_by_reference = true, bool $prepare_output = true)
    {
        global $DIC;
        $this->ilNavigationHistory = $DIC['ilNavigationHistory'];
        $this->type = 'iass';
        $this->tpl = $DIC['tpl'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->usr = $DIC['ilUser'];
        $this->error_object = $DIC['ilErr'];
        $this->lng = $DIC['lng'];
        $this->lng->loadLanguageModule('iass');
        $this->tpl->loadStandardTemplate();
        $this->refinery = $DIC->refinery();
        $this->request_wrapper = $DIC->http()->wrapper()->query();
        $this->irss = $DIC['resource_storage'];

        parent::__construct($data, $id, $call_by_reference, $prepare_output);
    }

    protected function addLocatorItems(): void
    {
        if (is_object($this->object)) {
            $this->locator->addItem(
                $this->object->getTitle(),
                $this->ctrl->getLinkTarget($this, "view"),
                "",
                $this->object->getRefId()
            );
        }
    }

    protected function recordIndividualAssessmentRead(): void
    {
        ilChangeEvent::_recordReadEvent(
            $this->object->getType(),
            $this->object->getRefId(),
            $this->object->getId(),
            $this->usr->getId()
        );
    }

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

        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->activateTab(self::TAB_PERMISSION);
                $ilPermissionGUI = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($ilPermissionGUI);
                break;
            case 'ilindividualassessmentsettingsgui':
                $this->tabs_gui->activateTab(self::TAB_SETTINGS);
                $gui = $this->object->getSettingsGUI();
                $this->ctrl->forwardCommand($gui);
                break;
            case 'ilindividualassessmentmembersgui':
                $this->membersObject();
                break;
            case 'ilinfoscreengui':
                $this->tabs_gui->activateTab(self::TAB_INFO);
                $info = $this->buildInfoScreen();
                $this->ctrl->forwardCommand($info);
                break;
            case 'illearningprogressgui':
                $this->tabs_gui->activateTab(self::TAB_LP);
                $learning_progress = new ilLearningProgressGUI(
                    ilLearningProgressBaseGUI::LP_CONTEXT_REPOSITORY,
                    $this->object->getRefId(),
                    $this->usr->getId()
                );
                $this->ctrl->forwardCommand($learning_progress);
                break;
            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
            case "ilexportgui":
                $this->tabs_gui->activateTab(self::TAB_EXPORT);
                $exp_gui = new ilExportGUI($this); // $this is the ilObj...GUI class of the resource
                $exp_gui->addFormat("xml");
                $this->ctrl->forwardCommand($exp_gui);
                break;
            case 'ilobjectmetadatagui':
                $this->checkPermissionBool("write");
                $this->tabs_gui->activateTab(self::TAB_META_DATA);
                $md_gui = new ilObjectMetaDataGUI($this->object);
                $this->ctrl->forwardCommand($md_gui);
                break;
            case 'ilobjectcopygui':
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('crs');
                $this->ctrl->forwardCommand($cp);
                break;
            default:
                if (!$cmd) {
                    $cmd = 'view';
                    if ($this->object->accessHandler()->mayViewAnyUser() || $this->object->accessHandler()->mayEditMembers()) {
                        $this->ctrl->redirectByClass(ilIndividualAssessmentMembersGUI::class, 'view');
                    }
                }
                if ($cmd === 'edit' && $this->object->accessHandler()->simulateMember()) {
                    $cmd = 'view';
                }

                $cmd .= 'Object';
                $this->$cmd();
        }

        $this->addHeaderAction();
    }

    public function viewObject(): void
    {
        $this->tabs_gui->activateTab(self::TAB_INFO);
        $this->recordIndividualAssessmentRead();
        $this->ctrl->redirectByClass(ilInfoScreenGUI::class, 'showSummary');
    }

    public function membersObject(): void
    {
        $this->tabs_gui->activateTab(self::TAB_MEMBERS);
        $gui = $this->object->getMembersGUI();
        $this->ctrl->forwardCommand($gui);
    }

    protected function buildInfoScreen(): ilInfoScreenGUI
    {
        $info = new ilInfoScreenGUI($this);
        if ($this->object) {
            $record_gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_INFO, 'iass', $this->object->getId());
            $record_gui->setInfoObject($info);
            $record_gui->parse();

            $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());

            $info = $this->addGeneralDataToInfo($info);
            if ($this->object->loadMembers()->userAllreadyMember($this->usr)) {
                $info = $this->addMemberDataToInfo($info);
            }
            $info = $this->addContactDataToInfo($info);
        }
        return $info;
    }

    protected function addMemberDataToInfo(ilInfoScreenGUI $info): ilInfoScreenGUI
    {
        $member = $this->object->membersStorage()->loadMember($this->object, $this->usr);
        $info->addSection($this->txt('grading_info'));
        if ($member->finalized()) {
            $info->addProperty($this->txt('grading'), $this->getEntryForStatus($member->LPStatus()));
        }
        if ($member->notify() && $member->finalized()) {
            $info->addProperty($this->txt('grading_record'), nl2br($member->record()));
            if (($member->viewFile()) && $member->fileName() && $member->fileName() != "") {
                $tpl = new ilTemplate("tpl.iass_user_file_download.html", true, true, "components/ILIAS/IndividualAssessment");
                $tpl->setVariable("FILE_NAME", $member->fileName());
                $tpl->setVariable("HREF", $this->ctrl->getLinkTarget($this, "downloadFile"));
                $info->addProperty($this->txt('iass_upload_file'), $tpl->get());
            }
        }

        return $info;
    }

    protected function downloadFileObject(): void
    {
        $member = $this->object->membersStorage()->loadMember($this->object, $this->usr);
        if (
            $member
            && $member->notify()
            && $member->finalized()
            && $member->viewFile()
            && $member->fileName()
            && $member->fileName() != ""
        ) {
            $identifier = $member->getGrading()->getFile();
            $resource_id = $this->irss->manage()->find($identifier);
            if ($resource_id) {
                $this->irss->consume()->download($resource_id)->run();
            }
        }
    }

    protected function addGeneralDataToInfo(ilInfoScreenGUI $info): ilInfoScreenGUI
    {
        $content = $this->object->getSettings()->getContent();
        if ($content !== null && $content !== '') {
            $info->addSection($this->txt('general'));
            $info->addProperty($this->txt('content'), $content);
        }
        return $info;
    }

    protected function addContactDataToInfo(ilInfoScreenGUI $info): ilInfoScreenGUI
    {
        $info_settings = $this->object->getInfoSettings();
        if ($this->shouldShowContactInfo($info_settings)) {
            $info->addSection($this->txt('iass_contact_info'));
            $info->addProperty($this->txt('iass_contact'), $info_settings->getContact());
            $info->addProperty($this->txt('iass_responsibility'), $info_settings->getResponsibility());
            $info->addProperty($this->txt('iass_phone'), $info_settings->getPhone());
            $info->addProperty($this->txt('iass_mails'), $info_settings->getMails());
            $info->addProperty($this->txt('iass_consultation_hours'), $info_settings->getConsultationHours());
        }
        return $info;
    }

    protected function shouldShowContactInfo(ilIndividualAssessmentInfoSettings $info_settings): bool
    {
        $val = $info_settings->getContact();
        if ($val !== null && $val !== '') {
            return true;
        }
        $val = $info_settings->getResponsibility();
        if ($val !== null && $val !== '') {
            return true;
        }
        $val = $info_settings->getPhone();
        if ($val !== null && $val !== '') {
            return true;
        }
        $val = $info_settings->getMails();
        if ($val !== null && $val !== '') {
            return true;
        }
        $val = $info_settings->getConsultationHours();
        if ($val !== null && $val !== '') {
            return true;
        }
        return false;
    }

    protected function getTabs(): void
    {
        if ($this->object->accessHandler()->mayEditMembers()
            || $this->object->accessHandler()->mayGradeAnyUser()
            || $this->object->accessHandler()->mayAmendAllUsers()
            || $this->object->accessHandler()->mayViewAnyUser()) {
            $this->tabs_gui->addTab(
                self::TAB_MEMBERS,
                $this->txt('il_iass_members'),
                $this->getLinkTarget('members')
            );
        }

        if ($this->object->accessHandler()->mayReadObject()) {
            $this->tabs_gui->addTab(
                self::TAB_INFO,
                $this->txt('info_short'),
                $this->getLinkTarget('info')
            );
        }

        if ($this->object->accessHandler()->mayEditObject()) {
            $this->tabs_gui->addTab(
                self::TAB_SETTINGS,
                $this->txt('settings'),
                $this->getLinkTarget('settings')
            );
        }

        if (($this->object->accessHandler()->mayViewAllUsers()
            || $this->object->accessHandler()->mayEditLearningProgressSettings()
            || ($this->object->loadMembers()->userAllreadyMember($this->usr)
            && $this->object->isActiveLP()))
            && ilObjUserTracking::_enabledLearningProgress()) {
            $this->tabs_gui->addTab(
                self::TAB_LP,
                $this->txt('learning_progress'),
                $this->ctrl->getLinkTargetByClass('illearningprogressgui')
            );
        }

        if ($this->object->accessHandler()->mayEditObject()) {
            $mdgui = new ilObjectMetaDataGUI($this->object);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $this->tabs_gui->addTab(
                    self::TAB_META_DATA,
                    $this->txt("meta_data"),
                    $mdtab
                );
            }
        }

        if ($this->object->accessHandler()->mayEditObject()) {
            $this->tabs_gui->addTarget(
                self::TAB_EXPORT,
                $this->ctrl->getLinkTargetByClass('ilexportgui', ''),
                'export',
                'ilexportgui'
            );
        }

        if ($this->object->accessHandler()->mayEditPermissions()) {
            $this->tabs_gui->addTarget(
                self::TAB_PERMISSION,
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', 'perm'),
                array(),
                'ilpermissiongui'
            );
        }
        parent::getTabs();
    }

    protected function getLinkTarget(string $cmd): string
    {
        if ($cmd == 'settings') {
            return $this->ctrl->getLinkTargetByClass('ilindividualassessmentsettingsgui', 'edit');
        }
        if ($cmd == 'info') {
            return $this->ctrl->getLinkTarget($this, 'view');
        }
        if ($cmd == 'members') {
            return $this->ctrl->getLinkTargetByClass('ilindividualassessmentmembersgui', 'view');
        }
        return $this->ctrl->getLinkTarget($this, $cmd);
    }

    public function editObject(): void
    {
        $link = $this->getLinkTarget('settings');
        $this->ctrl->redirectToURL($link);
    }

    public function getBaseEditForm(): ilPropertyFormGUI
    {
        return $this->initEditForm();
    }

    public function handleAccessViolation(): void
    {
        $this->error_object->raiseError($this->txt("msg_no_perm_read"), $this->error_object->WARNING);
    }

    public static function _goto(string $a_target, string $a_add = ''): void
    {
        global $DIC;
        $a_target = (int) $a_target;
        if ($DIC['ilAccess']->checkAccess('write', '', $a_target)) {
            ilObjectGUI::_gotoRepositoryNode($a_target, 'edit');
        }
        if ($DIC['ilAccess']->checkAccess('read', '', $a_target)) {
            ilObjectGUI::_gotoRepositoryNode($a_target);
        }
    }

    protected function getEntryForStatus(int $status): string
    {
        switch ($status) {
            case ilIndividualAssessmentMembers::LP_IN_PROGRESS:
                return $this->txt('iass_status_pending');
            case ilIndividualAssessmentMembers::LP_COMPLETED:
                return $this->txt('iass_status_completed');
            case ilIndividualAssessmentMembers::LP_FAILED:
                return $this->txt('iass_status_failed');
            default:
                throw new ilIndividualAssessmentException("Status for id $status not found!");
        }
    }

    protected function afterSave(ilObject $new_object): void
    {
        $this->tpl->setOnScreenMessage("success", $this->txt("iass_added"), true);
        $this->ctrl->setParameter($this, "ref_id", $new_object->getRefId());
        $this->ctrl->redirectToUrl($this->ctrl->getLinkTargetByClass(
            'ilIndividualassessmentsettingsgui',
            'edit',
            '',
            false,
            false
        ));
    }

    public function addToNavigationHistory(): void
    {
        if (!$this->getCreationMode()) {
            if ($this->object->accessHandler()->mayReadObject()) {
                $ref_id = $this->request_wrapper->retrieve("ref_id", $this->refinery->kindlyTo()->int());
                $link = ilLink::_getLink($ref_id, "iass");
                $this->ilNavigationHistory->addItem($ref_id, $link, 'iass');
            }
        }
    }

    protected function txt(string $code): string
    {
        return $this->lng->txt($code);
    }
}