Collaboration diagram for ilObjStudyProgrammeMembersGUI:

Public Member Functions
	__construct (\ilGlobalTemplateInterface $tpl, \ilCtrl $ilCtrl, \ilToolbarGUI $ilToolbar, \ilLanguage $lng, \ilObjUser $user, \ilTabsGUI $tabs, ilStudyProgrammeProgressRepository $sp_user_progress_db, ilStudyProgrammeAssignmentRepository $sp_user_assignment_db, ilStudyProgrammeRepositorySearchGUI $repository_search_gui, ilObjStudyProgrammeIndividualPlanGUI $individual_plan_gui, ilPRGMessagePrinter $messages, \ILIAS\Data\Factory $data_factory, ilConfirmationGUI $confirmation_gui)

	setParentGUI (ilObjectGUI $a_parent_gui)

	setRefId (int $ref_id)

	executeCommand ()

	applyFilter ()

	resetFilter ()

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

	viewCompletedCourses (array $completed_courses, array $users)
	Shows list of completed courses for each user if he should be assigned. More...

	addUsersWithAcknowledgedCourses ()
	Assign users if they have any completed course. More...

	unmarkAccreditedMulti ()

	markRelevantMulti ()

	markNotRelevantMulti ()

	updateFromCurrentPlanMulti ()

	changeDeadlineMulti ()

	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, int $prgrs_id, int $ass_id)
	Get the link target for an action on user progress. More...

Data Fields
const	DEFAULT_CMD = "view"

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_EXPIRE_DATE = "change_expire_date"

const	ACTION_CHANGE_DEADLINE = "change_deadline"

const	F_ALL_PROGRESS_IDS = 'all_progress_ids'

const	F_SELECTED_PROGRESS_IDS = 'prgs_ids'

	$ctrl

	$tpl

	$access

	$object

	$lng

	$toolbar

	$user

Protected Member Functions
	getDefaultCommand ()

	getAssignmentsById ()

	getMembersTableGUI ()

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

	getAddableUsers (array $users)

	_addUsers (array $user_ids)
	Add users to SP. More...

	getPostPrgsIds ()

	getGetPrgsIds ()

	getPrgrsId ()

	markAccredited ()

	markAccreditedMulti ()

	markAccreditedByProgressId (int $prgrs_id, ilPRGMessageCollection $msgs)

	unmarkAccredited ()

	unmarkAccreditedByProgressId (int $prgrs_id, ilPRGMessageCollection $msgs)

	removeUserMulti ()

	confirmedRemoveUsers ()

	confirmRemoveUsers (array $progress_ids)

	remove (int $prgrs_id)
	Remove user. More...

	getProgressObject (int $prgrs_id)
	Get progress object for prgrs id. 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)

	mayCurrentUserEditProgress (int $progress_id)

	getMessageCollection (string $topic)

	showMessages (ilPRGMessageCollection $msg)

Protected Attributes
	$tabs

	$parent_gui

	$sp_user_progress_db

	$progress_objects

	$messages

	$data_factory

	$permissions

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeMembersGUI::__construct	(	\ilGlobalTemplateInterface	$tpl,
		\ilCtrl	$ilCtrl,
		\ilToolbarGUI	$ilToolbar,
		\ilLanguage	$lng,
		\ilObjUser	$user,
		\ilTabsGUI	$tabs,
		ilStudyProgrammeProgressRepository	$sp_user_progress_db,
		ilStudyProgrammeAssignmentRepository	$sp_user_assignment_db,
		ilStudyProgrammeRepositorySearchGUI	$repository_search_gui,
		ilObjStudyProgrammeIndividualPlanGUI	$individual_plan_gui,
		ilPRGMessagePrinter	$messages,
		\ILIAS\Data\Factory	$data_factory,
		ilConfirmationGUI	$confirmation_gui
	)

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

      {
        $this->tpl = $tpl;
        $this->ctrl = $ilCtrl;
        $this->toolbar = $ilToolbar;
        $this->lng = $lng;
        $this->user = $user;
        $this->tabs = $tabs;
        $this->sp_user_assignment_db = $sp_user_assignment_db;
        $this->sp_user_progress_db = $sp_user_progress_db;
        $this->messages = $messages;
        $this->data_factory = $data_factory;
        $this->confirmation_gui = $confirmation_gui;
 
        $this->repository_search_gui = $repository_search_gui;
        $this->individual_plan_gui = $individual_plan_gui;
 
        $this->progress_objects = array();
        $this->object = null;
        $this->permissions = null;
 
        $lng->loadLanguageModule("prg");
    }

References $data_factory, $lng, $messages, $sp_user_progress_db, $tabs, $tpl, $user, and user().

Here is the call graph for this function:

Member Function Documentation

◆ _addUsers()

ilObjStudyProgrammeMembersGUI::_addUsers ( array $user_ids )

protected

Add users to SP.

Parameters

string[] $user_ids

Returns: array <string, ilStudyProgrammeAssignment>

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

                                                  : array
    {
        $prg = $this->getStudyProgramme();
        $assignments = array();
 
        foreach ($user_ids as $user_id) {
            $assignments[$user_id] = $prg->assignUser((int) $user_id);
        }
 
        if (count($assignments) == 1) {
            ilUtil::sendSuccess($this->lng->txt("prg_added_member"), true);
        }
        if (count($assignments) > 1) {
            ilUtil::sendSuccess($this->lng->txt("prg_added_members"), true);
        }
 
        return $assignments;
    }

References getStudyProgramme().

Referenced by addUsers(), and addUsersWithAcknowledgedCourses().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addUsers()

ilObjStudyProgrammeMembersGUI::addUsers ( array $user_ids )

Assigns a users to SP.

Parameters

string[] $user_ids

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

                                              : bool
    {
        $prg = $this->getStudyProgramme();
        $user_ids = $this->getAddableUsers($user_ids);
 
        $completed_courses = array();
        foreach ($user_ids as $user_id) {
            $completed_crss = $prg->getCompletedCourses((int) $user_id);
            if ($completed_crss) {
                $completed_courses[$user_id] = $completed_crss;
            }
        }
 
        if (count($completed_courses) > 0) {
            $this->viewCompletedCourses($completed_courses, $user_ids);
            return true;
        }
 
        $this->_addUsers($user_ids);
 
        $this->ctrl->redirect($this, "view");
    }

References _addUsers(), getAddableUsers(), getStudyProgramme(), and viewCompletedCourses().

Here is the call graph for this function:

◆ addUsersWithAcknowledgedCourses()

ilObjStudyProgrammeMembersGUI::addUsersWithAcknowledgedCourses ( )

Assign users if they have any completed course.

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

                                                      : void
    {
        $users = $_POST["users"];
        $users = $this->getAddableUsers($users);
        $assignments = $this->_addUsers($users);
        $completed_programmes = $_POST["courses"];
 
        if (is_array($completed_programmes)) {
            foreach ($completed_programmes as $user_id => $prg_ref_ids) {
                $ass_id = $assignments[$user_id]->getId();
                foreach ($prg_ref_ids as $ids) {
                    [$prg_ref_id, $crs_id, $crsr_id] = explode(";", $ids);
                    $prg = $this->getStudyProgramme((int) $prg_ref_id);
 
                    if ($prg->isActive()) {
                        $progress = $prg->getProgressForAssignment((int) $ass_id);
                        $prg->succeed($progress->getId(), (int) $crsr_id);
                    }
                }
            }
        }
 
        $this->ctrl->redirect($this, "view");
    }

References $_POST, _addUsers(), getAddableUsers(), and getStudyProgramme().

Here is the call graph for this function:

◆ applyFilter()

ilObjStudyProgrammeMembersGUI::applyFilter ( )

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

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

References getMembersTableGUI().

Here is the call graph for this function:

◆ changeDeadlineMulti()

ilObjStudyProgrammeMembersGUI::changeDeadlineMulti ( )

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

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

References getPostPrgsIds().

Here is the call graph for this function:

◆ changeExpireDateMulti()

ilObjStudyProgrammeMembersGUI::changeExpireDateMulti ( )

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

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

References getPostPrgsIds().

Here is the call graph for this function:

◆ confirmedRemoveUsers()

ilObjStudyProgrammeMembersGUI::confirmedRemoveUsers ( )

protected

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

                                              : void
    {
        $prgrs_ids = $this->getPostPrgsIds();
        $not_removed = array();
        foreach ($prgrs_ids as $key => $prgrs_id) {
            try {
                $this->remove((int) $prgrs_id);
            } catch (ilException $e) {
                $not_removed[] = $prgrs_id;
            }
        }
        if (count($not_removed) == count($prgrs_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, getPostPrgsIds(), showInfoMessage(), and showSuccessMessage().

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 686 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) {
            $progress = $this->getProgressObject($progress_id);
            $user = ilObjUser::_lookupFullname($progress->getUserId());
            $name = $user . ' (' . $progress->getId() . ')';
            
            $this->confirmation_gui->addItem(
                self::F_SELECTED_PROGRESS_IDS . '[]',
                $progress_id,
                $name
            );
        }
        return $this->confirmation_gui->getHTML();
    }

References $name, $user, ilObjUser\_lookupFullname(), and getProgressObject().

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 149 of file class.ilObjStudyProgrammeMembersGUI.php.

                                     : void
    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);
 
        if ($cmd == "") {
            $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::dic();
                $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 "addUsersWithAcknowledgedCourses":
                    case "markNotRelevantMulti":
                    case "markRelevantMulti":
                    case "updateFromCurrentPlanMulti":
                    case "applyFilter":
                    case "resetFilter":
                    case "changeDeadlineMulti":
                    case "changeExpireDateMulti":
                        $cont = $this->$cmd();
                        $this->tpl->setContent($cont);
                        break;
                    case "confirmedRemoveUsers":
                        $this->confirmedRemoveUsers();
                        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, confirmedRemoveUsers(), ilStudyProgrammeDIC\dic(), getAssignmentsById(), getDefaultCommand(), and getGetPrgsIds().

Here is the call graph for this function:

◆ getAddableUsers()

ilObjStudyProgrammeMembersGUI::getAddableUsers ( array $users )

protected

Parameters

int[] $users

Definition at line 414 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) {
            ilUtil::sendInfo(
                sprintf(
                    $this->lng->txt('could_not_add_users_no_permissons'),
                    $cnt_not_added
                ),
                true
            );
        }
        return $to_add;
    }

References ilOrgUnitOperation\OP_MANAGE_MEMBERS, and ilUtil\sendInfo().

Referenced by addUsers(), and addUsersWithAcknowledgedCourses().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsById()

ilObjStudyProgrammeMembersGUI::getAssignmentsById ( )

protected

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

                                            : array
    {
        $assignments = $this->object->getAssignments();
 
        return array_filter($assignments, function (ilStudyProgrammeAssignment $assignment) {
            return $assignment->getRootId() == $this->object->getId();
        });
    }

References ilStudyProgrammeAssignment\getRootId().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultCommand()

ilObjStudyProgrammeMembersGUI::getDefaultCommand ( )

protected

Definition at line 242 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 478 of file class.ilObjStudyProgrammeMembersGUI.php.

                                       : array
    {
        $prgrs_ids = $_GET['prgrs_ids'];
        if (is_null($prgrs_ids)) {
            return array();
        }
        return explode(',', $prgrs_ids);
    }

References $_GET.

Referenced by executeCommand().

Here is the caller graph for this function:

◆ getLinkTargetForAction()

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

Get the link target for an action on user progress.

Definition at line 804 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;
            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_MARK_ACCREDITED, ACTION_REMOVE_USER, ACTION_SHOW_INDIVIDUAL_PLAN, and ACTION_UNMARK_ACCREDITED.

◆ getMembersTableGUI()

ilObjStudyProgrammeMembersGUI::getMembersTableGUI ( )

protected

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

                                            : ilStudyProgrammeMembersTableGUI
    {
        $prg_id = ilObject::_lookupObjId($this->ref_id);
        $table = new ilStudyProgrammeMembersTableGUI(
            $prg_id,
            $this->ref_id,
            $this,
            "view",
            "",
            $this->sp_user_progress_db,
            $this->permissions,
            $this->data_factory
        );
        return $table;
    }

References ilObject\_lookupObjId().

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 837 of file class.ilObjStudyProgrammeMembersGUI.php.

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

Referenced by markAccredited(), markAccreditedMulti(), markNotRelevantMulti(), markRelevantMulti(), unmarkAccredited(), unmarkAccreditedMulti(), and updateFromCurrentPlanMulti().

Here is the caller graph for this function:

◆ getPostPrgsIds()

ilObjStudyProgrammeMembersGUI::getPostPrgsIds ( )

protected

Returns: int[]

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

                                        : array
    {
        if ($_POST['select_cmd_all']) {
            $prgrs_ids = $_POST[self::F_ALL_PROGRESS_IDS];
            $prgrs_ids = explode(',', $prgrs_ids);
        } else {
            $prgrs_ids = $_POST[self::F_SELECTED_PROGRESS_IDS];
        }
        if ($prgrs_ids === null) {
            $this->showInfoMessage("no_user_selected");
            $this->ctrl->redirect($this, "view");
        }
        return array_map('intval', $prgrs_ids);
    }

References $_POST, F_ALL_PROGRESS_IDS, F_SELECTED_PROGRESS_IDS, and showInfoMessage().

Referenced by changeDeadlineMulti(), changeExpireDateMulti(), confirmedRemoveUsers(), 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 487 of file class.ilObjStudyProgrammeMembersGUI.php.

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

References $_GET.

Referenced by markAccredited(), removeUser(), and unmarkAccredited().

Here is the caller graph for this function:

◆ getProgressObject()

ilObjStudyProgrammeMembersGUI::getProgressObject ( int $prgrs_id )

protected

Get progress object for prgrs id.

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

                                                        : ilStudyProgrammeProgress
    {
        if (!array_key_exists($prgrs_id, $this->progress_objects)) {
            $this->progress_objects[$prgrs_id] = $this->sp_user_progress_db->get(
                $prgrs_id
            );
        }
        return $this->progress_objects[$prgrs_id];
    }

Referenced by confirmRemoveUsers(), markAccreditedByProgressId(), mayCurrentUserEditProgress(), remove(), and unmarkAccreditedByProgressId().

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 793 of file class.ilObjStudyProgrammeMembersGUI.php.

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

References ilObjStudyProgramme\getInstanceByRefId().

Referenced by _addUsers(), addUsers(), addUsersWithAcknowledgedCourses(), markAccreditedByProgressId(), markNotRelevantMulti(), markRelevantMulti(), unmarkAccreditedByProgressId(), and view().

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 774 of file class.ilObjStudyProgrammeMembersGUI.php.

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

References $toolbar.

Referenced by view().

Here is the caller graph for this function:

◆ initSearchGUI()

ilObjStudyProgrammeMembersGUI::initSearchGUI ( )

protected

Definition at line 761 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().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markAccredited()

ilObjStudyProgrammeMembersGUI::markAccredited ( )

protected

Definition at line 496 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 getMessageCollection(), getPrgrsId(), markAccreditedByProgressId(), and showMessages().

Here is the call graph for this function:

◆ markAccreditedByProgressId()

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

protected

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

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

References ilPRGMessageCollection\add(), getProgressObject(), getStudyProgramme(), mayCurrentUserEditProgress(), and user().

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 505 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((int) $prgrs_id, $msgs);
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References getMessageCollection(), getPostPrgsIds(), markAccreditedByProgressId(), and showMessages().

Here is the call graph for this function:

◆ markNotRelevantMulti()

ilObjStudyProgrammeMembersGUI::markNotRelevantMulti ( )

Definition at line 576 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->mayCurrentUserEditProgress($prgrs_id)) {
                $msgs->add(false, 'No permission to edit progress of user', (string) $prgrs_id);
            } else {
                $programme->markNotRelevant($prgrs_id, $this->user->getId(), $msgs);
            }
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References getMessageCollection(), getPostPrgsIds(), getStudyProgramme(), mayCurrentUserEditProgress(), showMessages(), and user().

Here is the call graph for this function:

◆ markRelevantMulti()

ilObjStudyProgrammeMembersGUI::markRelevantMulti ( )

Definition at line 560 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->mayCurrentUserEditProgress($prgrs_id)) {
                $msgs->add(false, 'No permission to edit progress of user', (string) $prgrs_id);
            } else {
                $programme->markRelevant($prgrs_id, $this->user->getId(), $msgs);
            }
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References getMessageCollection(), getPostPrgsIds(), getStudyProgramme(), mayCurrentUserEditProgress(), showMessages(), and user().

Here is the call graph for this function:

◆ mayCurrentUserEditProgress()

ilObjStudyProgrammeMembersGUI::mayCurrentUserEditProgress ( int $progress_id )

protected

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

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

References getProgressObject(), and ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN.

Referenced by markAccreditedByProgressId(), markNotRelevantMulti(), markRelevantMulti(), unmarkAccreditedByProgressId(), and updateFromCurrentPlanMulti().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove()

ilObjStudyProgrammeMembersGUI::remove ( int $prgrs_id )

protected

Remove user.

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

                                             : void
    {
        $prgrs = $this->getProgressObject($prgrs_id);
 
        if (!in_array(
            $prgrs->getUserId(),
            $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_MANAGE_MEMBERS)
        )) {
            throw new ilStudyProgrammePositionBasedAccessViolationException(
                'No permission to manage membership of user'
            );
        }
 
        $ass = $this->sp_user_assignment_db->get($prgrs->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 ilObjStudyProgramme\getInstanceByRefId(), getProgressObject(), ilObjStudyProgramme\getRefIdFor(), and ilOrgUnitOperation\OP_MANAGE_MEMBERS.

Here is the call graph for this function:

◆ removeUser()

ilObjStudyProgrammeMembersGUI::removeUser ( )

Definition at line 653 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 659 of file class.ilObjStudyProgrammeMembersGUI.php.

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

References confirmRemoveUsers(), and getPostPrgsIds().

Here is the call graph for this function:

◆ resetFilter()

ilObjStudyProgrammeMembersGUI::resetFilter ( )

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

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

References getMembersTableGUI().

Here is the call graph for this function:

◆ setParentGUI()

ilObjStudyProgrammeMembersGUI::setParentGUI ( ilObjectGUI $a_parent_gui )

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

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

◆ setRefId()

ilObjStudyProgrammeMembersGUI::setRefId ( int $ref_id )

Definition at line 142 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 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 756 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                        : void
    {
        ilUtil::sendInfo($this->lng->txt("prg_$lng_var"), true);
    }

References ilUtil\sendInfo().

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 842 of file class.ilObjStudyProgrammeMembersGUI.php.

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

Referenced by markAccredited(), markAccreditedMulti(), markNotRelevantMulti(), markRelevantMulti(), unmarkAccredited(), unmarkAccreditedMulti(), and updateFromCurrentPlanMulti().

Here is the caller graph for this function:

◆ showSuccessMessage()

ilObjStudyProgrammeMembersGUI::showSuccessMessage ( string $lng_var )

protected

Shows ilUtil success message.

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

                                                           : void
    {
        ilUtil::sendSuccess($this->lng->txt("prg_$lng_var"), true);
    }

Referenced by confirmedRemoveUsers().

Here is the caller graph for this function:

◆ unmarkAccredited()

ilObjStudyProgrammeMembersGUI::unmarkAccredited ( )

protected

Definition at line 528 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 getMessageCollection(), getPrgrsId(), showMessages(), and unmarkAccreditedByProgressId().

Here is the call graph for this function:

◆ unmarkAccreditedByProgressId()

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

protected

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

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

References ilPRGMessageCollection\add(), getProgressObject(), getStudyProgramme(), mayCurrentUserEditProgress(), and user().

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 537 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((int) $prgrs_id, $msgs);
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References getMessageCollection(), getPostPrgsIds(), showMessages(), and unmarkAccreditedByProgressId().

Here is the call graph for this function:

◆ updateFromCurrentPlanMulti()

ilObjStudyProgrammeMembersGUI::updateFromCurrentPlanMulti ( )

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

                                                 : void
    {
        $prgrs_ids = $this->getPostPrgsIds();
        $msgs = $this->getMessageCollection('msg_update_from_settings');
        foreach ($prgrs_ids as $key => $prgrs_id) {
            if (!$this->mayCurrentUserEditProgress($prgrs_id)) {
                $msgs->add(false, 'no_permission_to_update_plan_of_user', (string) $prgrs_id);
                continue;
            }
            
            $this->object->updatePlanFromRepository(
                $prgrs_id,
                $this->user->getId(),
                $msgs
            );
        }
        $this->showMessages($msgs);
        $this->ctrl->redirect($this, "view");
    }

References getMessageCollection(), getPostPrgsIds(), mayCurrentUserEditProgress(), showMessages(), and user().

Here is the call graph for this function:

◆ view()

ilObjStudyProgrammeMembersGUI::view ( )

protected

Shows table with all members of the SP.

Returns: string

Definition at line 277 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()) {
            ilUtil::sendInfo($this->lng->txt("prg_no_members_not_active"));
        }
        $table = $this->getMembersTableGUI();
        return $table->getHTML();
    }

References getMembersTableGUI(), getStudyProgramme(), initMailToMemberButton(), initSearchGUI(), ilOrgUnitOperation\OP_MANAGE_MEMBERS, and ilUtil\sendInfo().

Here is the call graph for this function:

◆ viewCompletedCourses()

ilObjStudyProgrammeMembersGUI::viewCompletedCourses	(	array	$completed_courses,
		array	$users
	)

Shows list of completed courses for each user if he should be assigned.

Parameters

int[]	$completed_courses
int[]	$users

Returns: null

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

                                                                                 : void
    {
        $tpl = new ilTemplate(
            "tpl.acknowledge_completed_courses.html",
            true,
            true,
            "Modules/StudyProgramme"
        );
        $tpl->setVariable("TITLE", $this->lng->txt("prg_acknowledge_completed_courses"));
        $tpl->setVariable("CAPTION_ADD", $this->lng->txt("btn_next"));
        $tpl->setVariable("CAPTION_CANCEL", $this->lng->txt("cancel"));
        $tpl->setVariable("FORM_ACTION", $this->ctrl->getFormAction($this));
        $tpl->setVariable("ADD_CMD", "addUsersWithAcknowledgedCourses");
        $tpl->setVariable("CANCEL_CMD", "view");
 
        foreach ($completed_courses as $user_id => $completed_courses) {
            $names = ilObjUser::_lookupName($user_id);
            $tpl->setCurrentBlock("usr_section");
            $tpl->setVariable("FIRSTNAME", $names["firstname"]);
            $tpl->setVariable("LASTNAME", $names["lastname"]);
            $table = new ilStudyProgrammeAcknowledgeCompletedCoursesTableGUI(
                $this,
                $user_id,
                $completed_courses
            );
            $tpl->setVariable("TABLE", $table->getHTML());
            $tpl->parseCurrentBlock();
        }
 
        foreach ($users as $usr_id) {
            $tpl->setCurrentBlock("usr_ids_section");
            $tpl->setVariable("USR_ID", $usr_id);
            $tpl->parseCurrentBlock();
        }
 
        $this->tpl->setContent($tpl->get());
    }