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';

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->setTabs($DIC['ilTabs']);
                        $this->member = $this->object->membersStorage()
                                                                ->loadMember($this->object, $this->examinee);
        }

        public function executeCommand() {
                $edited_by_other = $this->targetWasEditedByOtherUser($this->member);
                $read_permission = $this->object->accessHandler()->checkAccessToObj($this->object,'read_learning_progress');
                $edit_permission = $this->object->accessHandler()->checkAccessToObj($this->object,'edit_learning_progress');
                if(!$read_permission && !$edit_permission) {
                        $a_parent_gui->handleAccessViolation();
                }
                $cmd = $this->ctrl->getCmd();
                switch($cmd) {
                        case 'edit':
                        case 'save':
                        case 'finalize':
                        case 'finalizeConfirmation':
                                if($edited_by_other || !$edit_permission) {
                                        $a_parent_gui->handleAccessViolation();
                                }
                                break;
                        case 'view':
                                if(($edited_by_other || !$edit_permission) && !$read_permission) {
                                        $a_parent_gui->handleAccessViolation();
                                }
                                break;
                        case 'cancel':
                                break;
                        default:
                                $a_parent_gui->handleAccessViolation();
                }
                $this->$cmd();
        }

        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 cancel() {
                $this->ctrl->redirect($this->members_gui);
        }

        protected function finalizeConfirmation() {
                if($this->mayBeEdited()) {
                        $form = $this->initGradingForm();
                        $form->setValuesByArray($_POST);
                        if($form->checkInput()) {
                                $member = $this->updateDataInMemberByArray($this->member,$_POST);
                                if($member->mayBeFinalized()) {
                                        $this->parent_gui->setScreenId("iass", "member", "finalizeConfirmation");
                                        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->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());
                                } else {
                                        ilUtil::sendFailure($this->lng->txt('iass_may_not_finalize'));
                                        $this->edit();
                                }
                        } else {
                                $this->edit();
                        }
                } else {
                        $this->view();
                }
        }

        protected function finalize() {
                if($this->mayBeEdited()) {
                        $form = $this->initGradingForm();
                        $form->setValuesByArray($_POST);
                        if($form->checkInput()) {
                                $member = $this->updateDataInMemberByArray($this->member,$_POST);
                                if($member->mayBeFinalized()) {
                                        $this->member = $member->withFinalized()->maybeSendNotification($this->notificator);
                                        $this->object->membersStorage()->updateMember($this->member);
                                        ilUtil::sendSuccess($this->lng->txt('iass_membership_finalized'));
                                        if($this->object->isActiveLP()) {
                                                ilIndividualAssessmentLPInterface::updateLPStatusOfMember($this->member);
                                        }
                                        $this->view();
                                } else {
                                        ilUtil::sendFailure($this->lng->txt('iass_may_not_finalize'));
                                        $this->edit();
                                }
                        } else {
                                $this->edit();
                        }
                } else {
                        $this->view();
                }
        }

        protected function mayBeEdited() {
                return !$this->member->finalized() && !$this->targetWasEditedByOtherUser($this->member);
        }

        protected function edit() {
                if($this->mayBeEdited()) {
                        $this->parent_gui->setScreenId("iass", "member", "edit");
                        $form = $this->fillForm($this->initGradingForm(),$this->member);
                        $this->renderForm($form);
                } else {
                        $this->view();
                }
        }

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

        protected function view() {
                $this->parent_gui->setScreenId("iass", "member", "view");
                $form = $this->fillForm($this->initGradingForm(false),$this->member);
                $this->renderForm($form);
        }

        protected function save() {
                if($this->mayBeEdited()) {
                        $this->parent_gui->setScreenId("iass", "member", "save");
                        $form = $this->initGradingForm();
                        $form->setValuesByArray($_POST);
                        if($form->checkInput()) {
                                $this->member = $this->updateDataInMemberByArray($this->member,$_POST);
                                $this->object->membersStorage()->updateMember($this->member);
                                ilUtil::sendSuccess($this->lng->txt('iass_membership_saved'));
                                if($this->object->isActiveLP()) {
                                        ilIndividualAssessmentLPInterface::updateLPStatusOfMember($this->member);
                                }
                        }
                        $this->renderForm($form);
                } else {
                        $this->view();
                }
        }

        protected function updateDataInMemberByArray(ilIndividualAssessmentMember $member, $data) {
                $member = $member->withRecord($data['record'])
                                        ->withInternalNote($data['internal_note'])
                                        ->withLPStatus($data['learning_progress'])
                                        ->withExaminerId($this->examiner->getId())
                                        ->withNotify(($data['notify']  == 1 ? true : false));
                return $member;
        }

        protected function initGradingForm($may_be_edited = true) {
                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);

                $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);

                // 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);

                if($may_be_edited) {
                        $form->addCommandButton('save', $this->lng->txt('save'));
                        $form->addCommandButton('finalizeConfirmation',$this->lng->txt('iass_finalize'));
                }
                $form->addCommandButton('cancel', $this->lng->txt('iass_return'));
                return $form;
        }

        protected function fillForm(ilPropertyFormGUI $a_form, ilIndividualAssessmentMember $member) {
                $a_form->setValuesByArray(array(
                          'name' => $member->name()
                        , 'record' => $member->record()
                        , 'internal_note' => $member->internalNote()
                        , 'notify' => $member->notify()
                        , 'learning_progress' => (int)$member->LPStatus()
                        ));
                return $a_form;
        }

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