For the purpose of streamlining the grading and learning-process status definition outside of tests, SCORM courses e.t.c. More...

Collaboration diagram for ilIndividualAssessmentMembersGUI:

Public Member Functions
	__construct (ilObjIndividualAssessment $object, ilCtrl $ctrl, ilGlobalPageTemplate $tpl, ilLanguage $lng, ilToolbarGUI $toolbar, ilObjUser $user, ilTabsGUI $tabs, IndividualAssessmentAccessHandler $iass_access, UI\Factory $factory, UI\Renderer $renderer, ilErrorHandling $error_object, ilIndividualAssessmentMemberGUI $member_gui)

	executeCommand ()

	addUsersFromSearch (array $user_ids)

	addUsers (array $user_ids)
	Add users to corresponding iass-object. More...

	removeUser ()
	Remove users from corresponding iass-object. More...

	handleAccessViolation ()

Data Fields
const	F_STATUS = "status"

const	F_SORT = "sortation"

const	S_NAME_ASC = "user_lastname:asc"

const	S_NAME_DESC = "user_lastname:desc"

const	S_EXAMINER_ASC = "examiner_login:asc"

const	S_EXAMINER_DESC = "examiner_login:desc"

const	S_CHANGETIME_ASC = "change_time:asc"

const	S_CHANGETIME_DESC = "change_time:desc"

Protected Member Functions
	addedUsers ()

	view ()

	removeUserConfirmation ()
	Display confirmation form for user might be removed. More...

	getViewControls (array $get)

	getModeControl (array $get, ViewControl\Factory $vc_factory)

	getSortationControl (ViewControl\Factory $vc_factory)

	getModeOptions ()

	getActiveLabelForModeByFilter ($filter)

	getLinkForStatusFilter ($value)

	getFilterValue (array $get)

	getSortOptions ()

	getSortValue (array $get)

	maybeViewLearningProgress ()

	txt (string $code)

Protected Attributes
	$ctrl

	$object

	$ref_id

	$tpl

	$lng

	$toolbar

	$user

	$tabs

	$iass_access

	$factory

	$renderer

	$error_object

	$member_gui

Detailed Description

For the purpose of streamlining the grading and learning-process status definition outside of tests, SCORM courses e.t.c.

the IndividualAssessment is used. It caries a LPStatus, which is set Individually.

@ilCtrl_Calls ilIndividualAssessmentMembersGUI: ilRepositorySearchGUI @ilCtrl_Calls ilIndividualAssessmentMembersGUI: ilIndividualAssessmentMemberGUI

Definition at line 21 of file class.ilIndividualAssessmentMembersGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilIndividualAssessmentMembersGUI::__construct	(	ilObjIndividualAssessment	$object,
		ilCtrl	$ctrl,
		ilGlobalPageTemplate	$tpl,
		ilLanguage	$lng,
		ilToolbarGUI	$toolbar,
		ilObjUser	$user,
		ilTabsGUI	$tabs,
		IndividualAssessmentAccessHandler	$iass_access,
		UI\Factory	$factory,
		UI\Renderer	$renderer,
		ilErrorHandling	$error_object,
		ilIndividualAssessmentMemberGUI	$member_gui
	)

Definition at line 98 of file class.ilIndividualAssessmentMembersGUI.php.

      {
        $this->object = $object;
        $this->ctrl = $ctrl;
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->toolbar = $toolbar;
        $this->user = $user;
        $this->tabs = $tabs;
        $this->iass_access = $iass_access;
        $this->factory = $factory;
        $this->renderer = $renderer;
        $this->error_object = $error_object;
        $this->member_gui = $member_gui;
 
        $this->ref_id = (int) $object->getRefId();
    }

References $ctrl, $error_object, $factory, $iass_access, $lng, $member_gui, $object, $renderer, $tabs, $toolbar, $tpl, $user, and user().

Here is the call graph for this function:

Member Function Documentation

◆ addedUsers()

ilIndividualAssessmentMembersGUI::addedUsers ( )

protected

Definition at line 171 of file class.ilIndividualAssessmentMembersGUI.php.

    {
        if (!$_GET['failure']) {
            ilUtil::sendSuccess($this->txt('iass_add_user_success'));
        } else {
            ilUtil::sendFailure($this->txt('iass_add_user_failure'));
        }
        $this->view();
    }

References $_GET, ilUtil\sendFailure(), txt(), and view().

Here is the call graph for this function:

◆ addUsers()

ilIndividualAssessmentMembersGUI::addUsers ( array $user_ids )

Add users to corresponding iass-object.

To be used by repository search.

Parameters

int | string[] $user_ids

Definition at line 256 of file class.ilIndividualAssessmentMembersGUI.php.

    {
        if (!$this->iass_access->mayEditMembers()) {
            $this->handleAccessViolation();
        }
        $iass = $this->object;
        $members = $iass->loadMembers();
        $failure = null;
        if (count($user_ids) === 0) {
            $failure = 1;
        }
        foreach ($user_ids as $user_id) {
            $user = new ilObjUser($user_id);
            if (!$members->userAllreadyMember($user)) {
                $members = $members->withAdditionalUser($user);
            } else {
                $failure = 1;
            }
        }
        $members->updateStorageAndRBAC($iass->membersStorage(), $iass->accessHandler());
        ilIndividualAssessmentLPInterface::updateLPStatusByIds($iass->getId(), $user_ids);
        $this->ctrl->setParameter($this, 'failure', $failure);
        $this->ctrl->redirect($this, 'addedUsers');
    }

References $failure, $object, $user, handleAccessViolation(), and ilIndividualAssessmentLPInterface\updateLPStatusByIds().

Referenced by addUsersFromSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addUsersFromSearch()

ilIndividualAssessmentMembersGUI::addUsersFromSearch ( array $user_ids )

Parameters

int[]

Definition at line 241 of file class.ilIndividualAssessmentMembersGUI.php.

    {
        if ($user_ids && is_array($user_ids) && !empty($user_ids)) {
            $this->addUsers($user_ids);
        }
 
        ilUtil::sendInfo($this->txt("search_no_selection"), true);
        $this->ctrl->redirect($this, 'view');
    }

References addUsers(), ilUtil\sendInfo(), and txt().

Here is the call graph for this function:

◆ executeCommand()

ilIndividualAssessmentMembersGUI::executeCommand ( )

Definition at line 128 of file class.ilIndividualAssessmentMembersGUI.php.

    {
        if (!$this->iass_access->mayEditMembers()
            && !$this->iass_access->mayGradeUser()
            && !$this->iass_access->mayViewUser()
            && !$this->iass_access->mayAmendGradeUser()
        ) {
            $this->handleAccessViolation();
        }
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass();
        $this->ctrl->saveParameterByClass("ilIndividualAssessmentMembersGUI", self::F_STATUS);
        $this->tpl->setPermanentLink("iass", $this->ref_id);
 
        switch ($next_class) {
            case "ilrepositorysearchgui":
                require_once 'Services/Search/classes/class.ilRepositorySearchGUI.php';
                $rep_search = new ilRepositorySearchGUI();
                $rep_search->setCallback($this, "addUsersFromSearch");
                $rep_search->addUserAccessFilterCallable(
                    function ($a_user_ids) {
                        return $a_user_ids;
                    }
                );
                $this->ctrl->forwardCommand($rep_search);
                break;
            case "ilindividualassessmentmembergui":
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt('back'),
                    $this->ctrl->getLinkTargetByClass(self::class, 'view')
                );
                $this->ctrl->forwardCommand($this->member_gui);
                break;
            default:
                if (!$cmd) {
                    $cmd = 'view';
                }
                $this->$cmd();
                break;
        }
    }

References handleAccessViolation().

Here is the call graph for this function:

◆ getActiveLabelForModeByFilter()

ilIndividualAssessmentMembersGUI::getActiveLabelForModeByFilter ( $filter )

protected

Parameters

int | string | null $filter

Definition at line 378 of file class.ilIndividualAssessmentMembersGUI.php.

                                                              : string
    {
        switch ($filter) {
            case ilIndividualAssessmentMembers::LP_ASSESSMENT_NOT_COMPLETED:
                return $this->txt("iass_filter_not_started");
                break;
            case ilIndividualAssessmentMembers::LP_IN_PROGRESS:
                return $this->txt("iass_filter_not_finalized");
                break;
            case ilIndividualAssessmentMembers::LP_COMPLETED:
                return $this->txt("iass_filter_finalized");
                break;
            case ilIndividualAssessmentMembers::LP_FAILED:
                return $this->txt("iass_filter_failed");
                break;
            default:
                return $this->txt("iass_filter_all");
        }
    }

References ilIndividualAssessmentMembers\LP_ASSESSMENT_NOT_COMPLETED, ilIndividualAssessmentMembers\LP_COMPLETED, ilIndividualAssessmentMembers\LP_FAILED, ilIndividualAssessmentMembers\LP_IN_PROGRESS, and txt().

Referenced by getModeControl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilterValue()

ilIndividualAssessmentMembersGUI::getFilterValue ( array $get )

protected

Parameters

string[] $get

Returns: int|string|null

Definition at line 414 of file class.ilIndividualAssessmentMembersGUI.php.

    {
        if (isset($get[self::F_STATUS])
            && $get[self::F_STATUS] != ""
            && in_array(
                $get[self::F_STATUS],
                [
                        ilIndividualAssessmentMembers::LP_ASSESSMENT_NOT_COMPLETED,
                        ilIndividualAssessmentMembers::LP_IN_PROGRESS,
                        ilIndividualAssessmentMembers::LP_COMPLETED,
                        ilIndividualAssessmentMembers::LP_FAILED
                    ]
                )
        ) {
            return $get[self::F_STATUS];
        }
 
        return null;
    }

References F_STATUS, ilIndividualAssessmentMembers\LP_ASSESSMENT_NOT_COMPLETED, ilIndividualAssessmentMembers\LP_COMPLETED, ilIndividualAssessmentMembers\LP_FAILED, and ilIndividualAssessmentMembers\LP_IN_PROGRESS.

Referenced by view().

Here is the caller graph for this function:

◆ getLinkForStatusFilter()

ilIndividualAssessmentMembersGUI::getLinkForStatusFilter ( $value )

protected

Parameters

int | string | null $value

Definition at line 401 of file class.ilIndividualAssessmentMembersGUI.php.

                                                      : string
    {
        $this->ctrl->setParameterByClass("ilIndividualAssessmentMembersGUI", self::F_STATUS, $value);
        $link = $this->ctrl->getLinkTargetByClass("ilIndividualAssessmentMembersGUI", "view");
        $this->ctrl->setParameterByClass("ilIndividualAssessmentMembersGUI", self::F_STATUS, null);
 
        return $link;
    }

Referenced by getModeOptions().

Here is the caller graph for this function:

◆ getModeControl()

ilIndividualAssessmentMembersGUI::getModeControl	(	array	$get,
		ViewControl\Factory	$vc_factory
	)

protected

Parameters

string[] $get

Definition at line 336 of file class.ilIndividualAssessmentMembersGUI.php.

                                                                                   : ViewControl\Mode
    {
        $active = $this->getActiveLabelForModeByFilter($get[self::F_STATUS]);
 
        return $vc_factory->mode(
            $this->getModeOptions(),
            ""
        )
        ->withActive($active);
    }

References getActiveLabelForModeByFilter(), and getModeOptions().

Referenced by getViewControls().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModeOptions()

ilIndividualAssessmentMembersGUI::getModeOptions ( )

protected

Returns: string[]

Definition at line 360 of file class.ilIndividualAssessmentMembersGUI.php.

                                        : array
    {
        $ret = [];
 
        $ret[$this->txt("iass_filter_all")] = $this->getLinkForStatusFilter(null);
 
        if ($this->maybeViewLearningProgress()) {
            $ret[$this->txt("iass_filter_not_started")] = $this->getLinkForStatusFilter(ilIndividualAssessmentMembers::LP_ASSESSMENT_NOT_COMPLETED);
            $ret[$this->txt("iass_filter_not_finalized")] = $this->getLinkForStatusFilter(ilIndividualAssessmentMembers::LP_IN_PROGRESS);
            $ret[$this->txt("iass_filter_finalized")] = $this->getLinkForStatusFilter(ilIndividualAssessmentMembers::LP_COMPLETED);
            $ret[$this->txt("iass_filter_failed")] = $this->getLinkForStatusFilter(ilIndividualAssessmentMembers::LP_FAILED);
        }
        return $ret;
    }

References $ret, getLinkForStatusFilter(), ilIndividualAssessmentMembers\LP_ASSESSMENT_NOT_COMPLETED, ilIndividualAssessmentMembers\LP_COMPLETED, ilIndividualAssessmentMembers\LP_FAILED, ilIndividualAssessmentMembers\LP_IN_PROGRESS, maybeViewLearningProgress(), and txt().

Referenced by getModeControl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSortationControl()

ilIndividualAssessmentMembersGUI::getSortationControl ( ViewControl\Factory $vc_factory )

protected

Definition at line 347 of file class.ilIndividualAssessmentMembersGUI.php.

                                                                            : ViewControl\Sortation
    {
        $target = $link = $this->ctrl->getLinkTargetByClass("ilIndividualAssessmentMembersGUI", "view");
        return $vc_factory->sortation(
            $this->getSortOptions()
        )
        ->withTargetURL($target, self::F_SORT)
        ->withLabel($this->txt("iass_sort"));
    }

References getSortOptions(), txt(), and ILIAS\UI\Component\ViewControl\Sortation\withTargetURL().

Referenced by getViewControls().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSortOptions()

ilIndividualAssessmentMembersGUI::getSortOptions ( )

protected

Definition at line 434 of file class.ilIndividualAssessmentMembersGUI.php.

                                        : array
    {
        return array(
            self::S_NAME_ASC => $this->txt("iass_sort_name_asc"),
            self::S_NAME_DESC => $this->txt("iass_sort_name_desc"),
            self::S_EXAMINER_ASC => $this->txt("iass_sort_examiner_login_asc"),
            self::S_EXAMINER_DESC => $this->txt("iass_sort_examiner_login_desc"),
            self::S_CHANGETIME_ASC => $this->txt("iass_sort_changetime_asc"),
            self::S_CHANGETIME_DESC => $this->txt("iass_sort_changetime_desc")
        );
    }

References txt().

Referenced by getSortationControl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSortValue()

ilIndividualAssessmentMembersGUI::getSortValue ( array $get )

protected

Parameters

string[]

Returns: string|null

Definition at line 450 of file class.ilIndividualAssessmentMembersGUI.php.

    {
        if (isset($get[self::F_SORT])
            && $get[self::F_SORT] != ""
            && in_array(
                $get[self::F_SORT],
                [
                        self::S_NAME_ASC,
                        self::S_NAME_DESC,
                        self::S_EXAMINER_ASC,
                        self::S_EXAMINER_DESC,
                        self::S_CHANGETIME_ASC,
                        self::S_CHANGETIME_DESC
                    ]
                )
        ) {
            return $get[self::F_SORT];
        }
 
        return null;
    }

References F_SORT.

Referenced by view().

Here is the caller graph for this function:

◆ getViewControls()

ilIndividualAssessmentMembersGUI::getViewControls ( array $get )

protected

Returns: ViewControl[]

Definition at line 320 of file class.ilIndividualAssessmentMembersGUI.php.

                                                   : array
    {
        $ret = array();
 
        $vc_factory = $this->factory->viewControl();
 
        $sort = $this->getSortationControl($vc_factory);
        $ret[] = $this->getModeControl($get, $vc_factory);
        $ret[] = $sort;
 
        return $ret;
    }

References $ret, getModeControl(), and getSortationControl().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleAccessViolation()

ilIndividualAssessmentMembersGUI::handleAccessViolation ( )

Definition at line 472 of file class.ilIndividualAssessmentMembersGUI.php.

    {
        $this->error_object->raiseError($this->txt("msg_no_perm_read"), $this->error_object->WARNING);
    }

References txt().

Referenced by addUsers(), executeCommand(), removeUser(), and removeUserConfirmation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maybeViewLearningProgress()

ilIndividualAssessmentMembersGUI::maybeViewLearningProgress ( )

protected

Definition at line 477 of file class.ilIndividualAssessmentMembersGUI.php.

    {
        return $this->iass_access->mayViewUser();
    }

Referenced by getModeOptions().

Here is the caller graph for this function:

◆ removeUser()

ilIndividualAssessmentMembersGUI::removeUser ( )

Remove users from corresponding iass-object.

To be used by repository search.

Definition at line 302 of file class.ilIndividualAssessmentMembersGUI.php.

    {
        if (!$this->iass_access->mayEditMembers()) {
            $this->handleAccessViolation();
        }
        $usr_id = $_POST['usr_id'];
        $iass = $this->object;
        $iass->loadMembers()
            ->withoutPresentUser(new ilObjUser($usr_id))
            ->updateStorageAndRBAC($iass->membersStorage(), $iass->accessHandler());
        ilIndividualAssessmentLPInterface::updateLPStatusByIds($iass->getId(), array($usr_id));
        ilUtil::sendSuccess($this->txt("iass_user_removed"), true);
        $this->ctrl->redirect($this, 'view');
    }

References $_POST, $object, handleAccessViolation(), txt(), and ilIndividualAssessmentLPInterface\updateLPStatusByIds().

Here is the call graph for this function:

◆ removeUserConfirmation()

ilIndividualAssessmentMembersGUI::removeUserConfirmation ( )

protected

Display confirmation form for user might be removed.

Definition at line 284 of file class.ilIndividualAssessmentMembersGUI.php.

    {
        if (!$this->iass_access->mayEditMembers()) {
            $this->handleAccessViolation();
        }
        include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
        $confirm = new ilConfirmationGUI();
        $confirm->addItem('usr_id', $_GET['usr_id'], ilObjUser::_lookupFullname($_GET['usr_id']));
        $confirm->setHeaderText($this->txt('iass_remove_user_qst'));
        $confirm->setFormAction($this->ctrl->getFormAction($this));
        $confirm->setConfirm($this->txt('remove'), 'removeUser');
        $confirm->setCancel($this->txt('cancel'), 'view');
        $this->tpl->setContent($confirm->getHTML());
    }

References $_GET, ilObjUser\_lookupFullname(), handleAccessViolation(), and txt().

Here is the call graph for this function:

◆ txt()

ilIndividualAssessmentMembersGUI::txt ( string $code )

protected

Definition at line 482 of file class.ilIndividualAssessmentMembersGUI.php.

                                         : string
    {
        return $this->lng->txt($code);
    }

Referenced by addedUsers(), addUsersFromSearch(), getActiveLabelForModeByFilter(), getModeOptions(), getSortationControl(), getSortOptions(), handleAccessViolation(), removeUser(), removeUserConfirmation(), and view().

Here is the caller graph for this function:

◆ view()

ilIndividualAssessmentMembersGUI::view ( )

protected

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

    {
        if ($this->iass_access->mayEditMembers()) {
            require_once './Services/Search/classes/class.ilRepositorySearchGUI.php';
 
            $search_params = ['crs', 'grp'];
            $container_id = $this->object->getParentContainerIdByType($this->ref_id, $search_params);
            if ($container_id !== 0) {
                ilRepositorySearchGUI::fillAutoCompleteToolbar(
                    $this,
                    $this->toolbar,
                    array(
                    'auto_complete_name' => $this->txt('user'),
                    'submit_name' => $this->txt('add'),
                    'add_search' => true,
                    'add_from_container' => $container_id
                )
                );
            } else {
                ilRepositorySearchGUI::fillAutoCompleteToolbar(
                    $this,
                    $this->toolbar,
                    array(
                    'auto_complete_name' => $this->txt('user'),
                    'submit_name' => $this->txt('add'),
                    'add_search' => true
                )
                );
            }
        }
        $table = new ilIndividualAssessmentMembersTableGUI(
            $this,
            $this->lng,
            $this->ctrl,
            $this->iass_access,
            $this->factory,
            $this->renderer,
            (int) $this->user->getId()
        );
 
        $get = $_GET;
 
        $filter = $this->getFilterValue($get);
        $sort = $this->getSortValue($get);
 
        $entries = $this->object->loadMembersAsSingleObjects($filter, $sort);
        $table->setData($entries);
        $view_constrols = $this->getViewControls($get);
 
        $output = $table->render($view_constrols);
 
        if (count($entries) == 0) {
            $output .= $this->txt("iass_no_entries");
        }
        $this->tpl->setContent($output);
    }