ilObjStudyProgrammeMembersGUI: ilStudyProgrammeRepositorySearchGUI ilObjStudyProgrammeMembersGUI: ilObjStudyProgrammeIndividualPlanGUI ilObjStudyProgrammeMembersGUI: ilObjFileGUI ilObjStudyProgrammeMembersGUI: ilStudyProgrammeMailMemberSearchGUI ilObjStudyProgrammeMembersGUI: ilStudyProgrammeChangeExpireDateGUI ilObjStudyProgrammeMembersGUI: ilStudyProgrammeChangeDeadlineGUI ilObjStudyProgrammeMembersGUI: ilFormPropertyDispatchGUI More...

Collaboration diagram for ilObjStudyProgrammeMembersGUI:

Public Member Functions
	__construct (\ilGlobalTemplateInterface $tpl, \ilCtrl $ilCtrl, \ilToolbarGUI $ilToolbar, \ilAccess $access, \ilLanguage $lng, \ilObjUser $user, \ilTabsGUI $tabs, ilStudyProgrammeUserProgressDB $sp_user_progress_db, ilStudyProgrammeUserAssignmentDB $sp_user_assignment_db, ilStudyProgrammeRepositorySearchGUI $repository_search_gui, ilObjStudyProgrammeIndividualPlanGUI $individual_plan_gui, ilStudyProgrammePositionBasedAccess $position_based_access)

	setParentGUI (ilObjectGUI $a_parent_gui)

	setRefId (int $ref_id)

	executeCommand ()

	applyFilter ()

	resetFilter ()

	addUsers (array $users)
	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...

	markAccredited ()
	Mark SP for single user accredited. More...

	markAccreditedMulti ()
	Mark SP for users accredited. More...

	unmarkAccredited ()
	Unmark SP for single user accredited. More...

	unmarkAccreditedMulti ()
	Unmark SP for users accredited. More...

	markRelevantMulti ()
	Mark SP as relevant for users. More...

	markNotRelevantMulti ()
	Mark SP as not relevant for users. More...

	updateFromCurrentPlanMulti ()
	Update user plan from current SP structure if they has no individual plan. More...

	changeDeadlineMulti ()

	changeExpireDateMulti ()

	removeUser ()
	Remove single user from SP. More...

	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...

	visibleUsers ()

	viewMembers ()

	readLearningProgress ()

	viewIndividualPlan ()

	editIndividualPlan ()

	manageMembers ()

	mayManageMembers ()

	getLocalMembers ()

	isOperationAllowedForUser (int $usr_id, string $operation)

Data Fields
	$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 $users)
	Add users to SP. More...

	getPostPrgsIds ()
	Get post prgs ids. More...

	getGetPrgsIds ()

	markAccreditedById (int $prgrs_id)
	Accredited SP. More...

	unmarkAccreditedByProgressId (int $prgrs_id)
	Deaccredited SP. More...

	removeUserMulti ()
	Remove user from SP. More...

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

	getProgressObject (int $prgrs_id)
	Get progress object for prgrs id. More...

	getPrgrsId ()
	Get current prgrs_id from URL. 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)

	updateUserAssignmentFromProgramm (ilStudyProgrammeUserAssignment $ass)

Protected Attributes
	$tabs

	$parent_gui

	$sp_user_progress_db

	$progress_objects

	$view_members

	$read_learning_progress

	$view_individual_plan

	$edit_individual_plan

	$manage_members

Detailed Description

ilObjStudyProgrammeMembersGUI: ilStudyProgrammeRepositorySearchGUI ilObjStudyProgrammeMembersGUI: ilObjStudyProgrammeIndividualPlanGUI ilObjStudyProgrammeMembersGUI: ilObjFileGUI ilObjStudyProgrammeMembersGUI: ilStudyProgrammeMailMemberSearchGUI ilObjStudyProgrammeMembersGUI: ilStudyProgrammeChangeExpireDateGUI ilObjStudyProgrammeMembersGUI: ilStudyProgrammeChangeDeadlineGUI ilObjStudyProgrammeMembersGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeMembersGUI::__construct	(	\ilGlobalTemplateInterface	$tpl,
		\ilCtrl	$ilCtrl,
		\ilToolbarGUI	$ilToolbar,
		\ilAccess	$access,
		\ilLanguage	$lng,
		\ilObjUser	$user,
		\ilTabsGUI	$tabs,
		ilStudyProgrammeUserProgressDB	$sp_user_progress_db,
		ilStudyProgrammeUserAssignmentDB	$sp_user_assignment_db,
		ilStudyProgrammeRepositorySearchGUI	$repository_search_gui,
		ilObjStudyProgrammeIndividualPlanGUI	$individual_plan_gui,
		ilStudyProgrammePositionBasedAccess	$position_based_access
	)

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

References $access, $ilCtrl, $lng, $sp_user_progress_db, $tabs, $tpl, $user, ilLanguage\loadLanguageModule(), and user().

       {
         $this->tpl = $tpl;
         $this->ctrl = $ilCtrl;
         $this->toolbar = $ilToolbar;
         $this->access = $access;
         $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->repository_search_gui = $repository_search_gui;
         $this->individual_plan_gui = $individual_plan_gui;
 
         $this->progress_objects = array();
         $this->position_based_access = $position_based_access;
         $this->object = null;
 
         $lng->loadLanguageModule("prg");
     }

Here is the call graph for this function:

Member Function Documentation

◆ _addUsers()

ilObjStudyProgrammeMembersGUI::_addUsers ( array $users )

protected

Add users to SP.

Parameters

int[] $users

Returns: ilStudyProgrammeUserAssignment[]

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

References getStudyProgramme().

Referenced by addUsers(), and addUsersWithAcknowledgedCourses().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addUsers()

ilObjStudyProgrammeMembersGUI::addUsers ( array $users )

Assigns a users to SP.

Parameters

int[] $users

Returns: null

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

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

                                            : bool
     {
         $prg = $this->getStudyProgramme();
         $users = $this->getAddableUsers($users);
 
         $completed_courses = array();
         foreach ($users 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, $users);
             return true;
         }
 
         $this->_addUsers($users);
 
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ addUsersWithAcknowledgedCourses()

ilObjStudyProgrammeMembersGUI::addUsersWithAcknowledgedCourses ( )

Assign users if they have any completed course.

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

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

                                                       : 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);
                     $progress = $prg->getProgressForAssignment((int) $ass_id);
                     $progress->setLPCompleted((int) $crsr_id, $user_id);
                 }
             }
         }
 
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ applyFilter()

ilObjStudyProgrammeMembersGUI::applyFilter ( )

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

References getMembersTableGUI().

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

Here is the call graph for this function:

◆ changeDeadlineMulti()

ilObjStudyProgrammeMembersGUI::changeDeadlineMulti ( )

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

References getPostPrgsIds().

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

Here is the call graph for this function:

◆ changeExpireDateMulti()

ilObjStudyProgrammeMembersGUI::changeExpireDateMulti ( )

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

References getPostPrgsIds().

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

Here is the call graph for this function:

◆ editIndividualPlan()

ilObjStudyProgrammeMembersGUI::editIndividualPlan ( )

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

References $edit_individual_plan, and ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN.

Referenced by markAccreditedById(), markNotRelevantMulti(), markRelevantMulti(), unmarkAccreditedByProgressId(), viewIndividualPlan(), and visibleUsers().

     {
         if (!$this->edit_individual_plan) {
             $this->edit_individual_plan =
                 $this->position_based_access->getUsersInPrgAccessibleForOperation(
                     $this->object,
                     ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN
                 );
         }
         return $this->edit_individual_plan;
     }

Here is the caller graph for this function:

◆ executeCommand()

ilObjStudyProgrammeMembersGUI::executeCommand ( )

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

References $dic, ilStudyProgrammeDIC\dic(), getAssignmentsById(), getDefaultCommand(), and getGetPrgsIds().

                                      : void
     {
         $cmd = $this->ctrl->getCmd();
         $next_class = $this->ctrl->getNextClass($this);
 
         if ($cmd == "") {
             $cmd = "view";
         }
 
         # TODO: Check permission of user!!
 
         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;
                     default:
                         throw new ilException("ilObjStudyProgrammeMembersGUI: " .
                                               "Command not supported: $cmd");
                 }
                 break;
             default:
                 throw new ilException(
                     "ilObjStudyProgrammeMembersGUI: Can't forward to next class $next_class"
                 );
         }
     }

Here is the call graph for this function:

◆ getAddableUsers()

ilObjStudyProgrammeMembersGUI::getAddableUsers ( array $users )

protected

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

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

Referenced by addUsers(), and addUsersWithAcknowledgedCourses().

                                                      : array
     {
         if ($this->mayManageMembers()) {
             return $users;
         }
 
         if ($this->getStudyProgramme()->getAccessControlByOrguPositionsGlobal()) {
             $to_add = $this->position_based_access->filterUsersAccessibleForOperation(
                 $this->getStudyProgramme(),
                 ilOrgUnitOperation::OP_MANAGE_MEMBERS,
                 $users
             );
             $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;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsById()

ilObjStudyProgrammeMembersGUI::getAssignmentsById ( )

protected

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

References ilStudyProgrammeUserAssignment\getStudyProgramme().

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultCommand()

ilObjStudyProgrammeMembersGUI::getDefaultCommand ( )

protected

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

Referenced by executeCommand().

                                            : string
     {
         return "view";
     }

Here is the caller graph for this function:

◆ getGetPrgsIds()

ilObjStudyProgrammeMembersGUI::getGetPrgsIds ( )

protected

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

References $_GET.

Referenced by executeCommand().

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

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

References ilStudyProgrammeUserProgress\ACTION_MARK_ACCREDITED, ilStudyProgrammeUserProgress\ACTION_REMOVE_USER, ilStudyProgrammeUserProgress\ACTION_SHOW_INDIVIDUAL_PLAN, and ilStudyProgrammeUserProgress\ACTION_UNMARK_ACCREDITED.

                                                                                        : string
     {
         switch ($action) {
             case ilStudyProgrammeUserProgress::ACTION_MARK_ACCREDITED:
                 $target_name = "markAccredited";
                 break;
             case ilStudyProgrammeUserProgress::ACTION_UNMARK_ACCREDITED:
                 $target_name = "unmarkAccredited";
                 break;
             case ilStudyProgrammeUserProgress::ACTION_SHOW_INDIVIDUAL_PLAN:
                 return $this->individual_plan_gui->getLinkTargetView($ass_id);
             case ilStudyProgrammeUserProgress::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;
     }

◆ getLocalMembers()

ilObjStudyProgrammeMembersGUI::getLocalMembers ( )

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

                                       : array
     {
         return $this->object->getMembers();
     }

◆ getMembersTableGUI()

ilObjStudyProgrammeMembersGUI::getMembersTableGUI ( )

protected

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

References ilObject\_lookupObjId().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPostPrgsIds()

ilObjStudyProgrammeMembersGUI::getPostPrgsIds ( )

protected

Get post prgs ids.

Returns: string[]

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

References $_POST, and showInfoMessage().

Referenced by changeDeadlineMulti(), changeExpireDateMulti(), markAccreditedMulti(), markNotRelevantMulti(), markRelevantMulti(), removeUserMulti(), unmarkAccreditedMulti(), and updateFromCurrentPlanMulti().

                                         : array
     {
         $prgrs_ids = $_POST['prgs_ids'];
         if ($prgrs_ids === null) {
             $this->showInfoMessage("no_user_selected");
             $this->ctrl->redirect($this, "view");
         }
         return $prgrs_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPrgrsId()

ilObjStudyProgrammeMembersGUI::getPrgrsId ( )

protected

Get current prgrs_id from URL.

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

References $_GET.

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

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

Here is the caller graph for this function:

◆ getProgressObject()

ilObjStudyProgrammeMembersGUI::getProgressObject ( int $prgrs_id )

protected

Get progress object for prgrs id.

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

Referenced by markAccreditedById(), markNotRelevantMulti(), markRelevantMulti(), remove(), unmarkAccreditedByProgressId(), unmarkAccreditedMulti(), and updateFromCurrentPlanMulti().

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

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

References ilObjStudyProgramme\getInstanceByRefId().

Referenced by ilStudyProgrammeMembersTableGUI\__construct(), _addUsers(), addUsers(), addUsersWithAcknowledgedCourses(), getAddableUsers(), and view().

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

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

References ilToolbarGUI\addButton(), and ilToolbarGUI\addSeparator().

Referenced by view().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSearchGUI()

ilObjStudyProgrammeMembersGUI::initSearchGUI ( )

protected

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

References ilStudyProgrammeRepositorySearchGUI\fillAutoCompleteToolbar().

Referenced by view().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isOperationAllowedForUser()

ilObjStudyProgrammeMembersGUI::isOperationAllowedForUser	(	int	$usr_id,
		string	$operation
	)

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

References mayManageMembers().

                                                                               : bool
     {
         return $this->mayManageMembers()
             || $this->position_based_access->isUserAccessibleForOperationAtPrg($usr_id, $this->object, $operation);
     }

Here is the call graph for this function:

◆ manageMembers()

ilObjStudyProgrammeMembersGUI::manageMembers ( )

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

References $manage_members, and ilOrgUnitOperation\OP_MANAGE_MEMBERS.

Referenced by remove(), viewMembers(), and visibleUsers().

     {
         if (!$this->manage_members) {
             $this->manage_members =
                 $this->position_based_access->getUsersInPrgAccessibleForOperation(
                     $this->object,
                     ilOrgUnitOperation::OP_MANAGE_MEMBERS
                 );
         }
         return $this->manage_members;
     }

Here is the caller graph for this function:

◆ markAccredited()

ilObjStudyProgrammeMembersGUI::markAccredited ( )

Mark SP for single user accredited.

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

References getPrgrsId(), markAccreditedById(), and showSuccessMessage().

                                      : void
     {
         $prgrs_id = $this->getPrgrsId();
         $this->markAccreditedById($prgrs_id);
         $this->showSuccessMessage("mark_accredited_success");
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ markAccreditedById()

ilObjStudyProgrammeMembersGUI::markAccreditedById ( int $prgrs_id )

protected

Accredited SP.

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

References editIndividualPlan(), getProgressObject(), mayManageMembers(), updateUserAssignmentFromProgramm(), and user().

Referenced by markAccredited(), and markAccreditedMulti().

                                                          : void
     {
         $prgrs = $this->getProgressObject($prgrs_id);
         $usr_id = $prgrs->getUserId();
         if (
             $this->object->getAccessControlByOrguPositionsGlobal() &&
             !in_array($usr_id, $this->editIndividualPlan()) &&
             !$this->mayManageMembers()
         ) {
             throw new ilStudyProgrammePositionBasedAccessViolationException(
                 'No permission to edit progress of user'
             );
         }
         $prgrs->markAccredited($this->user->getId());
 
         $ass = $this->sp_user_assignment_db->getInstanceById($prgrs->getAssignmentId());
         $this->updateUserAssignmentFromProgramm($ass);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markAccreditedMulti()

ilObjStudyProgrammeMembersGUI::markAccreditedMulti ( )

Mark SP for users accredited.

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

References Vendor\Package\$e, $errors, getPostPrgsIds(), markAccreditedById(), showInfoMessage(), and showSuccessMessage().

                                           : void
     {
         $prgrs_ids = $this->getPostPrgsIds();
         $errors = 0;
         foreach ($prgrs_ids as $key => $prgrs_id) {
             try {
                 $this->markAccreditedById((int) $prgrs_id);
             } catch (ilStudyProgrammePositionBasedAccessViolationException $e) {
                 $errors++;
             }
         }
         if ($errors === 0) {
             $this->showSuccessMessage("mark_accredited_multi_success");
         } else {
             $this->showInfoMessage("some_users_may_not_be_accredited");
         }
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ markNotRelevantMulti()

ilObjStudyProgrammeMembersGUI::markNotRelevantMulti ( )

Mark SP as not relevant for users.

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

References $errors, editIndividualPlan(), getPostPrgsIds(), getProgressObject(), mayManageMembers(), showInfoMessage(), showSuccessMessage(), and user().

                                            : void
     {
         $prgrs_ids = $this->getPostPrgsIds();
         $errors = 0;
         foreach ($prgrs_ids as $key => $prgrs_id) {
             $prgrs = $this->getProgressObject((int) $prgrs_id);
             $usr_id = $prgrs->getUserId();
             if ($this->object->getAccessControlByOrguPositionsGlobal() &&
                 !in_array($usr_id, $this->editIndividualPlan()) &&
                 !$this->mayManageMembers()
             ) {
                 $errors++;
                 continue;
             }
             $prgrs->markNotRelevant($this->user->getId());
         }
         if ($errors === 0) {
             $this->showSuccessMessage("mark_not_relevant_multi_success");
         } else {
             $this->showInfoMessage("some_users_may_not_be_marked_not_relevant");
         }
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ markRelevantMulti()

ilObjStudyProgrammeMembersGUI::markRelevantMulti ( )

Mark SP as relevant for users.

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

References $errors, editIndividualPlan(), getPostPrgsIds(), getProgressObject(), mayManageMembers(), showInfoMessage(), showSuccessMessage(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, and user().

                                         : void
     {
         $prgrs_ids = $this->getPostPrgsIds();
         $errors = 0;
         foreach ($prgrs_ids as $key => $prgrs_id) {
             $prgrs = $this->getProgressObject((int) $prgrs_id);
             $usr_id = $prgrs->getUserId();
             if ($this->object->getAccessControlByOrguPositionsGlobal() &&
                 !in_array($usr_id, $this->editIndividualPlan()) &&
                 !$this->mayManageMembers()
             ) {
                 $errors++;
                 continue;
             }
 
             $prgrs_status = $this->getProgressObject((int) $prgrs_id)->getStatus();
             if (
                  $prgrs_status == ilStudyProgrammeProgress::STATUS_IN_PROGRESS ||
                  $prgrs_status == ilStudyProgrammeProgress::STATUS_ACCREDITED
             ) {
                 continue;
             }
             $prgrs->markRelevant($this->user->getId());
         }
         if ($errors === 0) {
             $this->showSuccessMessage("mark_relevant_multi_success");
         } else {
             $this->showInfoMessage("some_users_may_not_be_marked_relevant");
         }
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ mayManageMembers()

ilObjStudyProgrammeMembersGUI::mayManageMembers ( )

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

References user().

Referenced by getAddableUsers(), isOperationAllowedForUser(), markAccreditedById(), markNotRelevantMulti(), markRelevantMulti(), remove(), and unmarkAccreditedByProgressId().

                                        : bool
     {
         return $this->access->checkAccessOfUser(
             $this->user->getId(),
             'manage_members',
             '',
             $this->object->getRefId()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readLearningProgress()

ilObjStudyProgrammeMembersGUI::readLearningProgress ( )

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

References $read_learning_progress, ilOrgUnitOperation\OP_READ_LEARNING_PROGRESS, and viewIndividualPlan().

Referenced by visibleUsers().

     {
         if (!$this->read_learning_progress) {
             $this->read_learning_progress =
                 array_unique(array_merge(
                     $this->position_based_access->getUsersInPrgAccessibleForOperation(
                         $this->object,
                         ilOrgUnitOperation::OP_READ_LEARNING_PROGRESS
                     ),
                     $this->viewIndividualPlan()
                 ));
         }
         return $this->read_learning_progress;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove()

ilObjStudyProgrammeMembersGUI::remove ( int $prgrs_id )

protected

Rmeove user.

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

References getProgressObject(), manageMembers(), and mayManageMembers().

                                              : void
     {
         $prgrs = $this->getProgressObject($prgrs_id);
         $usr_id = $prgrs->getUserId();
         if (
             $this->object->getAccessControlByOrguPositionsGlobal() &&
             !in_array($usr_id, $this->manageMembers()) &&
             !$this->mayManageMembers()
         ) {
             throw new ilStudyProgrammePositionBasedAccessViolationException(
                 'No permission to manage membership of user'
             );
         }
         $ass = $this->sp_user_assignment_db->getInstanceById($prgrs->getAssignmentId());
         $prg = $ass->getStudyProgramme();
         if ($prg->getRefId() != $this->ref_id) {
             throw new ilException("Can only remove users from the node they where assigned to.");
         }
         $ass->deassign();
     }

Here is the call graph for this function:

◆ removeUser()

ilObjStudyProgrammeMembersGUI::removeUser ( )

Remove single user from SP.

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

References getPrgrsId(), and showSuccessMessage().

                                  : void
     {
         $prgrs_id = $this->getPrgrsId();
         $this->remove($prgrs_id);
         $this->showSuccessMessage("remove_user_success");
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ removeUserMulti()

ilObjStudyProgrammeMembersGUI::removeUserMulti ( )

protected

Remove user from SP.

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

References Vendor\Package\$e, getPostPrgsIds(), showInfoMessage(), and showSuccessMessage().

                                          : 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_partitial_success");
         } else {
             $this->showSuccessMessage("remove_users_success");
         }
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ resetFilter()

ilObjStudyProgrammeMembersGUI::resetFilter ( )

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

References getMembersTableGUI().

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

Here is the call graph for this function:

◆ setParentGUI()

ilObjStudyProgrammeMembersGUI::setParentGUI ( ilObjectGUI $a_parent_gui )

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

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

◆ setRefId()

ilObjStudyProgrammeMembersGUI::setRefId ( int $ref_id )

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

References ilObjStudyProgramme\getInstanceByRefId().

                                           : void
     {
         $this->ref_id = $ref_id;
         $this->object = \ilObjStudyProgramme::getInstanceByRefId($ref_id);
     }

Here is the call graph for this function:

◆ showInfoMessage()

ilObjStudyProgrammeMembersGUI::showInfoMessage ( string $lng_var )

protected

Shows ilUtil failed message.

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

References ilUtil\sendInfo().

Referenced by getPostPrgsIds(), markAccreditedMulti(), markNotRelevantMulti(), markRelevantMulti(), removeUserMulti(), unmarkAccreditedMulti(), and updateFromCurrentPlanMulti().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSuccessMessage()

ilObjStudyProgrammeMembersGUI::showSuccessMessage ( string $lng_var )

protected

Shows ilUtil success message.

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

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

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

Here is the caller graph for this function:

◆ unmarkAccredited()

ilObjStudyProgrammeMembersGUI::unmarkAccredited ( )

Unmark SP for single user accredited.

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

References getPrgrsId(), showSuccessMessage(), and unmarkAccreditedByProgressId().

                                        : void
     {
         $prgrs_id = $this->getPrgrsId();
         $this->unmarkAccreditedByProgressId($prgrs_id);
         $this->showSuccessMessage("unmark_accredited_success");
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ unmarkAccreditedByProgressId()

ilObjStudyProgrammeMembersGUI::unmarkAccreditedByProgressId ( int $prgrs_id )

protected

Deaccredited SP.

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

References editIndividualPlan(), getProgressObject(), mayManageMembers(), and updateUserAssignmentFromProgramm().

Referenced by unmarkAccredited(), and unmarkAccreditedMulti().

                                                                    : void
     {
         $prgrs = $this->getProgressObject($prgrs_id);
         $usr_id = $prgrs->getUserId();
         if (
             $this->object->getAccessControlByOrguPositionsGlobal() &&
             !in_array($usr_id, $this->editIndividualPlan()) &&
             !$this->mayManageMembers()
         ) {
             throw new ilStudyProgrammePositionBasedAccessViolationException(
                 'No permission to edit progress of user'
             );
         }
         $prgrs->unmarkAccredited();
 
         $ass = $this->sp_user_assignment_db->getInstanceById($prgrs->getAssignmentId());
         $this->updateUserAssignmentFromProgramm($ass);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unmarkAccreditedMulti()

ilObjStudyProgrammeMembersGUI::unmarkAccreditedMulti ( )

Unmark SP for users accredited.

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

References Vendor\Package\$e, $errors, getPostPrgsIds(), getProgressObject(), showInfoMessage(), showSuccessMessage(), ilStudyProgrammeProgress\STATUS_ACCREDITED, and unmarkAccreditedByProgressId().

                                             : void
     {
         $prgrs_ids = $this->getPostPrgsIds();
         $errors = 0;
         foreach ($prgrs_ids as $key => $prgrs_id) {
             $prgrs_status = $this->getProgressObject((int) $prgrs_id)->getStatus();
             if ($prgrs_status == ilStudyProgrammeProgress::STATUS_ACCREDITED) {
                 try {
                     $this->unmarkAccreditedByProgressId((int) $prgrs_id);
                 } catch (ilStudyProgrammePositionBasedAccessViolationException $e) {
                     $errors++;
                 }
             }
         }
         if ($errors === 0) {
             $this->showSuccessMessage("unmark_accredited_multi_success");
         } else {
             $this->showInfoMessage("some_users_may_not_be_unmarked_accredited");
         }
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ updateFromCurrentPlanMulti()

ilObjStudyProgrammeMembersGUI::updateFromCurrentPlanMulti ( )

Update user plan from current SP structure if they has no individual plan.

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

References getPostPrgsIds(), getProgressObject(), showInfoMessage(), showSuccessMessage(), and updateUserAssignmentFromProgramm().

                                                  : void
     {
         $prgrs_ids = $this->getPostPrgsIds();
         $not_updated = array();
 
         foreach ($prgrs_ids as $key => $prgrs_id) {
             //** ilStudyProgrammeUserProgress */
             $prgrs = $this->getProgressObject((int) $prgrs_id);
             //** ilStudyProgrammeUserAssignment */
             $ass = $this->sp_user_assignment_db->getInstanceById($prgrs->getAssignmentId());
             $prg = $ass->getStudyProgramme();
             if ($prg->getRefId() != $this->ref_id) {
                 $not_updated[] = $prgrs_id;
                 continue;
             }
 
             $this->updateUserAssignmentFromProgramm($ass);
         }
 
         if (count($not_updated) == count($prgrs_ids)) {
             $this->showInfoMessage("update_from_current_plan_not_possible");
         } elseif (count($not_updated) > 0) {
             $this->showSuccessMessage("update_from_current_plan_partitial_success");
         } else {
             $this->showSuccessMessage("update_from_current_plan_success");
         }
 
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ updateUserAssignmentFromProgramm()

ilObjStudyProgrammeMembersGUI::updateUserAssignmentFromProgramm ( ilStudyProgrammeUserAssignment $ass )

protected

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

References ilStudyProgrammeUserAssignment\updateDeadlineFromProgram(), and ilStudyProgrammeUserAssignment\updateValidityFromProgram().

Referenced by markAccreditedById(), unmarkAccreditedByProgressId(), and updateFromCurrentPlanMulti().

                                                                                              : void
     {
         $ass->updateFromProgram();
         $ass->updateValidityFromProgram();
         $ass->updateDeadlineFromProgram();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ view()

ilObjStudyProgrammeMembersGUI::view ( )

protected

Shows table with all members of the SP.

Returns: string

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

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

                               : string
     {
         if ($this->getStudyProgramme()->isActive()) {
             $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();
     }

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

References $tpl, and ilObjUser\_lookupName().

Referenced by addUsers().

                                                                                  : 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());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ viewIndividualPlan()

ilObjStudyProgrammeMembersGUI::viewIndividualPlan ( )

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

References $view_individual_plan, editIndividualPlan(), and ilOrgUnitOperation\OP_VIEW_INDIVIDUAL_PLAN.

Referenced by readLearningProgress(), and visibleUsers().

     {
         if (!$this->view_individual_plan) {
             $this->view_individual_plan =
                 array_unique(array_merge(
                     $this->position_based_access->getUsersInPrgAccessibleForOperation(
                         $this->object,
                         ilOrgUnitOperation::OP_VIEW_INDIVIDUAL_PLAN
                     ),
                     $this->editIndividualPlan()
                 ));
         }
         return $this->view_individual_plan;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ viewMembers()

ilObjStudyProgrammeMembersGUI::viewMembers ( )

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

References $view_members, manageMembers(), and ilOrgUnitOperation\OP_VIEW_MEMBERS.

Referenced by visibleUsers().

     {
         if (!$this->view_members) {
             $this->view_members =
                 array_unique(array_merge(
                     $this->position_based_access->getUsersInPrgAccessibleForOperation(
                         $this->object,
                         ilOrgUnitOperation::OP_VIEW_MEMBERS
                     ),
                     $this->manageMembers()
                 ));
         }
         return $this->view_members;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ visibleUsers()

ilObjStudyProgrammeMembersGUI::visibleUsers ( )

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

References editIndividualPlan(), manageMembers(), readLearningProgress(), viewIndividualPlan(), and viewMembers().

                                    : array
     {
         return array_unique(array_merge(
             $this->viewMembers(),
             $this->readLearningProgress(),
             $this->viewIndividualPlan(),
             $this->editIndividualPlan(),
             $this->manageMembers()
         ));
     }