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

Collaboration diagram for ilIndividualAssessmentMember:

Public Member Functions
	__construct (ilObjIndividualAssessment $iass, ilObjUser $usr, array $data)

	record ()

	internalNote ()

	examinerId ()
	Get the user id of the examiner. More...

	notify ()
	Will the user be notified after finalization? More...

	maybeSendNotification (ilIndividualAssessmentNotificator $notificator)
	Notify a user, if he is supposed to be notified, using some notificator object. More...

	id ()
	Get the user id corresponding to this membership. More...

	assessmentId ()
	Get the ilObjIndividualAssessment id corresponding to this membership. More...

	assessment ()
	Get the ilObjIndividualAssessment corresponding to this membership. More...

	finalized ()
	Is this membership allready finalized? More...

	mayBeFinalized ()
	Can this membership be finalized? More...

	withRecord ($record)
	Clone this object and set a record. More...

	withInternalNote ($internal_note)
	Clone this object and set an internal note. More...

	withExaminerId ($examiner_id)
	Clone this object and set an examiner_id. More...

	withNotify ($notify)
	Clone this object and set wether the examinee should be notified. More...

	withLPStatus ($lp_status)
	Clone this object and set LP-status. More...

	lastname ()
	Get the examinee lastname corresponding to this membership. More...

	firstname ()
	Get the examinee firstname corresponding to this membership. More...

	login ()
	Get the examinee login corresponding to this membership. More...

	name ()
	Get the examinee name corresponding to this membership. More...

	LPStatus ()
	Get the LP-status corresponding to this membership. More...

	withFinalized ()
	Clone this object and finalize. More...

	notificationTS ()
	Get the timestamp, at which the notification was sent. More...

Protected Member Functions
	LPStatusValid ($lp_status)

Protected Attributes
	$iass

	$usr

	$record

	$internal_note

	$examiner_id

	$notify

	$finalized

	$notification_ts

	$lp_status

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

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

Constructor & Destructor Documentation

◆ __construct()

ilIndividualAssessmentMember::__construct	(	ilObjIndividualAssessment	$iass,
		ilObjUser	$usr,
		array	$data
	)

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

References $iass, $usr, ilIndividualAssessmentMembers\FIELD_EXAMINER_ID, ilIndividualAssessmentMembers\FIELD_FINALIZED, ilIndividualAssessmentMembers\FIELD_INTERNAL_NOTE, ilIndividualAssessmentMembers\FIELD_LEARNING_PROGRESS, ilIndividualAssessmentMembers\FIELD_NOTIFICATION_TS, ilIndividualAssessmentMembers\FIELD_NOTIFY, ilIndividualAssessmentMembers\FIELD_RECORD, finalized(), notify(), and record().

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

Here is the call graph for this function:

Member Function Documentation

◆ assessment()

ilIndividualAssessmentMember::assessment ( )

Get the ilObjIndividualAssessment corresponding to this membership.

Returns: ilObjIndividualAssessment

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

References $iass.

Referenced by ilIndividualAssessmentPrimitiveInternalNotificator\withReciever().

                                      {
                 return $this->iass;
         }

Here is the caller graph for this function:

◆ assessmentId()

ilIndividualAssessmentMember::assessmentId ( )

Get the ilObjIndividualAssessment id corresponding to this membership.

Returns: int|string

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

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

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

Here is the caller graph for this function:

◆ examinerId()

ilIndividualAssessmentMember::examinerId ( )

Get the user id of the examiner.

Returns: int|string

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

References $examiner_id.

Referenced by ilIndividualAssessmentMemberGUI\targetWasEditedByOtherUser(), and ilIndividualAssessmentMembersStorageDB\updateMember().

                                      {
                 return $this->examiner_id;
         }

Here is the caller graph for this function:

◆ finalized()

ilIndividualAssessmentMember::finalized ( )

Is this membership allready finalized?

Returns: bool

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

Referenced by __construct(), mayBeFinalized(), maybeSendNotification(), ilIndividualAssessmentMembersStorageDB\updateMember(), withExaminerId(), withInternalNote(), withLPStatus(), withNotify(), and withRecord().

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

Here is the caller graph for this function:

◆ firstname()

ilIndividualAssessmentMember::firstname ( )

Get the examinee firstname corresponding to this membership.

Returns: int|string

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

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

◆ id()

ilIndividualAssessmentMember::id ( )

Get the user id corresponding to this membership.

Returns: int|string

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

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

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

Here is the caller graph for this function:

◆ internalNote()

ilIndividualAssessmentMember::internalNote ( )

Returns: string

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

References $internal_note.

Referenced by ilIndividualAssessmentMemberGUI\fillForm(), and ilIndividualAssessmentMembersStorageDB\updateMember().

                                        {
                 return $this->internal_note;
         }

Here is the caller graph for this function:

◆ lastname()

ilIndividualAssessmentMember::lastname ( )

Get the examinee lastname corresponding to this membership.

Returns: int|string

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

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

◆ login()

ilIndividualAssessmentMember::login ( )

Get the examinee login corresponding to this membership.

Returns: int|string

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

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

◆ LPStatus()

ilIndividualAssessmentMember::LPStatus ( )

Get the LP-status corresponding to this membership.

Returns: int|string

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

References $lp_status.

Referenced by ilIndividualAssessmentMemberGUI\fillForm(), and ilIndividualAssessmentMembersStorageDB\updateMember().

                                    {
                 return $this->lp_status;
         }

Here is the caller graph for this function:

◆ LPStatusValid()

ilIndividualAssessmentMember::LPStatusValid ( $lp_status )

protected

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

References $lp_status, ilIndividualAssessmentMembers\LP_COMPLETED, ilIndividualAssessmentMembers\LP_FAILED, ilIndividualAssessmentMembers\LP_IN_PROGRESS, ilIndividualAssessmentMembers\LP_NOT_ATTEMPTED, and string.

Referenced by withLPStatus().

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

Here is the caller graph for this function:

◆ mayBeFinalized()

ilIndividualAssessmentMember::mayBeFinalized ( )

Can this membership be finalized?

Returns: bool

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

References finalized(), ilIndividualAssessmentMembers\LP_COMPLETED, and ilIndividualAssessmentMembers\LP_FAILED.

Referenced by withFinalized().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maybeSendNotification()

ilIndividualAssessmentMember::maybeSendNotification ( ilIndividualAssessmentNotificator $notificator )

Notify a user, if he is supposed to be notified, using some notificator object.

Parameters

ilIndividualAssessmentNotificator $notificator

Returns: ilIndividualAssessmentMember $this

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

References finalized(), ilIndividualAssessmentMembers\LP_COMPLETED, notify(), string, time, ilIndividualAssessmentNotificator\withOccasionCompleted(), ilIndividualAssessmentNotificator\withOccasionFailed(), and ilIndividualAssessmentNotificator\withReciever().

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

Here is the call graph for this function:

◆ name()

ilIndividualAssessmentMember::name ( )

Get the examinee name corresponding to this membership.

Returns: int|string

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

Referenced by ilIndividualAssessmentMemberGUI\fillForm().

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

Here is the caller graph for this function:

◆ notificationTS()

ilIndividualAssessmentMember::notificationTS ( )

Get the timestamp, at which the notification was sent.

Returns: int|string

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

References $notification_ts.

Referenced by ilIndividualAssessmentMembersStorageDB\updateMember().

                                          {
                 return $this->notification_ts;
         }

Here is the caller graph for this function:

◆ notify()

ilIndividualAssessmentMember::notify ( )

Will the user be notified after finalization?

Returns: bool

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

References $notify.

Referenced by __construct(), ilIndividualAssessmentMemberGUI\fillForm(), maybeSendNotification(), and ilIndividualAssessmentMembersStorageDB\updateMember().

                                  {
                 return $this->notify;
         }

Here is the caller graph for this function:

◆ record()

ilIndividualAssessmentMember::record ( )

Returns: string

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

References $record.

Referenced by __construct(), ilIndividualAssessmentMemberGUI\fillForm(), and ilIndividualAssessmentMembersStorageDB\updateMember().

                                  {
                 return $this->record;
         }

Here is the caller graph for this function:

◆ withExaminerId()

ilIndividualAssessmentMember::withExaminerId ( $examiner_id )

Clone this object and set an examiner_id.

Parameters

int | string $examiner_id

Returns: ilIndividualAssessmentMember

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

References $examiner_id, and finalized().

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

Here is the call graph for this function:

◆ withFinalized()

ilIndividualAssessmentMember::withFinalized ( )

Clone this object and finalize.

Returns: ilIndividualAssessmentMember

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

References mayBeFinalized().

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

Here is the call graph for this function:

◆ withInternalNote()

ilIndividualAssessmentMember::withInternalNote ( $internal_note )

Clone this object and set an internal note.

Parameters

string $internal_note

Returns: ilIndividualAssessmentMember

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

References $internal_note, and finalized().

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

Here is the call graph for this function:

◆ withLPStatus()

ilIndividualAssessmentMember::withLPStatus ( $lp_status )

Clone this object and set LP-status.

Parameters

string $lp_status

Returns: ilIndividualAssessmentMember

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

References $lp_status, finalized(), and LPStatusValid().

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

Here is the call graph for this function:

◆ withNotify()

ilIndividualAssessmentMember::withNotify ( $notify )

Clone this object and set wether the examinee should be notified.

Parameters

bool $notify

Returns: ilIndividualAssessmentMember

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

References $notify, and finalized().

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

Here is the call graph for this function:

◆ withRecord()

ilIndividualAssessmentMember::withRecord ( $record )

Clone this object and set a record.

Parameters

string $record

Returns: ilIndividualAssessmentMember

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

References $record, and finalized().

Referenced by ilIndividualAssessmentMemberGUI\updateDataInMemberByArray().

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