class.ilIndividualAssessmentMemberGUI.php

Go to the documentation of this file.

<?php

require_once 'Services/Form/classes/class.ilTextAreaInputGUI.php';
require_once 'Services/Form/classes/class.ilTextInputGUI.php';
require_once 'Services/Form/classes/class.ilCheckboxInputGUI.php';
require_once 'Services/Form/classes/class.ilNonEditableValueGUI.php';
require_once 'Services/Form/classes/class.ilSelectInputGUI.php';
require_once 'Modules/IndividualAssessment/classes/LearningProgress/class.ilIndividualAssessmentLPInterface.php';
require_once 'Modules/IndividualAssessment/classes/Notification/class.ilIndividualAssessmentPrimitiveInternalNotificator.php';
require_once 'Modules/IndividualAssessment/classes/class.ilIndividualAssessmentLP.php';
require_once 'Modules/IndividualAssessment/classes/FileStorage/class.ilIndividualAssessmentFileStorage.php';
require_once 'Services/Form/classes/class.ilFileInputGUI.php';

class ilIndividualAssessmentMemberGUI
{
    protected $notificator;

    public function __construct($members_gui, $a_parent_gui, $a_ref_id)
    {
        $this->notificator = new ilIndividualAssessmentPrimitiveInternalNotificator();
        global $DIC;
        $this->ctrl = $DIC['ilCtrl'];
        $this->members_gui = $members_gui;
        $this->parent_gui = $a_parent_gui;
        $this->object = $a_parent_gui->object;
        $this->ref_id = $a_ref_id;
        $this->tpl = $DIC['tpl'];
        $this->lng = $DIC['lng'];
        $this->ctrl->saveParameter($this, 'usr_id');
        $this->examinee = new ilObjUser($_GET['usr_id']);
        $this->examiner = $DIC['ilUser'];
        $this->changer = $DIC['ilUser'];
        $this->setTabs($DIC['ilTabs']);
        $this->member = $this->object->membersStorage()
                                ->loadMember($this->object, $this->examinee);
        $this->access = $this->object->accessHandler();
        $this->file_storage = $this->object->getFileStorage();
    }

    public function executeCommand()
    {
        $cmd = $this->ctrl->getCmd();
        switch ($cmd) {
            case 'view':
            case 'edit':
            case 'save':
            case 'finalizeConfirmation':
            case 'finalize':
            case 'cancelFinalize':
            case 'amend':
            case 'saveAmend':
            case 'downloadAttachment':
            case 'deliverFile':
                break;
            default:
                $this->parent_gui->handleAccessViolation();
        }
        $this->$cmd();
    }

    protected function view()
    {
        if (!$this->mayBeViewed()) {
            $this->parent_gui->handleAccessViolation();
            return;
        }
        $form = $this->fillForm($this->initGradingForm(false), $this->member);
        $this->renderForm($form);
    }

    protected function edit(ilPropertyFormGUI $form = null)
    {
        if (!$this->mayBeEdited()) {
            $this->parent_gui->handleAccessViolation();
            return;
        }

        if ($form === null) {
            $form = $this->fillForm($this->initGradingForm(), $this->member);
        }

        $form->addCommandButton('save', $this->lng->txt('save'));
        $form->addCommandButton('finalizeConfirmation', $this->lng->txt('iass_finalize'));
        $this->renderForm($form);
    }

    protected function downloadAttachment()
    {
        if (!$this->mayBeEdited() && !$this->mayBeViewed() && !$this->mayBeAmended()) {
            $this->parent_gui->handleAccessViolation();
            return;
        }
        $file_storage = $this->object->getFileStorage();
        $file_storage->setUserId($this->member->id());
        ilUtil::deliverFile($file_storage->getFilePath(), $this->member->fileName());
    }

    protected function save()
    {
        if (!$this->mayBeEdited()) {
            $this->parent_gui->handleAccessViolation();
            return;
        }

        $form = $this->initGradingForm();
        $item = $form->getItemByPostVar('file');
        if ($item && $item->checkInput()) {
            $post = $_POST;
            $new_file = $this->uploadFile($post["file"]);
            if ($new_file) {
                $this->updateFileName($post['file']['name']);
            }
        }

        $form->setValuesByArray(array('file' => $this->member->fileName()));
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->edit($form);
            return;
        }

        $this->saveMember($_POST);
        if ($this->object->isActiveLP()) {
            ilIndividualAssessmentLPInterface::updateLPStatusOfMember($this->member);
        }
        ilUtil::sendSuccess($this->lng->txt('iass_membership_saved'), true);
        $this->redirect('edit');
    }

    protected function finalizeConfirmation()
    {
        if (!$this->mayBeEdited()) {
            $this->parent_gui->handleAccessViolation();
            return;
        }

        $new_file = null;
        $form = $this->initGradingForm();
        $item = $form->getItemByPostVar('file');
        if ($item && $item->checkInput()) {
            $post = $_POST;
            $new_file = $this->uploadFile($post["file"]);
            if ($new_file) {
                $this->updateFileName($post['file']['name']);
            }
        }

        $form->setValuesByArray(array('file' => $this->member->fileName()));
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->edit($form);
            return;
        }

        $this->saveMember($_POST);

        if (!$this->member->mayBeFinalized()) {
            ilUtil::sendFailure($this->lng->txt('iass_may_not_finalize'), true);
            $this->redirect('edit');
        }

        include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
        $confirm = new ilConfirmationGUI();
        $confirm->addHiddenItem('record', $_POST['record']);
        $confirm->addHiddenItem('internal_note', $_POST['internal_note']);
        $confirm->addHiddenItem('notify', $_POST['notify']);
        $confirm->addHiddenItem('learning_progress', $_POST['learning_progress']);
        $confirm->addHiddenItem('place', $_POST['place']);
        $confirm->addHiddenItem('event_time', $_POST['event_time']);
        $confirm->setHeaderText($this->lng->txt('iass_finalize_user_qst'));
        $confirm->setFormAction($this->ctrl->getFormAction($this));
        $confirm->setConfirm($this->lng->txt('iass_finalize'), 'finalize');
        $confirm->setCancel($this->lng->txt('cancel'), 'save');
        $this->tpl->setContent($confirm->getHTML());
    }

    protected function finalize()
    {
        if (!$this->mayBeEdited()) {
            $this->parent_gui->handleAccessViolation();
            return;
        }

        if (!$this->member->mayBeFinalized()) {
            ilUtil::sendFailure($this->lng->txt('iass_may_not_finalize'), true);
            $this->redirect('edit');
            return;
        }

        $this->member = $this->member->withFinalized();
        $this->object->membersStorage()->updateMember($this->member);
        if ($this->object->isActiveLP()) {
            ilIndividualAssessmentLPInterface::updateLPStatusOfMember($this->member);
        }
        $this->member->maybeSendNotification($this->notificator);

        ilUtil::sendSuccess($this->lng->txt('iass_membership_finalized'), true);
        $this->redirect('view');
    }

    protected function cancelFinalize()
    {
        $this->edit();
    }

    protected function amend($form = null)
    {
        if (!$this->mayBeAmended()) {
            $this->parent_gui->handleAccessViolation();
            return;
        }

        if ($form === null) {
            $form = $this->fillForm($this->initGradingForm(true, true), $this->member);
        }

        $form->addCommandButton('saveAmend', $this->lng->txt('iass_save_amend'));
        $this->renderForm($form, $this->getFileLinkHTML(true));
    }

    protected function saveAmend()
    {
        if (!$this->mayBeAmended()) {
            $this->parent_gui->handleAccessViolation();
            return;
        }
        $new_file = null;
        $form = $this->initGradingForm(true, true);
        $item = $form->getItemByPostVar('file');
        if ($item && $item->checkInput()) {
            $post = $_POST;
            $new_file = $this->uploadFile($post["file"]);
            if ($new_file) {
                $this->updateFileName($post['file']['name']);
            }
        }
        $form->setValuesByArray(array('file' => $this->member->fileName()));
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->amend($form);
            return;
        }

        $this->saveMember($_POST, true, true);

        if ($this->object->isActiveLP()) {
            ilIndividualAssessmentLPInterface::updateLPStatusOfMember($this->member);
        }

        ilUtil::sendSuccess($this->lng->txt('iass_amend_saved'), true);
        $this->redirect("amend");
    }

    protected function initGradingForm($may_be_edited = true, $amend = false)
    {
        require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('iass_edit_record'));

        $examinee_name = $this->examinee->getLastname() . ', ' . $this->examinee->getFirstname();

        $usr_name = new ilNonEditableValueGUI($this->lng->txt('name'), 'name');
        $form->addItem($usr_name);
        // record
        $ti = new ilTextAreaInputGUI($this->lng->txt('iass_record'), 'record');
        $ti->setInfo($this->lng->txt('iass_record_info'));
        $ti->setCols(40);
        $ti->setRows(5);
        $ti->setDisabled(!$may_be_edited);
        $form->addItem($ti);

        // description
        $ta = new ilTextAreaInputGUI($this->lng->txt('iass_internal_note'), 'internal_note');
        $ta->setInfo($this->lng->txt('iass_internal_note_info'));
        $ta->setCols(40);
        $ta->setRows(5);
        $ta->setDisabled(!$may_be_edited);
        $form->addItem($ta);

        if ($this->member->finalized() && !$amend) {
            $link = $this->getFileLinkHTML(true);
            if ($link !== "") {
                $filelink = new ilNonEditableValueGUI($this->lng->txt('iass_upload_file'), '', true);
                $filelink->setValue($link);
                $form->addItem($filelink);
            }
        } else {
            $title = $this->lng->txt('iass_upload_file');
            $link = $this->getFileLinkHTML(true);
            if ($link !== "") {
                $filelink = new ilNonEditableValueGUI($title, '', true);
                $filelink->setValue($link);
                $form->addItem($filelink);
                $title = "";
            }
            $file = new ilFileInputGUI($title, 'file');
            $file->setRequired($this->object->getSettings()->fileRequired() && !$this->fileUploaded());
            $file->setDisabled(!$may_be_edited);
            $file->setAllowDeletion(false);
            $form->addItem($file);
        }


        $file_visible_to_examinee = new ilCheckboxInputGUI($this->lng->txt('iass_file_visible_examinee'), 'file_visible_examinee');
        $file_visible_to_examinee->setDisabled(!$may_be_edited);
        $form->addItem($file_visible_to_examinee);


        $learning_progress = new ilSelectInputGUI($this->lng->txt('grading'), 'learning_progress');
        $learning_progress->setOptions(
            array(ilIndividualAssessmentMembers::LP_IN_PROGRESS => $this->lng->txt('iass_status_pending')
                , ilIndividualAssessmentMembers::LP_COMPLETED => $this->lng->txt('iass_status_completed')
                , ilIndividualAssessmentMembers::LP_FAILED => $this->lng->txt('iass_status_failed'))
        );
        $learning_progress->setDisabled(!$may_be_edited);
        $form->addItem($learning_progress);

        $settings = $this->object->getSettings();
        $txt = new ilTextInputGUI($this->lng->txt('iass_place'), 'place');
        $txt->setRequired($settings->eventTimePlaceRequired());
        $txt->setDisabled(!$may_be_edited);
        $form->addItem($txt);

        $date = new ilDateTimeInputGUI($this->lng->txt('iass_event_time'), 'event_time');
        $date->setShowTime(false);
        $date->setRequired($settings->eventTimePlaceRequired());
        $date->setDisabled(!$may_be_edited);
        $form->addItem($date);

        // notify examinee
        $notify = new ilCheckboxInputGUI($this->lng->txt('iass_notify'), 'notify');
        $notify->setInfo($this->lng->txt('iass_notify_explanation'));
        $notify->setDisabled(!$may_be_edited);
        $form->addItem($notify);

        return $form;
    }

    protected function fileUploaded()
    {
        return $this->member->fileName() && $this->member->fileName() != "";
    }

    protected function fillForm(ilPropertyFormGUI $a_form, ilIndividualAssessmentMember $member)
    {
        $a_form->setValuesByArray(array(
              'name' => $member->name()
            , 'record' => $member->record()
            , 'internal_note' => $member->internalNote()
            , 'place' => $member->place()
            , 'event_time' => $member->eventTime()
            , 'notify' => $member->notify()
            , 'learning_progress' => (int) $member->LPStatus()
            , 'file_visible_examinee' => (int) $member->viewFile()
            , 'file_name' => $this->getFileLinkHTML()
            ));
        return $a_form;
    }

    protected function getFileLinkHTML($amend = false)
    {
        $html = '';
        if ($this->member->fileName() && $this->member->fileName() != "") {
            $tpl = new ilTemplate("tpl.iass_user_file_download.html", true, true, "Modules/IndividualAssessment");
            if (!$this->member->finalized() || $amend) {
                $tpl->setVariable("FILE_NAME", $this->member->fileName());
            }
            $tpl->setVariable("HREF", $this->ctrl->getLinkTarget($this, "downloadAttachment"));
            $html .= $tpl->get();
        }
        return $html;
    }

    protected function renderForm(ilPropertyFormGUI $form)
    {
        $this->tpl->setContent($form->getHTML());
    }

    protected function setTabs(ilTabsGUI $tabs)
    {
        $tabs->clearTargets();
        $tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->getBackLink()
        );
    }

    protected function getBackLink()
    {
        return $this->ctrl->getLinkTargetByClass(
            array(get_class($this->parent_gui)
                    ,get_class($this->members_gui)),
            'view'
        );
    }

    protected function redirect($cmd)
    {
        $this->ctrl->redirect($this, $cmd);
    }

    protected function mayBeEdited()
    {
        return $this->access->isSystemAdmin()
            || (!$this->isFinalized() && $this->userMayGrade());
    }

    protected function mayBeViewed()
    {
        return $this->access->isSystemAdmin()
            || ($this->isFinalized() && ($this->userMayGrade() || $this->userMayView()));
    }

    protected function mayBeAmended()
    {
        return $this->access->isSystemAdmin()
            || ($this->isFinalized() && $this->userMayAmend());
    }

    protected function userMayGrade()
    {
        return $this->access->isSystemAdmin()
            || (!$this->targetWasEditedByOtherUser($this->member) && $this->access->mayGradeUser());
    }

    protected function userMayView()
    {
        return $this->access->isSystemAdmin()
            || $this->access->mayViewUser();
    }

    protected function userMayAmend()
    {
        return $this->access->isSystemAdmin()
            || $this->access->mayAmendGradeUser();
    }

    protected function targetWasEditedByOtherUser(ilIndividualAssessmentMember $member)
    {
        return (int) $member->examinerId() !== (int) $this->examiner->getId()
                && 0 !== (int) $member->examinerId();
    }

    protected function isFinalized()
    {
        return $this->member->finalized();
    }

    protected function saveMember(array $post, $keep_examiner = false, $amend = false)
    {
        $this->member = $this->updateDataInMemberByArray($this->member, $post, $keep_examiner, $amend);
        $this->object->membersStorage()->updateMember($this->member);
    }

    protected function updateDataInMemberByArray(ilIndividualAssessmentMember $member, $data, $keep_examiner = false, $amend = false)
    {
        $member = $member->withRecord($data['record'])
                    ->withInternalNote($data['internal_note'])
                    ->withPlace($data['place'])
                    ->withLPStatus($data['learning_progress'])
                    ->withViewFile((bool) $data['file_visible_examinee']);
        if ($data['event_time']) {
            $member = $member->withEventTime($this->createDate($data['event_time']));
        }
        if ($amend) {
            $member = $member->withChangerId($this->changer->getId());
        }
        if (!$keep_examiner) {
            $member = $member->withExaminerId($this->examiner->getId());
        }

        if ($data['notify'] == 1) {
            $member = $member->withNotify(true);
        } else {
            $member = $member->withNotify(false);
        }
        if ($new_file) {
            $member = $member->withFileName($data['file']['name']);
        }
        return $member;
    }

    private function createDate($datetime)
    {
        return new ilDate($datetime, IL_CAL_DATE);
    }

    protected function uploadFile($file)
    {
        $new_file = false;
        $this->file_storage->setUserId($this->member->id());
        $this->file_storage->create();
        if (!$file["name"] == "") {
            $this->file_storage->deleteCurrentFile();
            $this->file_storage->uploadFile($file);
            $new_file = true;
        }
        return $new_file;
    }

    protected function updateFileName($file_name)
    {
        $this->member = $this->member->withFileName($file_name);
        $this->object->membersStorage()->updateMember($this->member);
    }
}