Collaboration diagram for ilObjStudyProgrammeMembersGUI:

Public Member Functions
	__construct (ilGlobalTemplateInterface $tpl, ilCtrl $ilCtrl, ilToolbarGUI $ilToolbar, ilLanguage $lng, ilObjUser $user, ilTabsGUI $tabs, ilPRGAssignmentDBRepository $assignment_db, ilStudyProgrammeRepositorySearchGUI $repository_search_gui, ilObjStudyProgrammeIndividualPlanGUI $individual_plan_gui, ilPRGMessagePrinter $messages, Factory $data_factory, ilConfirmationGUI $confirmation_gui, ILIAS\HTTP\Wrapper\WrapperFactory $http_wrapper, ILIAS\Refinery\Factory $refinery, ILIAS\UI\Factory $ui_factory, ILIAS\UI\Renderer $ui_renderer, GuzzleHttp\Psr7\ServerRequest $request)

	setParentGUI (ilObjectGUI $a_parent_gui)

	setRefId (int $ref_id)

	executeCommand ()

	applyFilter ()

	resetFilter ()

	addUsers (array $user_ids)
	Assigns a users to SP. More...

	viewCompletedCourses (array $assignments)
	Shows list of completed courses for each assignment. More...

	unmarkAccreditedMulti ()

	markRelevant ()

	markRelevantMulti ()

	markNotRelevant ()

	markNotRelevantMulti ()

	updateFromCurrentPlan ()

	updateFromCurrentPlanMulti ()

	confirmedUpdateFromCurrentPlan ()

	acknowledgeCourses ()

	acknowledgeCoursesMulti ()

	confirmedAcknowledgeAllCourses ()

	confirmedAcknowledgeCourses ()

	changeDeadline ()

	changeDeadlineMulti ()

	changeExpireDate ()

	changeExpireDateMulti ()

	removeUser ()

	getStudyProgramme (int $ref_id=null)
	Get studyprogramm object for ref_id Use this ref_id if argument is null. More...

	getLinkTargetForAction (string $action, string $prgrs_id, int $ass_id)
	Get the link target for an action on user progress. More...

Data Fields
const	ACTION_MARK_ACCREDITED = "mark_accredited"

const	ACTION_UNMARK_ACCREDITED = "unmark_accredited"

const	ACTION_SHOW_INDIVIDUAL_PLAN = "show_individual_plan"

const	ACTION_REMOVE_USER = "remove_user"

const	ACTION_CHANGE_DEADLINE = "change_deadline"

const	ACTION_MARK_RELEVANT = "mark_relevant"

const	ACTION_UNMARK_RELEVANT = "unmark_relevant"

const	ACTION_UPDATE_FROM_CURRENT_PLAN = "update_from_current_plan"

const	ACTION_CHANGE_EXPIRE_DATE = "change_expire_date"

const	ACTION_ACKNOWLEDGE_COURSES = "acknowledge_completed_courses"

const	F_COMMAND_OPTION_ALL = 'select_cmd_all'

const	F_ALL_PROGRESS_IDS = 'all_progress_ids'

const	F_SELECTED_PROGRESS_IDS = 'prgs_ids'

const	F_SELECTED_PROGRESS_ID = 'prgs_id'

const	F_SELECTED_USER_IDS = 'usrids'

Protected Member Functions
	getDefaultCommand ()

	getAssignmentsById ()

	getMembersTableGUI ()

	getPostPrgsIds ()

	getGetPrgsIds ()

	getPrgrsId ()

	view ()
	Shows table with all members of the SP. More...

	getAddableUsers (array $users)

	markAccredited ()

	markAccreditedMulti ()

	markAccreditedByProgressId (PRGProgressId $prgrs_id, ilPRGMessageCollection $msgs)

	unmarkAccredited ()

	unmarkAccreditedByProgressId (PRGProgressId $prgrs_id, ilPRGMessageCollection $msgs)

	getAssignmentsFromQuery ()

	removeUserMulti ()

	confirmRemoveUsers (array $progress_ids)

	confirmedRemoveUsers ()

	removeAssignment (PRGProgressId $pgs_id)
	Remove user. More...

	showSuccessMessage (string $lng_var)
	Shows ilUtil success message. More...

	showInfoMessage (string $lng_var)
	Shows ilUtil failed message. More...

	initSearchGUI ()

	initMailToMemberButton (ilToolbarGUI $toolbar, bool $separator=false)

	mayCurrentUserEditProgressForUser (int $usr_id)

	getMessageCollection (string $topic)

	showMessages (ilPRGMessageCollection $msg)

	mailToSelectedUsers ()

Protected Attributes
ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilToolbarGUI	$toolbar

ilLanguage	$lng

ilObjUser	$user

ilTabsGUI	$tabs

ilPRGAssignmentDBRepository	$assignment_db

ilStudyProgrammeRepositorySearchGUI	$repository_search_gui

ilObjStudyProgrammeIndividualPlanGUI	$individual_plan_gui

ilPRGMessagePrinter	$messages

Factory	$data_factory

ilConfirmationGUI	$confirmation_gui

ILIAS HTTP Wrapper WrapperFactory	$http_wrapper

ILIAS Refinery Factory	$refinery

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

GuzzleHttp Psr7 ServerRequest	$request

ilObjStudyProgramme	$object

ilPRGPermissionsHelper	$permissions

ilObjectGUI	$parent_gui

int	$ref_id

Private Attributes
const	DEFAULT_CMD = "view"

Detailed Description

Definition at line 33 of file class.ilObjStudyProgrammeMembersGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeMembersGUI::__construct	(	ilGlobalTemplateInterface	$tpl,
		ilCtrl	$ilCtrl,
		ilToolbarGUI	$ilToolbar,
		ilLanguage	$lng,
		ilObjUser	$user,
		ilTabsGUI	$tabs,
		ilPRGAssignmentDBRepository	$assignment_db,
		ilStudyProgrammeRepositorySearchGUI	$repository_search_gui,
		ilObjStudyProgrammeIndividualPlanGUI	$individual_plan_gui,
		ilPRGMessagePrinter	$messages,
		Factory	$data_factory,
		ilConfirmationGUI	$confirmation_gui,
		ILIAS\HTTP\Wrapper\WrapperFactory	$http_wrapper,
		ILIAS\Refinery\Factory	$refinery,
		ILIAS\UI\Factory	$ui_factory,
		ILIAS\UI\Renderer	$ui_renderer,
		GuzzleHttp\Psr7\ServerRequest	$request
	)

Definition at line 78 of file class.ilObjStudyProgrammeMembersGUI.php.

      {
        $this->tpl = $tpl;
        $this->ctrl = $ilCtrl;
        $this->toolbar = $ilToolbar;
        $this->lng = $lng;
        $this->user = $user;
        $this->tabs = $tabs;
        $this->assignment_db = $assignment_db;
        $this->repository_search_gui = $repository_search_gui;
        $this->individual_plan_gui = $individual_plan_gui;
        $this->messages = $messages;
        $this->data_factory = $data_factory;
        $this->confirmation_gui = $confirmation_gui;
        $this->http_wrapper = $http_wrapper;
        $this->refinery = $refinery;
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $this->request = $request;
        $this->object = null;
        $this->permissions = null;
 
        $lng->loadLanguageModule("prg");
        $this->toolbar->setPreventDoubleSubmission(true);
    }

References $assignment_db, $confirmation_gui, $data_factory, $http_wrapper, $individual_plan_gui, $lng, $messages, $refinery, $repository_search_gui, $request, $tabs, $tpl, $ui_factory, $ui_renderer, $user, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ acknowledgeCourses()

ilObjStudyProgrammeMembersGUI::acknowledgeCourses ( )

Definition at line 672 of file class.ilObjStudyProgrammeMembersGUI.php.

                                        : string
    {
        $progress_id = $this->getPrgrsId();
        $assignments = [
            $this->assignment_db->get($progress_id->getAssignmentId())
        ];
        return $this->ui_renderer->render(
            $this->viewCompletedCourses($assignments)
        );
    }

References getPrgrsId(), and viewCompletedCourses().

Here is the call graph for this function:

◆ acknowledgeCoursesMulti()

ilObjStudyProgrammeMembersGUI::acknowledgeCoursesMulti ( )

Definition at line 683 of file class.ilObjStudyProgrammeMembersGUI.php.

                                             : string
    {
        $assignments = [];
        foreach ($this->getPostPrgsIds() as $progress_id) {
            $assignments[] = $this->assignment_db->get($progress_id->getAssignmentId());
        }
        return $this->ui_renderer->render(
            $this->viewCompletedCourses($assignments)
        );
    }

References getPostPrgsIds(), and viewCompletedCourses().

Here is the call graph for this function:

◆ addUsers()

ilObjStudyProgrammeMembersGUI::addUsers ( array $user_ids )

Assigns a users to SP.

Parameters

string[] $user_ids

Returns: bool|void

Definition at line 369 of file class.ilObjStudyProgrammeMembersGUI.php.

    {
        $user_ids = $this->getAddableUsers($user_ids);
        $prg = $this->getStudyProgramme();
        $assignments = [];
        $with_courses = [];
 
        foreach ($user_ids as $user_id) {
            $ass = $prg->assignUser((int) $user_id);
            $assignments[] = $ass;
            if($prg->getCompletedCourses((int) $user_id)) {
                $with_courses[] = $ass;
            }
        }
 
        if (count($assignments) === 1) {
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("prg_added_member"), true);
        }
        if (count($assignments) > 1) {
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("prg_added_members"), true);
        }
 
        if($with_courses) {
            $this->tpl->setContent(
                $this->ui_renderer->render(
                    $this->viewCompletedCourses($assignments)
                )
            );
            return true;
 
        } else {
            $this->ctrl->redirect($this, "view");
        }
    }

References ILIAS\Repository\ctrl(), getAddableUsers(), getStudyProgramme(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ applyFilter()

ilObjStudyProgrammeMembersGUI::applyFilter ( )

Definition at line 348 of file class.ilObjStudyProgrammeMembersGUI.php.

                                 : void
    {
        $table = $this->getMembersTableGUI();
        $table->resetOffset();
        $table->writeFilterToSession();
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\Repository\ctrl(), and getMembersTableGUI().

Here is the call graph for this function:

◆ changeDeadline()

ilObjStudyProgrammeMembersGUI::changeDeadline ( )

Definition at line 769 of file class.ilObjStudyProgrammeMembersGUI.php.

                                    : void
    {
        $this->ctrl->setParameterByClass(
            'ilStudyProgrammeChangeDeadlineGUI',
            'prgrs_ids',
            $this->getPrgrsId()
        );
 
        $link = $this->ctrl->getLinkTargetByClass(
            'ilStudyProgrammeChangeDeadlineGUI',
            'showDeadlineConfig'
        );
 
        $this->ctrl->clearParameterByClass('ilStudyProgrammeChangeDeadlineGUI', 'prgrs_ids');
        $this->ctrl->redirectToURL($link);
    }

References ILIAS\Repository\ctrl(), and getPrgrsId().

Here is the call graph for this function:

◆ changeDeadlineMulti()

ilObjStudyProgrammeMembersGUI::changeDeadlineMulti ( )

Definition at line 786 of file class.ilObjStudyProgrammeMembersGUI.php.

                                         : void
    {
        $this->ctrl->setParameterByClass(
            'ilStudyProgrammeChangeDeadlineGUI',
            'prgrs_ids',
            implode(',', $this->getPostPrgsIds())
        );
 
        $link = $this->ctrl->getLinkTargetByClass(
            'ilStudyProgrammeChangeDeadlineGUI',
            'showDeadlineConfig'
        );
 
        $this->ctrl->clearParameterByClass('ilStudyProgrammeChangeDeadlineGUI', 'prgrs_ids');
        $this->ctrl->redirectToURL($link);
    }

References ILIAS\Repository\ctrl(), and getPostPrgsIds().

Here is the call graph for this function:

◆ changeExpireDate()

ilObjStudyProgrammeMembersGUI::changeExpireDate ( )

Definition at line 803 of file class.ilObjStudyProgrammeMembersGUI.php.

                                      : void
    {
        $this->ctrl->setParameterByClass(
            'ilStudyProgrammeChangeExpireDateGUI',
            'prgrs_ids',
            $this->getPrgrsId()
        );
 
        $link = $this->ctrl->getLinkTargetByClass(
            'ilStudyProgrammeChangeExpireDateGUI',
            'showExpireDateConfig'
        );
 
        $this->ctrl->clearParameterByClass('ilStudyProgrammeChangeExpireDateGUI', 'prgrs_ids');
        $this->ctrl->redirectToURL($link);
    }

References ILIAS\Repository\ctrl(), and getPrgrsId().

Here is the call graph for this function:

◆ changeExpireDateMulti()

ilObjStudyProgrammeMembersGUI::changeExpireDateMulti ( )

Definition at line 820 of file class.ilObjStudyProgrammeMembersGUI.php.

                                           : void
    {
        $this->ctrl->setParameterByClass(
            'ilStudyProgrammeChangeExpireDateGUI',
            'prgrs_ids',
            implode(',', $this->getPostPrgsIds())
        );
 
        $link = $this->ctrl->getLinkTargetByClass(
            'ilStudyProgrammeChangeExpireDateGUI',
            'showExpireDateConfig'
        );
 
        $this->ctrl->clearParameterByClass('ilStudyProgrammeChangeExpireDateGUI', 'prgrs_ids');
        $this->ctrl->redirectToURL($link);
    }

References ILIAS\Repository\ctrl(), and getPostPrgsIds().

Here is the call graph for this function:

◆ confirmedAcknowledgeAllCourses()

ilObjStudyProgrammeMembersGUI::confirmedAcknowledgeAllCourses ( )

Definition at line 716 of file class.ilObjStudyProgrammeMembersGUI.php.

    {
        $prg = $this->getStudyProgramme();
        $assignments = $this->getAssignmentsFromQuery();
        $msgs = $this->getMessageCollection('msg_acknowledge_courses');
 
        foreach ($assignments as $ass) {
            $ass_ids[] = $ass->getId();
            $completed_crss = $prg->getCompletedCourses($ass->getUserId());
            $nodes = [];
            foreach($completed_crss as $opt) {
                $nodes[] = [$opt['prg_obj_id'], $opt['crsr_id']];
            }
            $prg->acknowledgeCourses(
                $ass->getId(),
                $nodes,
                $msgs
            );
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\Repository\ctrl(), getAssignmentsFromQuery(), getMessageCollection(), getStudyProgramme(), and showMessages().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedAcknowledgeCourses()

ilObjStudyProgrammeMembersGUI::confirmedAcknowledgeCourses ( )

Definition at line 739 of file class.ilObjStudyProgrammeMembersGUI.php.

    {
        $assignments = $this->getAssignmentsFromQuery();
 
        $form = $this->viewCompletedCourses($assignments)->withRequest($this->request);
        $data = $form->getData();
 
        $msgs = $this->getMessageCollection('msg_acknowledge_courses');
 
        if($data) {
            $acknowledge = [];
            foreach ($data as $ack) {
                [$assignment_id, $node_obj_id, $course_obj_id] = $ack;
                if(! array_key_exists($assignment_id, $acknowledge)) {
                    $acknowledge[$assignment_id] = [];
                }
                $acknowledge[$assignment_id][] = [(int) $node_obj_id, (int) $course_obj_id];
            }
            foreach ($acknowledge as $ass_id => $nodes) {
                $this->object->acknowledgeCourses(
                    (int) $ass_id,
                    $nodes,
                    $msgs
                );
            }
            $this->showMessages($msgs);
        }
        $this->ctrl->redirect($this, "view");
    }

References $data, ILIAS\Repository\ctrl(), getAssignmentsFromQuery(), getMessageCollection(), ILIAS\Repository\int(), showMessages(), and viewCompletedCourses().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedRemoveUsers()

ilObjStudyProgrammeMembersGUI::confirmedRemoveUsers ( )

protected

Definition at line 867 of file class.ilObjStudyProgrammeMembersGUI.php.

                                             : void
    {
        $pgs_ids = $this->getPostPrgsIds();
        $not_removed = array();
        foreach ($pgs_ids as $idx => $pgs_id) {
            try {
                $this->removeAssignment($pgs_id);
            } catch (ilException $e) {
                $not_removed[] = $pgs_id;
            }
        }
        if (count($not_removed) === count($pgs_ids)) {
            $this->showInfoMessage("remove_users_not_possible");
        } elseif (count($not_removed) > 0) {
            $this->showSuccessMessage("remove_users_partial_success");
        } else {
            $this->showSuccessMessage("remove_users_success");
        }
        $this->ctrl->redirect($this, "view");
    }

References Vendor\Package\$e, ILIAS\Repository\ctrl(), getPostPrgsIds(), removeAssignment(), showInfoMessage(), and showSuccessMessage().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedUpdateFromCurrentPlan()

ilObjStudyProgrammeMembersGUI::confirmedUpdateFromCurrentPlan ( )

Definition at line 650 of file class.ilObjStudyProgrammeMembersGUI.php.

    {
        $pgs_ids = $this->getPostPrgsIds();
        $msgs = $this->getMessageCollection('msg_update_from_settings');
        foreach ($pgs_ids as $idx => $pgs_id) {
            if (!$this->mayCurrentUserEditProgressForUser($pgs_id->getUsrId())) {
                $msgs->add(false, 'no_permission_to_update_plan_of_user', (string) $pgs_id);
                continue;
            } else {
                $msgs->add(true, '', (string) $pgs_id);
            }
 
            $this->object->updatePlanFromRepository(
                $pgs_id->getAssignmentId(),
                $this->user->getId(),
                $msgs
            );
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\Repository\ctrl(), getMessageCollection(), getPostPrgsIds(), mayCurrentUserEditProgressForUser(), and showMessages().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmRemoveUsers()

ilObjStudyProgrammeMembersGUI::confirmRemoveUsers ( array $progress_ids )

protected

Definition at line 849 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                              : string
    {
        $this->confirmation_gui->setFormAction($this->ctrl->getFormAction($this));
        $this->confirmation_gui->setHeaderText($this->lng->txt('confirm_to_remove_selected_assignments'));
        $this->confirmation_gui->setConfirm($this->lng->txt('prg_remove_user'), 'confirmedRemoveUsers');
        $this->confirmation_gui->setCancel($this->lng->txt('cancel'), 'view');
 
        foreach ($progress_ids as $progress_id) {
            $user_name = ilObjUser::_lookupFullname($progress_id->getUsrId());
            $this->confirmation_gui->addItem(
                self::F_SELECTED_PROGRESS_IDS . '[]',
                (string) $progress_id,
                $user_name
            );
        }
        return $this->confirmation_gui->getHTML();
    }

References ilObjUser\_lookupFullname(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by removeUser(), and removeUserMulti().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjStudyProgrammeMembersGUI::executeCommand ( )

Definition at line 133 of file class.ilObjStudyProgrammeMembersGUI.php.

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);
 
        if ($cmd === "" || $cmd === null) {
            $cmd = $this->getDefaultCommand();
        }
 
        switch ($next_class) {
            case "ilstudyprogrammerepositorysearchgui":
                $this->repository_search_gui->setCallback($this, "addUsers");
                $this->ctrl->setReturn($this, "view");
                $this->ctrl->forwardCommand($this->repository_search_gui);
                break;
            case "ilobjstudyprogrammeindividualplangui":
                $this->individual_plan_gui->setParentGUI($this);
                $this->individual_plan_gui->setRefId($this->ref_id);
                $this->ctrl->forwardCommand($this->individual_plan_gui);
                break;
            case "ilstudyprogrammemailmembersearchgui":
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt('btn_back'),
                    $this->ctrl->getLinkTarget($this, $this->getDefaultCommand())
                );
                $dic = ilStudyProgrammeDIC::specificDicFor($this->object);
                $mail_search = $dic['ilStudyProgrammeMailMemberSearchGUI'];
                $mail_search->setAssignments($this->getAssignmentsById());
                $mail_search->setBackTarget(
                    $this->ctrl->getLinkTarget($this, $this->getDefaultCommand())
                );
                $this->ctrl->forwardCommand($mail_search);
                break;
            case "ilstudyprogrammechangeexpiredategui":
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt('btn_back'),
                    $this->ctrl->getLinkTarget($this, $this->getDefaultCommand())
                );
                $dic = ilStudyProgrammeDIC::dic();
                $gui = $dic['ilStudyProgrammeChangeExpireDateGUI'];
                $gui->setRefId($this->ref_id);
                $gui->setProgressIds($this->getGetPrgsIds());
                $this->ctrl->forwardCommand($gui);
                break;
            case "ilstudyprogrammechangedeadlinegui":
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt('btn_back'),
                    $this->ctrl->getLinkTarget($this, $this->getDefaultCommand())
                );
                $dic = ilStudyProgrammeDIC::dic();
                $gui = $dic['ilStudyProgrammeChangeDeadlineGUI'];
                $gui->setRefId($this->ref_id);
                $gui->setProgressIds($this->getGetPrgsIds());
                $this->ctrl->forwardCommand($gui);
                break;
            case false:
                switch ($cmd) {
                    case "view":
                    case "markAccredited":
                    case "markAccreditedMulti":
                    case "unmarkAccredited":
                    case "unmarkAccreditedMulti":
                    case "removeUser":
                    case "removeUserMulti":
                    case "markNotRelevantMulti":
                    case "markRelevant":
                    case "markRelevantMulti":
                    case "updateFromCurrentPlan":
                    case "updateFromCurrentPlanMulti":
                    case "acknowledgeCourses":
                    case "acknowledgeCoursesMulti":
                    case "applyFilter":
                    case "resetFilter":
                    case "changeDeadline":
                    case "changeDeadlineMulti":
                    case "changeExpireDate":
                    case "changeExpireDateMulti":
                        $cont = $this->$cmd();
                        $this->tpl->setContent($cont);
                        break;
                    case "confirmedRemoveUsers":
                        $this->confirmedRemoveUsers();
                        break;
                    case "confirmedUpdateFromCurrentPlan":
                        $this->confirmedUpdateFromCurrentPlan();
                        break;
                    case "confirmedAcknowledgeCourses":
                        $this->confirmedAcknowledgeCourses();
                        break;
                    case "confirmedAcknowledgeAllCourses":
                        $this->confirmedAcknowledgeAllCourses();
                        break;
 
                    case "mailUserMulti":
                        $this->mailToSelectedUsers();
                        break;
                    case "markNotRelevant":
                        $this->markRelevant();
                        break;
 
                    default:
                        throw new ilException("ilObjStudyProgrammeMembersGUI: Command not supported: $cmd");
                }
                break;
            default:
                throw new ilException(
                    "ilObjStudyProgrammeMembersGUI: Can't forward to next class $next_class"
                );
        }
    }

References $dic, confirmedAcknowledgeAllCourses(), confirmedAcknowledgeCourses(), confirmedRemoveUsers(), confirmedUpdateFromCurrentPlan(), ILIAS\Repository\ctrl(), ilStudyProgrammeDIC\dic(), getAssignmentsById(), getDefaultCommand(), getGetPrgsIds(), ILIAS\Repository\lng(), mailToSelectedUsers(), markRelevant(), ilStudyProgrammeDIC\specificDicFor(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ getAddableUsers()

ilObjStudyProgrammeMembersGUI::getAddableUsers ( array $users )

protected

Parameters

int[] $users

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

                                                    : array
    {
        $to_add = $this->permissions->filterUserIds(
            $users,
            ilOrgUnitOperation::OP_MANAGE_MEMBERS
        );
 
        $cnt_not_added = count($users) - count($to_add);
        if ($cnt_not_added > 0) {
            $this->tpl->setOnScreenMessage(
                "info",
                sprintf(
                    $this->lng->txt('could_not_add_users_no_permissons'),
                    $cnt_not_added
                ),
                true
            );
        }
        return $to_add;
    }

References ILIAS\Repository\lng(), and ilOrgUnitOperation\OP_MANAGE_MEMBERS.

Referenced by addUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsById()

ilObjStudyProgrammeMembersGUI::getAssignmentsById ( )

protected

Definition at line 252 of file class.ilObjStudyProgrammeMembersGUI.php.

                                           : array
    {
        return $this->assignment_db->getAllForNodeIsContained($this->object->getId());
    }

References ILIAS\Repository\object().

Referenced by executeCommand(), and mailToSelectedUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsFromQuery()

ilObjStudyProgrammeMembersGUI::getAssignmentsFromQuery ( )

protected

Returns: ilPRGAssignment[]

Definition at line 697 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                : array
    {
        $ass_ids = $this->http_wrapper->query()->retrieve(
            'ass_ids',
            $this->refinery->custom()->transformation(fn ($ids) => explode(',', $ids))
        );
        $prg = $this->getStudyProgramme();
        $assignments = array_map(
            fn ($ass_id) => $this->assignment_db->get((int) $ass_id),
            $ass_ids
        );
 
        $assignments = array_filter(
            $assignments,
            fn ($ass) => $ass->getRootId() === $prg->getId()
        );
        return $assignments;
    }

References getStudyProgramme(), and ILIAS\Repository\refinery().

Referenced by confirmedAcknowledgeAllCourses(), and confirmedAcknowledgeCourses().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultCommand()

ilObjStudyProgrammeMembersGUI::getDefaultCommand ( )

protected

Definition at line 247 of file class.ilObjStudyProgrammeMembersGUI.php.

                                          : string
    {
        return self::DEFAULT_CMD;
    }

References DEFAULT_CMD.

Referenced by executeCommand().

Here is the caller graph for this function:

◆ getGetPrgsIds()

ilObjStudyProgrammeMembersGUI::getGetPrgsIds ( )

protected

Definition at line 311 of file class.ilObjStudyProgrammeMembersGUI.php.

                                      : array
    {
        $prgrs_ids = $_GET['prgrs_ids'];
        $ids = [];
        if (!is_null($prgrs_ids)) {
            foreach (explode(',', $prgrs_ids) as $id) {
                $ids[] = PRGProgressId::createFromString($id);
            };
        }
        return $ids;
    }

References $_GET, $id, and PRGProgressId\createFromString().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLinkTargetForAction()

ilObjStudyProgrammeMembersGUI::getLinkTargetForAction	(	string	$action,
		string	$prgrs_id,
		int	$ass_id
	)

Get the link target for an action on user progress.

Definition at line 970 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                                                         : string
    {
        switch ($action) {
            case self::ACTION_MARK_ACCREDITED:
                $target_name = "markAccredited";
                break;
            case self::ACTION_UNMARK_ACCREDITED:
                $target_name = "unmarkAccredited";
                break;
            case self::ACTION_SHOW_INDIVIDUAL_PLAN:
                return $this->individual_plan_gui->getLinkTargetView($ass_id);
            case self::ACTION_REMOVE_USER:
                $target_name = "removeUser";
                break;
            case self::ACTION_UNMARK_RELEVANT:
                $target_name = "markNotRelevant";
                break;
            case self::ACTION_MARK_RELEVANT:
                $target_name = "markRelevant";
                break;
            case self::ACTION_UPDATE_FROM_CURRENT_PLAN:
                $target_name = "updateFromCurrentPlan";
                break;
            case self::ACTION_ACKNOWLEDGE_COURSES:
                $target_name = "acknowledgeCourses";
                break;
            case self::ACTION_CHANGE_DEADLINE:
                $target_name = "changeDeadline";
                break;
            case self::ACTION_CHANGE_EXPIRE_DATE:
                $target_name = "changeExpireDate";
                break;
            default:
                throw new ilException("Unknown action: $action");
        }
 
        $this->ctrl->setParameter($this, "prgrs_id", $prgrs_id);
        $link = $this->ctrl->getLinkTarget($this, $target_name);
        $this->ctrl->setParameter($this, "prgrs_id", null);
        return $link;
    }

References ACTION_ACKNOWLEDGE_COURSES, ACTION_CHANGE_DEADLINE, ACTION_CHANGE_EXPIRE_DATE, ACTION_MARK_ACCREDITED, ACTION_MARK_RELEVANT, ACTION_REMOVE_USER, ACTION_SHOW_INDIVIDUAL_PLAN, ACTION_UNMARK_ACCREDITED, ACTION_UNMARK_RELEVANT, ACTION_UPDATE_FROM_CURRENT_PLAN, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getMembersTableGUI()

ilObjStudyProgrammeMembersGUI::getMembersTableGUI ( )

protected

Definition at line 257 of file class.ilObjStudyProgrammeMembersGUI.php.

                                           : ilStudyProgrammeMembersTableGUI
    {
        $prg_id = ilObject::_lookupObjId($this->ref_id);
        $dic = ilStudyProgrammeDIC::specificDicFor($this->object);
        $table = new ilStudyProgrammeMembersTableGUI(
            $prg_id,
            $this->ref_id,
            $this,
            $this->permissions,
            $this->data_factory,
            $dic['ui.factory'],
            $dic['ui.renderer'],
            $dic['ilStudyProgrammeUserTable'],
            $dic['filter.assignment'],
            $this->user,
            "view",
            ""
        );
        return $table;
    }

References $dic, ilObject\_lookupObjId(), ilStudyProgrammeDIC\specificDicFor(), and ILIAS\Repository\user().

Referenced by applyFilter(), resetFilter(), and view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMessageCollection()

ilObjStudyProgrammeMembersGUI::getMessageCollection ( string $topic )

protected

Definition at line 1020 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                          : ilPRGMessageCollection
    {
        return $this->messages->getMessageCollection($topic);
    }

Referenced by confirmedAcknowledgeAllCourses(), confirmedAcknowledgeCourses(), confirmedUpdateFromCurrentPlan(), markAccredited(), markAccreditedMulti(), markNotRelevant(), markNotRelevantMulti(), markRelevant(), markRelevantMulti(), unmarkAccredited(), and unmarkAccreditedMulti().

Here is the caller graph for this function:

◆ getPostPrgsIds()

ilObjStudyProgrammeMembersGUI::getPostPrgsIds ( )

protected

Returns: PRGProgressId[]

Definition at line 281 of file class.ilObjStudyProgrammeMembersGUI.php.

                                       : array
    {
        if ($this->http_wrapper->post()->has(self::F_COMMAND_OPTION_ALL)) {
            $pgs_ids = $this->http_wrapper->post()->retrieve(
                self::F_ALL_PROGRESS_IDS,
                $this->refinery->custom()->transformation(
                    fn ($ids) => explode(',', $ids)
                )
            );
        } else {
            $pgs_ids = $this->http_wrapper->post()->retrieve(
                self::F_SELECTED_PROGRESS_IDS,
                $this->refinery->custom()->transformation(fn ($ids) => $ids)
            );
        }
        if ($pgs_ids === null) {
            $this->showInfoMessage("no_user_selected");
            $this->ctrl->redirect($this, "view");
        }
        if (is_string($pgs_ids)) {
            $pgs_ids = [$pgs_ids];
        }
 
        $r = [];
        foreach ($pgs_ids as $pgs_id) {
            $r[] = PRGProgressId::createFromString($pgs_id);
        }
        return $r;
    }

References PRGProgressId\createFromString(), ILIAS\Repository\ctrl(), ILIAS\Repository\refinery(), and showInfoMessage().

Referenced by acknowledgeCoursesMulti(), changeDeadlineMulti(), changeExpireDateMulti(), confirmedRemoveUsers(), confirmedUpdateFromCurrentPlan(), mailToSelectedUsers(), markAccreditedMulti(), markNotRelevantMulti(), markRelevantMulti(), removeUserMulti(), unmarkAccreditedMulti(), and updateFromCurrentPlanMulti().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPrgrsId()

ilObjStudyProgrammeMembersGUI::getPrgrsId ( )

protected

Definition at line 323 of file class.ilObjStudyProgrammeMembersGUI.php.

                                   : PRGProgressId
    {
        if (!$_GET["prgrs_id"]) {
            throw new ilException("Expected 'prgrs_id'");
        }
        return PRGProgressId::createFromString($_GET["prgrs_id"]);
    }

References $_GET, and PRGProgressId\createFromString().

Referenced by acknowledgeCourses(), changeDeadline(), changeExpireDate(), markAccredited(), markNotRelevant(), markRelevant(), removeUser(), unmarkAccredited(), and updateFromCurrentPlan().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStudyProgramme()

ilObjStudyProgrammeMembersGUI::getStudyProgramme ( int $ref_id = null )

Get studyprogramm object for ref_id Use this ref_id if argument is null.

Definition at line 959 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                         : ilObjStudyProgramme
    {
        if ($ref_id === null) {
            $ref_id = $this->ref_id;
        }
        return ilObjStudyProgramme::getInstanceByRefId($ref_id);
    }

References $ref_id, and ilObjStudyProgramme\getInstanceByRefId().

Referenced by addUsers(), confirmedAcknowledgeAllCourses(), getAssignmentsFromQuery(), markAccreditedByProgressId(), markNotRelevant(), markNotRelevantMulti(), markRelevant(), markRelevantMulti(), unmarkAccreditedByProgressId(), view(), and viewCompletedCourses().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMailToMemberButton()

ilObjStudyProgrammeMembersGUI::initMailToMemberButton	(	ilToolbarGUI	$toolbar,
		bool	$separator = `false`
	)

protected

Definition at line 940 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                                                             : void
    {
        if ($separator) {
            $toolbar->addSeparator();
        }
 
        $toolbar->addButton(
            $this->lng->txt('mail_assignments'),
            $this->ctrl->getLinkTargetByClass(
                'ilStudyProgrammeMailMemberSearchGUI',
                'showSelectableUsers'
            )
        );
    }

References $toolbar, ilToolbarGUI\addButton(), ilToolbarGUI\addSeparator(), and ILIAS\Repository\lng().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSearchGUI()

ilObjStudyProgrammeMembersGUI::initSearchGUI ( )

protected

Definition at line 927 of file class.ilObjStudyProgrammeMembersGUI.php.

                                      : void
    {
        ilStudyProgrammeRepositorySearchGUI::fillAutoCompleteToolbar(
            $this,
            $this->toolbar,
            array(
                "auto_complete_name" => $this->lng->txt("user"),
                "submit_name" => $this->lng->txt("add"),
                "add_search" => true
            )
        );
    }

References ilStudyProgrammeRepositorySearchGUI\fillAutoCompleteToolbar(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mailToSelectedUsers()

ilObjStudyProgrammeMembersGUI::mailToSelectedUsers ( )

protected

Definition at line 1030 of file class.ilObjStudyProgrammeMembersGUI.php.

                                            : void
    {
        $dic = ilStudyProgrammeDIC::specificDicFor($this->object);
        $gui = $dic['ilStudyProgrammeMailMemberSearchGUI'];
 
        $selected = $this->getPostPrgsIds();
        $selected_ids = array_map(
            fn ($id) => $id->getAssignmentId(),
            $selected
        );
 
        $assignments = array_filter(
            $this->getAssignmentsById(),
            fn ($ass) => in_array($ass->getId(), $selected_ids)
        );
        $gui->setAssignments($assignments);
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('btn_back'),
            $this->ctrl->getLinkTarget($this, $this->getDefaultCommand())
        );
        $this->ctrl->forwardCommand($gui);
    }

References $dic, $id, ILIAS\Repository\ctrl(), getAssignmentsById(), getPostPrgsIds(), ILIAS\Repository\lng(), ilStudyProgrammeDIC\specificDicFor(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markAccredited()

ilObjStudyProgrammeMembersGUI::markAccredited ( )

protected

Definition at line 493 of file class.ilObjStudyProgrammeMembersGUI.php.

                                       : void
    {
        $prgrs_id = $this->getPrgrsId();
        $msgs = $this->getMessageCollection('msg_mark_accredited');
        $this->markAccreditedByProgressId($prgrs_id, $msgs);
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\Repository\ctrl(), getMessageCollection(), getPrgrsId(), markAccreditedByProgressId(), and showMessages().

Here is the call graph for this function:

◆ markAccreditedByProgressId()

ilObjStudyProgrammeMembersGUI::markAccreditedByProgressId	(	PRGProgressId	$prgrs_id,
		ilPRGMessageCollection	$msgs
	)

protected

Definition at line 513 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                                                                        : void
    {
        $usr_id = $prgrs_id->getUsrId();
        if (!$this->mayCurrentUserEditProgressForUser($usr_id)) {
            $msgs->add(false, 'No permission to edit progress of user', (string) $prgrs_id);
        } else {
            $programme = $this->getStudyProgramme();
            $programme->markAccredited($prgrs_id->getAssignmentId(), $this->user->getId(), $msgs);
        }
    }

References ilPRGMessageCollection\add(), PRGProgressId\getAssignmentId(), getStudyProgramme(), PRGProgressId\getUsrId(), and mayCurrentUserEditProgressForUser().

Referenced by markAccredited(), and markAccreditedMulti().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markAccreditedMulti()

ilObjStudyProgrammeMembersGUI::markAccreditedMulti ( )

protected

Definition at line 502 of file class.ilObjStudyProgrammeMembersGUI.php.

                                            : void
    {
        $prgrs_ids = $this->getPostPrgsIds();
        $msgs = $this->getMessageCollection('msg_mark_accredited');
        foreach ($prgrs_ids as $key => $prgrs_id) {
            $this->markAccreditedByProgressId($prgrs_id, $msgs);
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\LTI\ToolProvider\$key, ILIAS\Repository\ctrl(), getMessageCollection(), getPostPrgsIds(), markAccreditedByProgressId(), and showMessages().

Here is the call graph for this function:

◆ markNotRelevant()

ilObjStudyProgrammeMembersGUI::markNotRelevant ( )

Definition at line 585 of file class.ilObjStudyProgrammeMembersGUI.php.

                                     : void
    {
        $prgrs_id = $this->getPrgrsId();
        $msgs = $this->getMessageCollection('msg_mark_not_relevant');
        $programme = $this->getStudyProgramme();
        if (!$this->mayCurrentUserEditProgressForUser($prgrs_id->getUsrId())) {
            $msgs->add(false, 'No permission to edit progress of user', (string) $prgrs_id);
        } else {
            $programme->markNotRelevant($prgrs_id->getAssignmentId(), $this->user->getId(), $msgs);
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\Repository\ctrl(), getMessageCollection(), getPrgrsId(), getStudyProgramme(), mayCurrentUserEditProgressForUser(), and showMessages().

Here is the call graph for this function:

◆ markNotRelevantMulti()

ilObjStudyProgrammeMembersGUI::markNotRelevantMulti ( )

Definition at line 599 of file class.ilObjStudyProgrammeMembersGUI.php.

                                          : void
    {
        $prgrs_ids = $this->getPostPrgsIds();
        $msgs = $this->getMessageCollection('msg_mark_not_relevant');
        $programme = $this->getStudyProgramme();
        foreach ($prgrs_ids as $key => $prgrs_id) {
            if (!$this->mayCurrentUserEditProgressForUser($prgrs_id->getUsrId())) {
                $msgs->add(false, 'No permission to edit progress of user', (string) $prgrs_id);
            } else {
                $programme->markNotRelevant($prgrs_id->getAssignmentId(), $this->user->getId(), $msgs);
            }
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\LTI\ToolProvider\$key, ILIAS\Repository\ctrl(), getMessageCollection(), getPostPrgsIds(), getStudyProgramme(), mayCurrentUserEditProgressForUser(), and showMessages().

Here is the call graph for this function:

◆ markRelevant()

ilObjStudyProgrammeMembersGUI::markRelevant ( )

Definition at line 555 of file class.ilObjStudyProgrammeMembersGUI.php.

                                  : void
    {
        $prgrs_id = $this->getPrgrsId();
        $msgs = $this->getMessageCollection('msg_mark_relevant');
        $programme = $this->getStudyProgramme();
        if (!$this->mayCurrentUserEditProgressForUser($prgrs_id->getUsrId())) {
            $msgs->add(false, "No permission to edit progress of user", (string) $prgrs_id);
        } else {
            $programme->markRelevant($prgrs_id->getAssignmentId(), $this->user->getId(), $msgs);
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\Repository\ctrl(), getMessageCollection(), getPrgrsId(), getStudyProgramme(), mayCurrentUserEditProgressForUser(), and showMessages().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markRelevantMulti()

ilObjStudyProgrammeMembersGUI::markRelevantMulti ( )

Definition at line 569 of file class.ilObjStudyProgrammeMembersGUI.php.

                                       : void
    {
        $prgrs_ids = $this->getPostPrgsIds();
        $msgs = $this->getMessageCollection('msg_mark_relevant');
        $programme = $this->getStudyProgramme();
        foreach ($prgrs_ids as $key => $prgrs_id) {
            if (!$this->mayCurrentUserEditProgressForUser($prgrs_id->getUsrId())) {
                $msgs->add(false, 'No permission to edit progress of user', (string) $prgrs_id);
            } else {
                $programme->markRelevant($prgrs_id->getAssignmentId(), $this->user->getId(), $msgs);
            }
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\LTI\ToolProvider\$key, ILIAS\Repository\ctrl(), getMessageCollection(), getPostPrgsIds(), getStudyProgramme(), mayCurrentUserEditProgressForUser(), and showMessages().

Here is the call graph for this function:

◆ mayCurrentUserEditProgressForUser()

ilObjStudyProgrammeMembersGUI::mayCurrentUserEditProgressForUser ( int $usr_id )

protected

Definition at line 1012 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                                     : bool
    {
        return in_array(
            $usr_id,
            $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN)
        );
    }

References ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN.

Referenced by confirmedUpdateFromCurrentPlan(), markAccreditedByProgressId(), markNotRelevant(), markNotRelevantMulti(), markRelevant(), markRelevantMulti(), and unmarkAccreditedByProgressId().

Here is the caller graph for this function:

◆ removeAssignment()

ilObjStudyProgrammeMembersGUI::removeAssignment ( PRGProgressId $pgs_id )

protected

Remove user.

Definition at line 891 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                              : void
    {
        if (!in_array(
            $pgs_id->getUsrId(),
            $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_MANAGE_MEMBERS)
        )) {
            throw new ilStudyProgrammePositionBasedAccessViolationException(
                'No permission to manage membership of user'
            );
        }
 
        $ass = $this->assignment_db->get($pgs_id->getAssignmentId());
        $prg_ref_id = ilObjStudyProgramme::getRefIdFor($ass->getRootId());
        if ($prg_ref_id !== $this->ref_id) {
            throw new ilException("Can only remove users from the node they where assigned to.");
        }
        $prg = ilObjStudyProgramme::getInstanceByRefId($prg_ref_id);
        $prg->removeAssignment($ass);
    }

References PRGProgressId\getAssignmentId(), ilObjStudyProgramme\getInstanceByRefId(), ilObjStudyProgramme\getRefIdFor(), PRGProgressId\getUsrId(), and ilOrgUnitOperation\OP_MANAGE_MEMBERS.

Referenced by confirmedRemoveUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeUser()

ilObjStudyProgrammeMembersGUI::removeUser ( )

Definition at line 837 of file class.ilObjStudyProgrammeMembersGUI.php.

                                : string
    {
        $prgrs_id = $this->getPrgrsId();
        return $this->confirmRemoveUsers([$prgrs_id]);
    }

References confirmRemoveUsers(), and getPrgrsId().

Here is the call graph for this function:

◆ removeUserMulti()

ilObjStudyProgrammeMembersGUI::removeUserMulti ( )

protected

Definition at line 843 of file class.ilObjStudyProgrammeMembersGUI.php.

                                        : string
    {
        $pgs_ids = $this->getPostPrgsIds();
        return $this->confirmRemoveUsers($pgs_ids);
    }

References confirmRemoveUsers(), and getPostPrgsIds().

Here is the call graph for this function:

◆ resetFilter()

ilObjStudyProgrammeMembersGUI::resetFilter ( )

Definition at line 356 of file class.ilObjStudyProgrammeMembersGUI.php.

                                 : void
    {
        $table = $this->getMembersTableGUI();
        $table->resetOffset();
        $table->resetFilter();
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\Repository\ctrl(), and getMembersTableGUI().

Here is the call graph for this function:

◆ setParentGUI()

ilObjStudyProgrammeMembersGUI::setParentGUI ( ilObjectGUI $a_parent_gui )

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

                                                           : void
    {
        $this->parent_gui = $a_parent_gui;
    }

◆ setRefId()

ilObjStudyProgrammeMembersGUI::setRefId ( int $ref_id )

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

                                         : void
    {
        $this->ref_id = $ref_id;
        $this->object = ilObjStudyProgramme::getInstanceByRefId($ref_id);
        $this->permissions = ilStudyProgrammeDIC::specificDicFor($this->object)['permissionhelper'];
    }

References $ref_id, ilObjStudyProgramme\getInstanceByRefId(), and ilStudyProgrammeDIC\specificDicFor().

Here is the call graph for this function:

◆ showInfoMessage()

ilObjStudyProgrammeMembersGUI::showInfoMessage ( string $lng_var )

protected

Shows ilUtil failed message.

Definition at line 922 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                       : void
    {
        $this->tpl->setOnScreenMessage("info", $this->lng->txt("prg_$lng_var"), true);
    }

References ILIAS\Repository\lng().

Referenced by confirmedRemoveUsers(), and getPostPrgsIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showMessages()

ilObjStudyProgrammeMembersGUI::showMessages ( ilPRGMessageCollection $msg )

protected

Definition at line 1025 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                                : void
    {
        $this->messages->showMessages($msg);
    }

Referenced by confirmedAcknowledgeAllCourses(), confirmedAcknowledgeCourses(), confirmedUpdateFromCurrentPlan(), markAccredited(), markAccreditedMulti(), markNotRelevant(), markNotRelevantMulti(), markRelevant(), markRelevantMulti(), unmarkAccredited(), and unmarkAccreditedMulti().

Here is the caller graph for this function:

◆ showSuccessMessage()

ilObjStudyProgrammeMembersGUI::showSuccessMessage ( string $lng_var )

protected

Shows ilUtil success message.

Definition at line 914 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                          : void
    {
        $this->tpl->setOnScreenMessage("success", $this->lng->txt("prg_$lng_var"), true);
    }

References ILIAS\Repository\lng().

Referenced by confirmedRemoveUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unmarkAccredited()

ilObjStudyProgrammeMembersGUI::unmarkAccredited ( )

protected

Definition at line 524 of file class.ilObjStudyProgrammeMembersGUI.php.

                                         : void
    {
        $prgrs_id = $this->getPrgrsId();
        $msgs = $this->getMessageCollection('msg_unmark_accredited');
        $this->unmarkAccreditedByProgressId($prgrs_id, $msgs);
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\Repository\ctrl(), getMessageCollection(), getPrgrsId(), showMessages(), and unmarkAccreditedByProgressId().

Here is the call graph for this function:

◆ unmarkAccreditedByProgressId()

ilObjStudyProgrammeMembersGUI::unmarkAccreditedByProgressId	(	PRGProgressId	$prgrs_id,
		ilPRGMessageCollection	$msgs
	)

protected

Definition at line 544 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                                                                          : void
    {
        $usr_id = $prgrs_id->getUsrId();
        if (!$this->mayCurrentUserEditProgressForUser($usr_id)) {
            $msgs->add(false, 'No permission to edit progress of user', (string) $prgrs_id);
        } else {
            $programme = $this->getStudyProgramme();
            $programme->unmarkAccredited($prgrs_id->getAssignmentId(), $this->user->getId(), $msgs);
        }
    }

References ilPRGMessageCollection\add(), PRGProgressId\getAssignmentId(), getStudyProgramme(), PRGProgressId\getUsrId(), and mayCurrentUserEditProgressForUser().

Referenced by unmarkAccredited(), and unmarkAccreditedMulti().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unmarkAccreditedMulti()

ilObjStudyProgrammeMembersGUI::unmarkAccreditedMulti ( )

Definition at line 533 of file class.ilObjStudyProgrammeMembersGUI.php.

                                           : void
    {
        $prgrs_ids = $this->getPostPrgsIds();
        $msgs = $this->getMessageCollection('msg_unmark_accredited');
        foreach ($prgrs_ids as $key => $prgrs_id) {
            $this->unmarkAccreditedByProgressId($prgrs_id, $msgs);
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References ILIAS\LTI\ToolProvider\$key, ILIAS\Repository\ctrl(), getMessageCollection(), getPostPrgsIds(), showMessages(), and unmarkAccreditedByProgressId().

Here is the call graph for this function:

◆ updateFromCurrentPlan()

ilObjStudyProgrammeMembersGUI::updateFromCurrentPlan ( )

Definition at line 615 of file class.ilObjStudyProgrammeMembersGUI.php.

                                           : string
    {
        $this->confirmation_gui->setFormAction($this->ctrl->getFormAction($this, 'confirmUpdateFromCurrentPlan'));
        $this->confirmation_gui->setHeaderText($this->lng->txt('header_update_current_plan'));
        $this->confirmation_gui->setConfirm($this->lng->txt('confirm'), 'confirmedUpdateFromCurrentPlan');
        $this->confirmation_gui->setCancel($this->lng->txt('cancel'), 'view');
 
        $prgs_id = $this->getPrgrsId();
        $user_name = ilObjUser::_lookupFullname($prgs_id->getUsrId());
        $this->confirmation_gui->addItem(
            self::F_SELECTED_PROGRESS_ID,
            (string) $prgs_id,
            $user_name
        );
        return $this->confirmation_gui->getHTML();
    }

References ilObjUser\_lookupFullname(), ILIAS\Repository\ctrl(), getPrgrsId(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ updateFromCurrentPlanMulti()

ilObjStudyProgrammeMembersGUI::updateFromCurrentPlanMulti ( )

Definition at line 632 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                : string
    {
        $this->confirmation_gui->setFormAction($this->ctrl->getFormAction($this, 'confirmUpdateFromCurrentPlan'));
        $this->confirmation_gui->setHeaderText($this->lng->txt('header_update_current_plan'));
        $this->confirmation_gui->setConfirm($this->lng->txt('confirm'), 'confirmedUpdateFromCurrentPlan');
        $this->confirmation_gui->setCancel($this->lng->txt('cancel'), 'view');
 
        foreach ($this->getPostPrgsIds() as $progress_id) {
            $user_name = ilObjUser::_lookupFullname($progress_id->getUsrId());
            $this->confirmation_gui->addItem(
                self::F_SELECTED_PROGRESS_IDS . '[]',
                (string) $progress_id,
                $user_name
            );
        }
        return $this->confirmation_gui->getHTML();
    }

References ilObjUser\_lookupFullname(), ILIAS\Repository\ctrl(), getPostPrgsIds(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ view()

ilObjStudyProgrammeMembersGUI::view ( )

protected

Shows table with all members of the SP.

Definition at line 334 of file class.ilObjStudyProgrammeMembersGUI.php.

                             : string
    {
        if ($this->getStudyProgramme()->isActive() && $this->permissions->may(ilOrgUnitOperation::OP_MANAGE_MEMBERS)) {
            $this->initSearchGUI();
            $this->initMailToMemberButton($this->toolbar, true);
        }
 
        if (!$this->getStudyProgramme()->isActive()) {
            $this->tpl->setOnScreenMessage("info", $this->lng->txt("prg_no_members_not_active"));
        }
        $table = $this->getMembersTableGUI();
        return $table->getHTML();
    }

References getMembersTableGUI(), getStudyProgramme(), initMailToMemberButton(), initSearchGUI(), ILIAS\Repository\lng(), ilOrgUnitOperation\OP_MANAGE_MEMBERS, and ILIAS\Repository\toolbar().

Here is the call graph for this function:

◆ viewCompletedCourses()

ilObjStudyProgrammeMembersGUI::viewCompletedCourses ( array $assignments )

Shows list of completed courses for each assignment.

Definition at line 407 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                            : Form
    {
        $prg = $this->getStudyProgramme();
        $completed_courses = [];
        $ass_ids = [];
        foreach ($assignments as $ass) {
            $ass_ids[] = $ass->getId();
            $completed_crss = $prg->getCompletedCourses($ass->getUserId());
 
            $label = sprintf(
                "%s (%s)",
                $ass->getUserInformation()->getFullname(),
                $ass->getId()
            );
            $options = [];
            foreach($completed_crss as $opt) {
                $options[implode(';', [$ass->getId(), $opt['prg_obj_id'],$opt['crs_id']])] = $opt['title'];
            }
 
            $completed_courses[] = $this->ui_factory->input()->field()->multiselect($label, $options);
        }
 
        $form_action = $this->ctrl->getFormAction($this, 'confirmedAcknowledgeCourses')
            . '&ass_ids=' . implode(',', $ass_ids);
 
        $form = $this->ui_factory->input()->container()->form()->standard(
            $form_action,
            [
                $this->ui_factory->input()->field()->section(
                    $completed_courses,
                    $this->lng->txt("prg_acknowledge_completed_courses")
                )
            ]
        )->withAdditionalTransformation(
            $this->refinery->custom()->transformation(
                function ($values) {
                    $values = array_merge(...array_filter(array_shift($values)));
                    return array_map(
                        fn ($entry) => explode(';', $entry),
                        $values
                    );
                }
            )
        );
 
        $this->toolbar->addComponent(
            $this->ui_factory->link()->standard(
                $this->lng->txt('prg_cancel_acknowledge_completed_courses'),
                $this->ctrl->getLinkTarget($this, self::DEFAULT_CMD)
            )
        );
        $this->toolbar->addComponent(
            $this->ui_factory->link()->standard(
                $this->lng->txt('prg_acknowledge_all_completed_courses'),
                $this->ctrl->getLinkTarget($this, 'confirmedAcknowledgeAllCourses')
                . '&ass_ids=' . implode(',', $ass_ids)
            )
        );
 
        return $form;
    }