class.ilIndividualAssessmentMember.php

Go to the documentation of this file.

<?php
require_once 'Modules/IndividualAssessment/classes/class.ilObjIndividualAssessment.php';
require_once 'Services/User/classes/class.ilObjUser.php';
require_once 'Modules/IndividualAssessment/exceptions/class.ilIndividualAssessmentException.php';
require_once 'Modules/IndividualAssessment/classes/Members/class.ilIndividualAssessmentMembers.php';
class ilIndividualAssessmentMember {
        protected $iass;
        protected $usr;

        protected $record;
        protected $internal_note;
        protected $examiner_id;
        protected $notify;
        protected $finalized;
        protected $notification_ts;
        protected $lp_status;

        public function __construct(ilObjIndividualAssessment $iass, ilObjUser $usr, array $data) {

                $this->record = $data[ilIndividualAssessmentMembers::FIELD_RECORD];
                $this->internal_note = $data[ilIndividualAssessmentMembers::FIELD_INTERNAL_NOTE];
                $this->examiner_id = $data[ilIndividualAssessmentMembers::FIELD_EXAMINER_ID];
                $this->notify = $data[ilIndividualAssessmentMembers::FIELD_NOTIFY] ? true : false;
                $this->finalized = $data[ilIndividualAssessmentMembers::FIELD_FINALIZED] ? true : false;
                $this->lp_status = $data[ilIndividualAssessmentMembers::FIELD_LEARNING_PROGRESS];
                $this->notification_ts = $data[ilIndividualAssessmentMembers::FIELD_NOTIFICATION_TS];
                $this->iass = $iass;
                $this->usr = $usr;
        }

        public function record() {
                return $this->record;
        }

        public function internalNote() {
                return $this->internal_note;
        }

        public function examinerId() {
                return $this->examiner_id;
        }

        public function notify() {
                return $this->notify;
        }

        public function maybeSendNotification(ilIndividualAssessmentNotificator $notificator) {
                if(!$this->finalized()) {
                        throw new ilIndividualAssessmentException('must finalize before notification');
                }
                if($this->notify) {
                        $notificator = (string)$this->lp_status === (string)ilIndividualAssessmentMembers::LP_COMPLETED ?
                                $notificator->withOccasionCompleted() :
                                $notificator->withOccasionFailed();
                        $notificator->withReciever($this)->send();
                        $this->notification_ts = time();
                }
                return $this;
        }

        public function id() {
                return $this->usr->getId();
        }

        public function assessmentId() {
                return $this->iass->getId();
        }

        public function assessment() {
                return $this->iass;
        }

        public function finalized() {
                return (string)$this->finalized === "1" ? true : false;
        }

        public function mayBeFinalized() {
                return ((string)$this->lp_status === (string)ilIndividualAssessmentMembers::LP_COMPLETED
                                ||(string)$this->lp_status === (string)ilIndividualAssessmentMembers::LP_FAILED)
                                && !$this->finalized();
        }

        public function withRecord($record) {
                assert('is_string($record) || $record === null');
                if(!$this->finalized()) {
                        $clone = clone $this;
                        $clone->record = $record;
                        return $clone;
                }
                throw new ilIndividualAssessmentException('user allready finalized');
        }

        public function withInternalNote($internal_note) {
                assert('is_string($internal_note) || $internal_note === null');
                if(!$this->finalized()) {
                        $clone = clone $this;
                        $clone->internal_note = $internal_note;
                        return $clone;
                }
                throw new ilIndividualAssessmentException('user allready finalized');
        }

        public function withExaminerId($examiner_id) {
                assert('is_numeric($examiner_id)');
                if(!$this->finalized()) {
                        assert('ilObjUser::_exists($examiner_id)');
                        $clone = clone $this;
                        $clone->examiner_id = $examiner_id;
                        return $clone;
                }
                throw new ilIndividualAssessmentException('user allready finalized');
        }

        public function withNotify($notify) {
                assert('is_bool($notify)');
                if(!$this->finalized()) {
                        $clone = clone $this;
                        $clone->notify = (bool)$notify;
                        return $clone;
                }
                throw new ilIndividualAssessmentException('user allready finalized');
        }

        protected function LPStatusValid($lp_status) {
                return (string)$lp_status === (string)ilIndividualAssessmentMembers::LP_NOT_ATTEMPTED
                                ||(string)$lp_status === (string)ilIndividualAssessmentMembers::LP_IN_PROGRESS
                                ||(string)$lp_status === (string)ilIndividualAssessmentMembers::LP_COMPLETED
                                ||(string)$lp_status === (string)ilIndividualAssessmentMembers::LP_FAILED;
        }

        public function withLPStatus($lp_status) {
                if(!$this->finalized() && $this->LPStatusValid($lp_status)) {
                        $clone = clone $this;
                        $clone->lp_status = $lp_status;
                        return $clone;
                }
                throw new ilIndividualAssessmentException('user allready finalized or invalid learning progress status');
        }

        public function lastname() {
                return $this->usr->getLastname();
        }

        public function firstname() {
                return $this->usr->getFirstname();
        }

        public function login() {
                return $this->usr->getLogin();
        }

        public function name() {
                return $this->usr->getFullname();
        }

        public function LPStatus() {
                return $this->lp_status;
        }

        public function withFinalized() {
                if($this->mayBeFinalized()) {
                        $clone = clone $this;
                        $clone->finalized = 1;
                        return $clone;
                }
                throw new ilIndividualAssessmentException('user cant be finalized');
        }

        public function notificationTS() {
                return $this->notification_ts;
        }
}