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 a record. More...

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

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

	withOnlyUsersByIds (array $keep_users_ids)
	Remove all users that do not exist in list of given ids. More...

	withAccessHandling (ilOrgUnitPositionAndRBACAccessHandler $access_handler)
	Get a collection like this, but only including users that are visible according to the supplied access handler. 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_CHANGER_ID = "changer_id"

const	FIELD_CHANGER_FIRSTNAME = "changer_firstname"

const	FIELD_CHANGER_LASTNAME = "changer_lastname"

const	FIELD_CHANGE_TIME = "change_time"

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	FIELD_PLACE = "place"

const	FIELD_EVENTTIME = "event_time"

const	FIELD_FILE_NAME = "file_name"

const	FIELD_USER_VIEW_FILE = "user_view_file"

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

const	LP_ASSESSMENT_NOT_COMPLETED = "not_completed"

Protected Member Functions
	userExists (int $usr_id)

	buildNewRecordOfUser (ilObjUser $usr)

Protected Attributes
array	$member_records = array()

int	$position = 0

ilObjIndividualAssessment	$iass

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilIndividualAssessmentMembers::__construct ( ilObjIndividualAssessment $iass )

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

    {
        $this->iass = $iass;
    }

References $iass.

Member Function Documentation

◆ buildNewRecordOfUser()

ilIndividualAssessmentMembers::buildNewRecordOfUser ( ilObjUser $usr )

protected

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

                                                           : array
    {
        return [
            self::FIELD_USR_ID => $usr->getId(),
            self::FIELD_RECORD => $this->iass->getSettings()->getRecordTemplate(),
            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_FILE_NAME => null,
            self::FIELD_USER_VIEW_FILE => false,
            self::FIELD_FINALIZED => 0,
            self::FIELD_CHANGER_ID => null,
            self::FIELD_CHANGER_FIRSTNAME => null,
            self::FIELD_CHANGER_LASTNAME => null
        ];
    }

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

Referenced by TestObj\buildNewRecordOfUserWrapper(), and withAdditionalUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ count()

ilIndividualAssessmentMembers::count ( )

Countable Methods.

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

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

References count().

Referenced by count(), and valid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ current()

ilIndividualAssessmentMembers::current ( )

Iterator Methods.

Returns: false|mixed

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

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

References current().

Referenced by current().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ key()

ilIndividualAssessmentMembers::key ( )

Returns: int|string|null

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

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

References key().

Referenced by key().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ membersIds()

ilIndividualAssessmentMembers::membersIds ( )

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

Returns: int[]|string[]

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

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

Referenced by withOnlyUsersByIds().

Here is the caller graph for this function:

◆ next()

ilIndividualAssessmentMembers::next ( )

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

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

References next().

Referenced by next().

Here is the call graph for this function:

Here is the caller graph for this function:

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

                                           : bool
    {
        if (isset($record[self::FIELD_USR_ID])) {
            if (
                !$this->userExists((int) $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;
    }

References userAllreadyMemberByUsrId(), and userExists().

Referenced by withAdditionalRecord().

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.

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

                                      : ilObjIndividualAssessment
    {
        return $this->iass;
    }

References $iass.

◆ rewind()

ilIndividualAssessmentMembers::rewind ( )

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

                            : void
    {
        $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 278 of file class.ilIndividualAssessmentMembers.php.

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

Referenced by ilObjIndividualAssessment\updateMembers().

Here is the caller graph for this function:

◆ userAllreadyMember()

ilIndividualAssessmentMembers::userAllreadyMember ( ilObjUser $usr )

Check if a user is member of this.

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

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

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

Referenced by withAdditionalUser().

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

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

Referenced by recordOK(), and userAllreadyMember().

Here is the caller graph for this function:

◆ userExists()

ilIndividualAssessmentMembers::userExists ( int $usr_id )

protected

Reimplemented in TestObj.

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

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

References ilObject\_exists().

Referenced by recordOK().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valid()

ilIndividualAssessmentMembers::valid ( )

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

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

References count().

Here is the call graph for this function:

◆ withAccessHandling()

ilIndividualAssessmentMembers::withAccessHandling ( ilOrgUnitPositionAndRBACAccessHandler $access_handler )

Get a collection like this, but only including users that are visible according to the supplied access handler.

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

     : ilIndividualAssessmentMembers {
        return $this->withOnlyUsersByIds(
            $access_handler->filterUserIdsByRbacOrPositionOfCurrentUser(
                "read_learning_progress",
                "read_learning_progress",
                $this->referencedObject()->getRefId(),
                $this->membersIds()
            )
        );
    }

Referenced by ilObjIndividualAssessment\loadVisibleMembers().

Here is the caller graph for this function:

◆ withAdditionalRecord()

ilIndividualAssessmentMembers::withAdditionalRecord ( array $record )

Clone this and add a record.

Parameters

int | string | null[] $record

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

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

References FIELD_USR_ID, and recordOK().

Here is the call graph for this function:

◆ withAdditionalUser()

ilIndividualAssessmentMembers::withAdditionalUser ( ilObjUser $usr )

Clone this and add a record created for user.

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

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

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

Here is the call graph for this function:

◆ withOnlyUsersByIds()

ilIndividualAssessmentMembers::withOnlyUsersByIds ( array $keep_users_ids )

Remove all users that do not exist in list of given ids.

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

                                                             : ilIndividualAssessmentMembers
    {
        $clone = clone $this;
 
        $remove = array_diff($this->membersIds(), $keep_users_ids);
        foreach ($remove as $id) {
            unset($clone->member_records[$id]);
        }
 
        return $clone;
    }

References $id, and membersIds().

Here is the call graph for this function:

◆ withoutPresentUser()

ilIndividualAssessmentMembers::withoutPresentUser ( ilObjUser $usr )

Clone this and remove record corresponding to user.

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

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