Member administration related logic, add and remove members, get the list of all members, etc. More...

Inheritance diagram for ilIndividualAssessmentMembers:

Collaboration diagram for ilIndividualAssessmentMembers:

Public Member Functions
	__construct (ilObjIndividualAssessment $iass)

	count ()
	Countable Methods. More...

	current ()
	Iterator Methods. More...

	key ()

	next ()

	rewind ()

	valid ()

	referencedObject ()
	Get the Individual assessment object that is corresponding to this. More...

	recordOK (array $record)
	Check the validity of a record before adding it to this. More...

	userAllreadyMemberByUsrId ($usr_id)
	Check if a user with user_id is member of this. More...

	userAllreadyMember (ilObjUser $usr)
	Check if a user is member of this. More...

	withAdditionalRecord (array $record)
	Clone this and add an additional record. More...

	withAdditionalUser (ilObjUser $usr)
	Clone this and add an additional record created for user. More...

	withoutPresentUser (ilObjUser $usr)
	Clone this andremove record corresponding to user. More...

	membersIds ()
	Get the ids of all the users being member in this iass. More...

	updateStorageAndRBAC (ilIndividualAssessmentMembersStorage $storage, IndividualAssessmentAccessHandler $access_handler)
	Store the data to a persistent medium. More...

Data Fields
const	FIELD_FIRSTNAME = 'firstname'

const	FIELD_LASTNAME = 'lastname'

const	FIELD_LOGIN = 'login'

const	FIELD_USR_ID = 'usr_id'

const	FIELD_LEARNING_PROGRESS = 'learning_progress'

const	FIELD_EXAMINER_ID = 'examiner_id'

const	FIELD_EXAMINER_FIRSTNAME = 'examiner_firstname'

const	FIELD_EXAMINER_LASTNAME = 'examiner_lastname'

const	FIELD_RECORD = 'record'

const	FIELD_INTERNAL_NOTE = 'internal_note'

const	FIELD_NOTIFY = 'notify'

const	FIELD_FINALIZED = 'finalized'

const	FIELD_NOTIFICATION_TS = 'notification_ts'

const	LP_NOT_ATTEMPTED = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM

const	LP_IN_PROGRESS = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM

const	LP_COMPLETED = ilLPStatus::LP_STATUS_COMPLETED_NUM

const	LP_FAILED = ilLPStatus::LP_STATUS_FAILED_NUM

Protected Member Functions
	userExists ($usr_id)

	buildNewRecordOfUser (ilObjUser $usr)

Protected Attributes
	$member_records = array()

	$position = 0

	$iass

Detailed Description

Member administration related logic, add and remove members, get the list of all members, etc.

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 12 of file class.ilIndividualAssessmentMembers.php.

Constructor & Destructor Documentation

◆ __construct()

ilIndividualAssessmentMembers::__construct ( ilObjIndividualAssessment $iass )

Definition at line 36 of file class.ilIndividualAssessmentMembers.php.

References $iass.

                                                                      {
                 $this->iass = $iass;
         }

Member Function Documentation

◆ buildNewRecordOfUser()

ilIndividualAssessmentMembers::buildNewRecordOfUser ( ilObjUser $usr )

protected

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

References array, ilObjUser\getFirstname(), ilObject\getId(), ilObjUser\getLastname(), and ilObjUser\getLogin().

Referenced by withAdditionalUser().

                                                                 {
                 return array(
                           self::FIELD_USR_ID                            => $usr->getId()
                         , self::FIELD_RECORD                            => $this->iass->getSettings()->recordTemplate()
                         , self::FIELD_NOTIFY                            => 0
                         , self::FIELD_FIRSTNAME                         => $usr->getFirstname()
                         , self::FIELD_LASTNAME                          => $usr->getLastname()
                         , self::FIELD_LOGIN                                     => $usr->getLogin()
                         , self::FIELD_LEARNING_PROGRESS         => self::LP_NOT_ATTEMPTED
                         , self::FIELD_EXAMINER_ID                       => null
                         , self::FIELD_EXAMINER_FIRSTNAME        => null
                         , self::FIELD_EXAMINER_LASTNAME         => null
                         , self::FIELD_INTERNAL_NOTE                     => null
                         , self::FIELD_FINALIZED                         => 0
                         );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ count()

ilIndividualAssessmentMembers::count ( )

Countable Methods.

Definition at line 43 of file class.ilIndividualAssessmentMembers.php.

Referenced by valid().

                                 {
                 return count($this->member_records);
         }

Here is the caller graph for this function:

◆ current()

ilIndividualAssessmentMembers::current ( )

Iterator Methods.

Definition at line 50 of file class.ilIndividualAssessmentMembers.php.

                                   {
                 return current($this->member_records);
         }

◆ key()

ilIndividualAssessmentMembers::key ( )

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

                               {
                 return key($this->member_records);
         }

◆ membersIds()

ilIndividualAssessmentMembers::membersIds ( )

Get the ids of all the users being member in this iass.

Returns: int|string[]

Definition at line 197 of file class.ilIndividualAssessmentMembers.php.

                                      {
                 return array_keys($this->member_records);
         }

◆ next()

ilIndividualAssessmentMembers::next ( )

Definition at line 58 of file class.ilIndividualAssessmentMembers.php.

                                {
                 $this->position++;
                 next($this->member_records);
         }

◆ recordOK()

ilIndividualAssessmentMembers::recordOK ( array $record )

Check the validity of a record before adding it to this.

Parameters

int|string|null[] $record

Returns: bool

Definition at line 87 of file class.ilIndividualAssessmentMembers.php.

References array, userAllreadyMemberByUsrId(), and userExists().

Referenced by withAdditionalRecord().

                                                 {
                 if(isset($record[self::FIELD_USR_ID])) {
                         if(!$this->userExists($record[self::FIELD_USR_ID])
                                 || $this->userAllreadyMemberByUsrId($record[self::FIELD_USR_ID])) {
                                 return false;
                         }
                 }
                 if(!in_array($record[self::FIELD_LEARNING_PROGRESS],
                         array(self::LP_NOT_ATTEMPTED, self::LP_FAILED, self::LP_COMPLETED, self::LP_IN_PROGRESS))) {
                         return false;
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ referencedObject()

ilIndividualAssessmentMembers::referencedObject ( )

Get the Individual assessment object that is corresponding to this.

Returns: ilObjIndividualAssessment

Definition at line 77 of file class.ilIndividualAssessmentMembers.php.

References $iass.

Referenced by updateStorageAndRBAC().

                                            {
                 return $this->iass;
         }

Here is the caller graph for this function:

◆ rewind()

ilIndividualAssessmentMembers::rewind ( )

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

                                  {
                 $this->position = 0;
                 reset($this->member_records);
         }

◆ updateStorageAndRBAC()

ilIndividualAssessmentMembers::updateStorageAndRBAC	(	ilIndividualAssessmentMembersStorage	$storage,
		IndividualAssessmentAccessHandler	$access_handler
	)

Store the data to a persistent medium.

Parameters

ilIndividualAssessmentMembersStorage	$storage
IndividualAssessmentAccessHandler	$access_handler

Definition at line 207 of file class.ilIndividualAssessmentMembers.php.

References $iass, IndividualAssessmentAccessHandler\assignUserToMemberRole(), IndividualAssessmentAccessHandler\deassignUserFromMemberRole(), ilIndividualAssessmentMembersStorage\insertMembersRecord(), ilIndividualAssessmentMembersStorage\loadMembers(), referencedObject(), ilIndividualAssessmentMembersStorage\removeMembersRecord(), and userAllreadyMemberByUsrId().

Referenced by ilObjIndividualAssessment\updateMembers().

                                                                                                                                                {
                 $current = $storage->loadMembers($this->referencedObject());
                 $iass = $this->referencedObject();
                 foreach($this as $usr_id => $record) {
                         if(!$current->userAllreadyMemberByUsrId($usr_id)) {
                                 $storage->insertMembersRecord($this->referencedObject(),$record);
                                 $access_handler->assignUserToMemberRole(new ilObjUser($usr_id),$iass);
                         }
                 }
                 foreach($current as $usr_id => $record) {
                         if(!$this->userAllreadyMemberByUsrId($usr_id)) {
                                 $storage->removeMembersRecord($this->referencedObject(),$record);
                                 $access_handler->deassignUserFromMemberRole(new ilObjUser($usr_id),$iass);
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ userAllreadyMember()

ilIndividualAssessmentMembers::userAllreadyMember ( ilObjUser $usr )

Check if a user is member of this.

Parameters

ilObjUser $usr

Returns: bool

Definition at line 117 of file class.ilIndividualAssessmentMembers.php.

References ilObject\getId(), and userAllreadyMemberByUsrId().

Referenced by withAdditionalUser().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ userAllreadyMemberByUsrId()

ilIndividualAssessmentMembers::userAllreadyMemberByUsrId ( $usr_id )

Check if a user with user_id is member of this.

Parameters

int | string $usr_id

Returns: bool

Definition at line 107 of file class.ilIndividualAssessmentMembers.php.

Referenced by recordOK(), updateStorageAndRBAC(), and userAllreadyMember().

                                                            {
                 return isset($this->member_records[$usr_id]);
         }

Here is the caller graph for this function:

◆ userExists()

ilIndividualAssessmentMembers::userExists ( $usr_id )

protected

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

References ilObject\_exists().

Referenced by recordOK().

                                                {
                 return ilObjUser::_exists($usr_id,false,'usr');
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valid()

ilIndividualAssessmentMembers::valid ( )

Definition at line 68 of file class.ilIndividualAssessmentMembers.php.

References count().

                                 {
                 return $this->position < count($this->member_records);
         }

Here is the call graph for this function:

◆ withAdditionalRecord()

ilIndividualAssessmentMembers::withAdditionalRecord ( array $record )

Clone this and add an additional record.

Parameters

int|string|null[] $record

Returns: ilIndividualAssessmentMembers

Exceptions

ilIndividualAssessmentException

Definition at line 132 of file class.ilIndividualAssessmentMembers.php.

References recordOK().

                                                             {
                 if($this->recordOK($record)) {
                         $clone = clone $this;
                         $clone->member_records[$record[self::FIELD_USR_ID]] = $record;
                         return $clone;
                 }
                 throw new ilIndividualAssessmentException('illdefined record');
         }

Here is the call graph for this function:

◆ withAdditionalUser()

ilIndividualAssessmentMembers::withAdditionalUser ( ilObjUser $usr )

Clone this and add an additional record created for user.

Parameters

ilObjUser $usr

Returns: ilIndividualAssessmentMembers

Exceptions

ilIndividualAssessmentException

Definition at line 148 of file class.ilIndividualAssessmentMembers.php.

References buildNewRecordOfUser(), ilObject\getId(), and userAllreadyMember().

                                                            {
                 if(!$this->userAllreadyMember($usr)) {
                         $clone = clone $this;
                         $clone->member_records[$usr->getId()] = $this->buildNewRecordOfUser($usr);
                         return $clone;
                 }
                 throw new ilIndividualAssessmentException('User allready member');
         }

Here is the call graph for this function:

◆ withoutPresentUser()

ilIndividualAssessmentMembers::withoutPresentUser ( ilObjUser $usr )

Clone this andremove record corresponding to user.

Parameters

ilObjUser $usr

Returns: ilIndividualAssessmentMembers

Exceptions

ilIndividualAssessmentException

Definition at line 181 of file class.ilIndividualAssessmentMembers.php.

References ilObject\getId().

                                                            {
                 $usr_id = $usr->getId();
                 if(isset($this->member_records[$usr_id]) && (string)$this->member_records[$usr_id][self::FIELD_FINALIZED] !== "1") {
                         $clone = clone $this;
                         unset($clone->member_records[$usr->getId()]);
                         return $clone;
                 }
                 throw new ilIndividualAssessmentException('User not member or allready finished');
         }