Edit the record of a user, set LP. More...

Collaboration diagram for ilIndividualAssessmentMember:

Public Member Functions
	__construct (ilObjIndividualAssessment $iass, ilObjUser $usr, ?ilIndividualAssessmentUserGrading $grading, ?int $examiner_id, int $notification_ts, ?int $changer_id, ?DateTime $change_time)

	record ()

	internalNote ()

	examinerId ()

	changerId ()

	changeTime ()

	notify ()

	maybeSendNotification (ilIndividualAssessmentNotificator $notificator)

	id ()

	assessmentId ()

	assessment ()

	finalized ()

	mayBeFinalized ()

	withExaminerId (int $examiner_id)

	withChangerId (int $changer_id)

	withChangeTime (DateTime $change_time=null)

	lastname ()

	firstname ()

	login ()

	name ()

	LPStatus ()

	notificationTS ()

	place ()

	eventTime ()

	fileName ()

	viewFile ()

	getGrading ()

	withGrading ($grading)

Protected Member Functions
	LPStatusValid ($lp_status)

Protected Attributes
	$iass

	$usr

	$grading

	$examiner_id

	$notification_ts

	$changer_id

	$change_time

Detailed Description

Edit the record of a user, set LP.

Author: Denis Klöpfer denis.nosp@m..klo.nosp@m.epfer.nosp@m.@con.nosp@m.cepts.nosp@m.-and.nosp@m.-trai.nosp@m.ning.nosp@m..de; Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 10 of file class.ilIndividualAssessmentMember.php.

Constructor & Destructor Documentation

◆ __construct()

ilIndividualAssessmentMember::__construct	(	ilObjIndividualAssessment	$iass,
		ilObjUser	$usr,
		?ilIndividualAssessmentUserGrading	$grading,
		?int	$examiner_id,
		int	$notification_ts,
		?int	$changer_id,
		?DateTime	$change_time
	)

Definition at line 47 of file class.ilIndividualAssessmentMember.php.

      {
        $this->iass = $iass;
        $this->usr = $usr;
        $this->grading = $grading;
        $this->examiner_id = $examiner_id;
        $this->notification_ts = $notification_ts;
        $this->changer_id = $changer_id;
        $this->change_time = $change_time;
    }

References $change_time, $changer_id, $examiner_id, $grading, $iass, $notification_ts, and $usr.

Member Function Documentation

◆ assessment()

ilIndividualAssessmentMember::assessment ( )

Definition at line 121 of file class.ilIndividualAssessmentMember.php.

                                 : ilObjIndividualAssessment
    {
        return $this->iass;
    }

Referenced by ilIndividualAssessmentPrimitiveInternalNotificator\withReciever().

Here is the caller graph for this function:

◆ assessmentId()

ilIndividualAssessmentMember::assessmentId ( )

Definition at line 116 of file class.ilIndividualAssessmentMember.php.

                                   : int
    {
        return (int) $this->iass->getId();
    }

Referenced by ilIndividualAssessmentLPInterface\updateLPStatusOfMember(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ changerId()

ilIndividualAssessmentMember::changerId ( )

Definition at line 80 of file class.ilIndividualAssessmentMember.php.

                                : ?int
    {
        return $this->changer_id;
    }

References $changer_id.

Referenced by ilIndividualAssessmentMembersTableGUI\importantInfos(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ changeTime()

ilIndividualAssessmentMember::changeTime ( )

Definition at line 85 of file class.ilIndividualAssessmentMember.php.

                                 : ?DateTime
    {
        return $this->change_time;
    }

References $change_time.

Referenced by ilIndividualAssessmentMembersTableGUI\importantInfos().

Here is the caller graph for this function:

◆ eventTime()

ilIndividualAssessmentMember::eventTime ( )

Definition at line 210 of file class.ilIndividualAssessmentMember.php.

                                : ?DateTimeImmutable
    {
        return $this->grading->getEventTime();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\importantInfos(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ examinerId()

ilIndividualAssessmentMember::examinerId ( )

Definition at line 75 of file class.ilIndividualAssessmentMember.php.

                                 : ?int
    {
        return $this->examiner_id;
    }

References $examiner_id.

Referenced by ilIndividualAssessmentMembersTableGUI\getAction(), ilIndividualAssessmentMembersTableGUI\getContent(), ilIndividualAssessmentMembersTableGUI\getFurtherFields(), ilIndividualAssessmentMembersTableGUI\getSubheadline(), ilIndividualAssessmentMembersTableGUI\importantInfos(), ilIndividualAssessmentMemberGUI\targetWasEditedByOtherUser(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ fileName()

ilIndividualAssessmentMember::fileName ( )

Definition at line 215 of file class.ilIndividualAssessmentMember.php.

                               : ?string
    {
        return $this->grading->getFile();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\getAction(), ilIndividualAssessmentMembersTableGUI\getContent(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ finalized()

ilIndividualAssessmentMember::finalized ( )

Definition at line 126 of file class.ilIndividualAssessmentMember.php.

                                : bool
    {
        return $this->grading->isFinalized();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\getAction(), ilIndividualAssessmentMembersTableGUI\getContent(), ilIndividualAssessmentMembersTableGUI\getFurtherFields(), ilIndividualAssessmentMembersTableGUI\getSubheadline(), ilIndividualAssessmentMembersTableGUI\importantInfos(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ firstname()

ilIndividualAssessmentMember::firstname ( )

Definition at line 180 of file class.ilIndividualAssessmentMember.php.

                                : string
    {
        return $this->usr->getFirstname();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\getHeadline().

Here is the caller graph for this function:

◆ getGrading()

ilIndividualAssessmentMember::getGrading ( )

Definition at line 225 of file class.ilIndividualAssessmentMember.php.

                                 : ilIndividualAssessmentUserGrading
    {
        return $this->grading;
    }

◆ id()

ilIndividualAssessmentMember::id ( )

Definition at line 111 of file class.ilIndividualAssessmentMember.php.

                         : int
    {
        return (int) $this->usr->getId();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\getAction(), ilIndividualAssessmentMembersTableGUI\getContent(), ilIndividualAssessmentMembersTableGUI\getFurtherFields(), ilIndividualAssessmentLPInterface\updateLPStatusOfMember(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ internalNote()

ilIndividualAssessmentMember::internalNote ( )

Definition at line 70 of file class.ilIndividualAssessmentMember.php.

                                   : string
    {
        return $this->grading->getInternalNote();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\getContent(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ lastname()

ilIndividualAssessmentMember::lastname ( )

Definition at line 175 of file class.ilIndividualAssessmentMember.php.

                               : string
    {
        return $this->usr->getLastname();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\getHeadline().

Here is the caller graph for this function:

◆ login()

ilIndividualAssessmentMember::login ( )

Definition at line 185 of file class.ilIndividualAssessmentMember.php.

                            : string
    {
        return $this->usr->getLogin();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\getHeadline().

Here is the caller graph for this function:

◆ LPStatus()

ilIndividualAssessmentMember::LPStatus ( )

Definition at line 195 of file class.ilIndividualAssessmentMember.php.

                               : int
    {
        return $this->grading->getLearningProgress();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\getSubheadline(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ LPStatusValid()

ilIndividualAssessmentMember::LPStatusValid ( $lp_status )

protected

Definition at line 167 of file class.ilIndividualAssessmentMember.php.

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

References ilIndividualAssessmentMembers\LP_COMPLETED, ilIndividualAssessmentMembers\LP_FAILED, ilIndividualAssessmentMembers\LP_IN_PROGRESS, and ilIndividualAssessmentMembers\LP_NOT_ATTEMPTED.

◆ mayBeFinalized()

ilIndividualAssessmentMember::mayBeFinalized ( )

Definition at line 131 of file class.ilIndividualAssessmentMember.php.

                                     : bool
    {
        if ($this->iass->getSettings()->isFileRequired() && (string) $this->fileName() === '') {
            return false;
        }
        return in_array(
            $this->LPStatus(),
            [
                ilIndividualAssessmentMembers::LP_COMPLETED,
                ilIndividualAssessmentMembers::LP_FAILED
            ]
        ) &&
            !$this->finalized();
    }

References ilIndividualAssessmentMembers\LP_COMPLETED, and ilIndividualAssessmentMembers\LP_FAILED.

◆ maybeSendNotification()

ilIndividualAssessmentMember::maybeSendNotification ( ilIndividualAssessmentNotificator $notificator )

Definition at line 95 of file class.ilIndividualAssessmentMember.php.

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

◆ name()

ilIndividualAssessmentMember::name ( )

Definition at line 190 of file class.ilIndividualAssessmentMember.php.

                           : string
    {
        return $this->usr->getFullname();
    }

◆ notificationTS()

ilIndividualAssessmentMember::notificationTS ( )

Definition at line 200 of file class.ilIndividualAssessmentMember.php.

                                     : int
    {
        return $this->notification_ts;
    }

Referenced by ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ notify()

ilIndividualAssessmentMember::notify ( )

Definition at line 90 of file class.ilIndividualAssessmentMember.php.

                             : bool
    {
        return $this->grading->isNotify();
    }

Referenced by ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ place()

ilIndividualAssessmentMember::place ( )

Definition at line 205 of file class.ilIndividualAssessmentMember.php.

                            : string
    {
        return $this->grading->getPlace();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\getFurtherFields(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ record()

ilIndividualAssessmentMember::record ( )

Definition at line 65 of file class.ilIndividualAssessmentMember.php.

                             : string
    {
        return $this->grading->getRecord();
    }

Referenced by ilIndividualAssessmentMembersTableGUI\getContent(), and ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ viewFile()

ilIndividualAssessmentMember::viewFile ( )

Definition at line 220 of file class.ilIndividualAssessmentMember.php.

                               : bool
    {
        return $this->grading->isFileVisible();
    }

Referenced by ilIndividualAssessmentMembersStorageDB\updateMember().

Here is the caller graph for this function:

◆ withChangerId()

ilIndividualAssessmentMember::withChangerId ( int $changer_id )

Definition at line 153 of file class.ilIndividualAssessmentMember.php.

                                                   : ilIndividualAssessmentMember
    {
        $clone = clone $this;
        $clone->changer_id = $changer_id;
        return $clone;
    }

◆ withChangeTime()

ilIndividualAssessmentMember::withChangeTime ( DateTime $change_time = null )

Definition at line 160 of file class.ilIndividualAssessmentMember.php.

                                                                 : ilIndividualAssessmentMember
    {
        $clone = clone $this;
        $clone->change_time = $change_time;
        return $clone;
    }

◆ withExaminerId()

ilIndividualAssessmentMember::withExaminerId ( int $examiner_id )

Definition at line 146 of file class.ilIndividualAssessmentMember.php.

                                                     : ilIndividualAssessmentMember
    {
        $clone = clone $this;
        $clone->examiner_id = $examiner_id;
        return $clone;
    }

◆ withGrading()

ilIndividualAssessmentMember::withGrading ( $grading )

Definition at line 230 of file class.ilIndividualAssessmentMember.php.

                                          : ilIndividualAssessmentMember
    {
        $clone = clone $this;
        $clone->grading = $grading;
        return $clone;
    }

Field Documentation

◆ $change_time

ilIndividualAssessmentMember::$change_time

protected

Definition at line 45 of file class.ilIndividualAssessmentMember.php.

Referenced by __construct(), and changeTime().

◆ $changer_id

ilIndividualAssessmentMember::$changer_id

protected

Definition at line 40 of file class.ilIndividualAssessmentMember.php.

Referenced by __construct(), and changerId().

◆ $examiner_id

ilIndividualAssessmentMember::$examiner_id

protected

Definition at line 30 of file class.ilIndividualAssessmentMember.php.

Referenced by __construct(), and examinerId().

◆ $grading

ilIndividualAssessmentMember::$grading

protected

Definition at line 25 of file class.ilIndividualAssessmentMember.php.

Referenced by __construct().

◆ $iass

ilIndividualAssessmentMember::$iass

protected

Definition at line 15 of file class.ilIndividualAssessmentMember.php.

Referenced by __construct().

◆ $notification_ts

ilIndividualAssessmentMember::$notification_ts

protected

Definition at line 35 of file class.ilIndividualAssessmentMember.php.

Referenced by __construct().

◆ $usr

ilIndividualAssessmentMember::$usr

protected

Definition at line 20 of file class.ilIndividualAssessmentMember.php.

Referenced by __construct().

The documentation for this class was generated from the following file:

Modules/IndividualAssessment/classes/Members/class.ilIndividualAssessmentMember.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assessment()

◆ assessmentId()

◆ changerId()

◆ changeTime()

◆ eventTime()

◆ examinerId()

◆ fileName()

◆ finalized()

◆ firstname()

◆ getGrading()

◆ id()

◆ internalNote()

◆ lastname()

◆ login()

◆ LPStatus()

◆ LPStatusValid()

◆ mayBeFinalized()

◆ maybeSendNotification()

◆ name()

◆ notificationTS()

◆ notify()

◆ place()

◆ record()

◆ viewFile()

◆ withChangerId()

◆ withChangeTime()

◆ withExaminerId()

◆ withGrading()

Field Documentation

◆ $change_time

◆ $changer_id

◆ $examiner_id

◆ $grading

◆ $iass

◆ $notification_ts

◆ $usr