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;
    protected $place;
    protected $event_time;
    protected $changer_id;
    protected $change_time;

    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->place = $data[ilIndividualAssessmentMembers::FIELD_PLACE];
        $this->event_time = new ilDateTime($data[ilIndividualAssessmentMembers::FIELD_EVENTTIME], IL_CAL_UNIX);
        $this->changer_id = $data[ilIndividualAssessmentMembers::FIELD_CHANGER_ID];
        $this->file_name = $data[ilIndividualAssessmentMembers::FIELD_FILE_NAME];
        $this->view_file = $data[ilIndividualAssessmentMembers::FIELD_USER_VIEW_FILE];
        $this->change_time = new ilDateTime($data[ilIndividualAssessmentMembers::FIELD_CHANGE_TIME], IL_CAL_DATETIME);
        $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 changerId()
    {
        return $this->changer_id;
    }

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

    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()
    {
        if ($this->iass->getSettings()->fileRequired() && (string) $this->file_name === '') {
            return false;
        }
        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');
        $clone = clone $this;
        $clone->record = $record;
        return $clone;
    }

    public function withInternalNote($internal_note)
    {
        assert('is_string($internal_note) || $internal_note === null');
        $clone = clone $this;
        $clone->internal_note = $internal_note;
        return $clone;
    }

    public function withPlace($place)
    {
        assert('is_string($place) || is_null($place)');
        $clone = clone $this;
        $clone->place = $place;
        return $clone;
    }

    public function withEventTime($event_time)
    {
        assert('$event_time instanceof ilDateTime || is_null($event_time)');
        $clone = clone $this;
        $clone->event_time = $event_time;
        return $clone;
    }

    public function withExaminerId($examiner_id)
    {
        assert('is_numeric($examiner_id)');
        assert('ilObjUser::_exists($examiner_id)');
        $clone = clone $this;
        $clone->examiner_id = $examiner_id;
        return $clone;
    }

    public function withChangerId($changer_id)
    {
        assert('is_numeric($changer_id)');
        assert('ilObjUser::_exists($changer_id)');
        $clone = clone $this;
        $clone->changer_id = $changer_id;
        return $clone;
    }

    public function withChangeTime($change_time)
    {
        assert('$change_time instanceof ilDateTime || is_null($change_time)');
        $clone = clone $this;
        $clone->change_time = $change_time;
        return $clone;
    }

    public function withNotify($notify)
    {
        assert('is_bool($notify)');
        $clone = clone $this;
        $clone->notify = (bool) $notify;
        return $clone;
    }

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

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

    public function eventTime()
    {
        return $this->event_time;
    }
    public function fileName()
    {
        return $this->file_name;
    }

    public function withFileName($file_name)
    {
        assert('is_string($file_name)');
        $clone = clone $this;
        $clone->file_name = $file_name;
        return $clone;
    }

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

    public function withViewFile($view_file)
    {
        assert('is_bool($view_file)');
        $clone = clone $this;
        $clone->view_file = $view_file;
        return $clone;
    }
}