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

Collaboration diagram for ilObjStudyProgrammeMembersGUI:

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

	setParentGUI (ilObjectGUI $a_parent_gui)

	setRefId (int $ref_id)

	executeCommand ()

	applyFilter ()

	resetFilter ()

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

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

	unmarkAccreditedMulti ()

	markRelevant ()

	markRelevantMulti ()

	markNotRelevant ()

	markNotRelevantMulti ()

	updateFromCurrentPlan ()

	updateFromCurrentPlanMulti ()

	confirmedUpdateFromCurrentPlan ()

	acknowledgeCourses ()

	acknowledgeCoursesMulti ()

	confirmedAcknowledgeAllCourses ()

	confirmedAcknowledgeCourses ()

	changeDeadline ()

	changeDeadlineMulti ()

	changeExpireDate ()

	changeExpireDateMulti ()

	removeUser ()

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

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

	updateCertificate ()

	updateCertificateMulti ()

	confirmedUpdateCertificate ()

	removeCertificate ()

	removeCertificateMulti ()

	confirmedRemovalOfCertificate ()

Data Fields
const	ACTION_MARK_ACCREDITED = "mark_accredited"

const	ACTION_UNMARK_ACCREDITED = "unmark_accredited"

const	ACTION_SHOW_INDIVIDUAL_PLAN = "show_individual_plan"

const	ACTION_REMOVE_USER = "remove_user"

const	ACTION_CHANGE_DEADLINE = "change_deadline"

const	ACTION_MARK_RELEVANT = "mark_relevant"

const	ACTION_UNMARK_RELEVANT = "unmark_relevant"

const	ACTION_UPDATE_FROM_CURRENT_PLAN = "update_from_current_plan"

const	ACTION_CHANGE_EXPIRE_DATE = "change_expire_date"

const	ACTION_UPDATE_CERTIFICATE = "update_certificate"

const	ACTION_ACKNOWLEDGE_COURSES = "acknowledge_completed_courses"

const	ACTION_REMOVE_CERTIFICATE = "remove_certificate"

const	F_COMMAND_OPTION_ALL = 'select_cmd_all'

const	F_ALL_PROGRESS_IDS = 'all_progress_ids'

const	F_SELECTED_PROGRESS_IDS = 'prgs_ids'

const	F_SELECTED_USER_IDS = 'usrids'

Protected Member Functions
	getDefaultCommand ()

	getAssignmentsById ()

	getMembersTableGUI ()

	getPostPrgsIds ()

	getGetPrgsIds ()

	getPrgrsId ()

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

	getAddableUsers (array $users)

	markAccredited ()

	markAccreditedMulti ()

	markAccreditedByProgressId (PRGProgressId $prgrs_id, ilPRGMessageCollection $msgs)

	unmarkAccredited ()

	unmarkAccreditedByProgressId (PRGProgressId $prgrs_id, ilPRGMessageCollection $msgs)

	getAssignmentsFromQuery ()

	removeUserMulti ()

	confirmRemoveUsers (array $progress_ids)

	confirmedRemoveUsers ()

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

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

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

	initSearchGUI ()

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

	mayCurrentUserEditProgressForUser (int $usr_id)

	getMessageCollection (string $topic)

	showMessages (ilPRGMessageCollection $msg)

	mailToSelectedUsers ()

	deliverCertificate (int $obj_id, int $usr_id)

Protected Attributes
ilObjStudyProgramme	$object

ilPRGPermissionsHelper	$permissions

ilObjectGUI	$parent_gui

int	$ref_id

Private Attributes
const	DEFAULT_CMD = "view"

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References ilLanguage\loadLanguageModule(), and ILIAS\Repository\toolbar().

       {
         $this->object = null;
         $this->permissions = null;
 
         $lng->loadLanguageModule("prg");
         $this->toolbar->setPreventDoubleSubmission(true);
     }

Here is the call graph for this function:

Member Function Documentation

◆ acknowledgeCourses()

ilObjStudyProgrammeMembersGUI::acknowledgeCourses ( )

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

References getPrgrsId(), and viewCompletedCourses().

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

Here is the call graph for this function:

◆ acknowledgeCoursesMulti()

ilObjStudyProgrammeMembersGUI::acknowledgeCoursesMulti ( )

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

References getPostPrgsIds(), and viewCompletedCourses().

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

Here is the call graph for this function:

◆ addUsers()

ilObjStudyProgrammeMembersGUI::addUsers ( array $user_ids )

Assigns a users to SP.

Parameters

string[] $user_ids

Returns: bool|void

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

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

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

Here is the call graph for this function:

◆ applyFilter()

ilObjStudyProgrammeMembersGUI::applyFilter ( )

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

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

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

Here is the call graph for this function:

◆ changeDeadline()

ilObjStudyProgrammeMembersGUI::changeDeadline ( )

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

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

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

Here is the call graph for this function:

◆ changeDeadlineMulti()

ilObjStudyProgrammeMembersGUI::changeDeadlineMulti ( )

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

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

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

Here is the call graph for this function:

◆ changeExpireDate()

ilObjStudyProgrammeMembersGUI::changeExpireDate ( )

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

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

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

Here is the call graph for this function:

◆ changeExpireDateMulti()

ilObjStudyProgrammeMembersGUI::changeExpireDateMulti ( )

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

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

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

Here is the call graph for this function:

◆ confirmedAcknowledgeAllCourses()

ilObjStudyProgrammeMembersGUI::confirmedAcknowledgeAllCourses ( )

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

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

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedAcknowledgeCourses()

ilObjStudyProgrammeMembersGUI::confirmedAcknowledgeCourses ( )

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

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

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedRemovalOfCertificate()

ilObjStudyProgrammeMembersGUI::confirmedRemovalOfCertificate ( )

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

References ILIAS\Repository\ctrl(), getMessageCollection(), getPostPrgsIds(), mayCurrentUserEditProgressForUser(), removeCertificateForUser(), showInfoMessage(), and showSuccessMessage().

Referenced by executeCommand().

                                                    : void
     {
         $msgs = $this->getMessageCollection('msg_remove_certificate');
         $pgs_ids = $this->getPostPrgsIds();
         foreach ($pgs_ids as $idx => $prgs_id) {
             if (!$this->mayCurrentUserEditProgressForUser($prgs_id->getUsrId())) {
                 $this->showInfoMessage("no_permission_to_remove_certificate");
             } else {
                 $this->removeCertificateForUser(
                     $prgs_id->getNodeId(),
                     $prgs_id->getUsrId(),
                 );
             }
         }
         $this->showSuccessMessage("successfully_removed_certificate");
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedRemoveUsers()

ilObjStudyProgrammeMembersGUI::confirmedRemoveUsers ( )

protected

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

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

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedUpdateCertificate()

ilObjStudyProgrammeMembersGUI::confirmedUpdateCertificate ( )

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

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

Referenced by executeCommand().

                                                 : void
     {
         $msgs = $this->getMessageCollection('msg_update_certificate');
         foreach ($this->getPostPrgsIds() as $idx => $prgs_id) {
             if (!$this->mayCurrentUserEditProgressForUser($prgs_id->getUsrId())) {
                 $this->showInfoMessage("no_permission_to_update_certificate");
             } else {
 
                 $assignment = $this->assignment_db->get($prgs_id->getAssignmentId());
                 $progress = $assignment->getProgressForNode($prgs_id->getNodeId());
                 if (!$progress->isSuccessful()) {
                     $msgs->add(false, 'will_not_update_cert_for_unsuccessful_progress', (string) $prgs_id);
                     continue;
                 }
 
                 if ($this->updateCertificateForPrg(
                     $prgs_id->getNodeId(),
                     $prgs_id->getUsrId()
                 )) {
                     $msgs->add(true, '', (string) $prgs_id);
                 } else {
                     $msgs->add(false, 'error_updating_certificate', (string) $prgs_id);
                 }
             }
         }
         $this->showMessages($msgs);
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedUpdateFromCurrentPlan()

ilObjStudyProgrammeMembersGUI::confirmedUpdateFromCurrentPlan ( )

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

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

Referenced by executeCommand().

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

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

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

Referenced by removeUser(), and removeUserMulti().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverCertificate()

ilObjStudyProgrammeMembersGUI::deliverCertificate	(	int	$obj_id,
		int	$usr_id
	)

protected

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

References ilCertificatePdfAction\downloadPdf(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                                                    : void
     {
         $repository = new ilUserCertificateRepository();
         $pdf_action = new ilCertificatePdfAction(
             new ilPdfGenerator($repository),
             new ilCertificateUtilHelper(),
             $this->lng->txt('error_creating_certificate_pdf')
         );
         $pdf_action->downloadPdf($usr_id, $obj_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjStudyProgrammeMembersGUI::executeCommand ( )

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

References $dic, confirmedAcknowledgeAllCourses(), confirmedAcknowledgeCourses(), confirmedRemovalOfCertificate(), confirmedRemoveUsers(), confirmedUpdateCertificate(), confirmedUpdateFromCurrentPlan(), ILIAS\Repository\ctrl(), deliverCertificate(), ilStudyProgrammeDIC\dic(), getAssignmentsById(), getDefaultCommand(), getGetPrgsIds(), ILIAS\Repository\lng(), mailToSelectedUsers(), markNotRelevant(), ILIAS\Repository\object(), ilOrgUnitOperation\OP_MANAGE_MEMBERS, ILIAS\Repository\refinery(), ilStudyProgrammeDIC\specificDicFor(), and ILIAS\Repository\tabs().

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
         $next_class = $this->ctrl->getNextClass($this);
 
         if ($cmd === "" || $cmd === null) {
             $cmd = $this->getDefaultCommand();
         }
 
         switch ($next_class) {
             case "ilstudyprogrammerepositorysearchgui":
                 $this->repository_search_gui->setCallback($this, "addUsers");
                 $this->ctrl->setReturn($this, "view");
                 $this->ctrl->forwardCommand($this->repository_search_gui);
                 break;
             case "ilobjstudyprogrammeindividualplangui":
                 $this->individual_plan_gui->setParentGUI($this);
                 $this->individual_plan_gui->setRefId($this->ref_id);
                 $this->ctrl->forwardCommand($this->individual_plan_gui);
                 break;
             case "ilstudyprogrammemailmembersearchgui":
                 $this->tabs->clearTargets();
                 $this->tabs->setBackTarget(
                     $this->lng->txt('btn_back'),
                     $this->ctrl->getLinkTarget($this, $this->getDefaultCommand())
                 );
                 $dic = ilStudyProgrammeDIC::specificDicFor($this->object);
                 $mail_search = $dic['ilStudyProgrammeMailMemberSearchGUI'];
                 $mail_search->setAssignments($this->getAssignmentsById());
                 $mail_search->setBackTarget(
                     $this->ctrl->getLinkTarget($this, $this->getDefaultCommand())
                 );
                 $this->ctrl->forwardCommand($mail_search);
                 break;
             case "ilstudyprogrammechangeexpiredategui":
                 $this->tabs->clearTargets();
                 $this->tabs->setBackTarget(
                     $this->lng->txt('btn_back'),
                     $this->ctrl->getLinkTarget($this, $this->getDefaultCommand())
                 );
                 $dic = ilStudyProgrammeDIC::dic();
                 $gui = $dic['ilStudyProgrammeChangeExpireDateGUI'];
                 $gui->setRefId($this->ref_id);
                 $gui->setProgressIds($this->getGetPrgsIds());
                 $this->ctrl->forwardCommand($gui);
                 break;
             case "ilstudyprogrammechangedeadlinegui":
                 $this->tabs->clearTargets();
                 $this->tabs->setBackTarget(
                     $this->lng->txt('btn_back'),
                     $this->ctrl->getLinkTarget($this, $this->getDefaultCommand())
                 );
                 $dic = ilStudyProgrammeDIC::dic();
                 $gui = $dic['ilStudyProgrammeChangeDeadlineGUI'];
                 $gui->setRefId($this->ref_id);
                 $gui->setProgressIds($this->getGetPrgsIds());
                 $this->ctrl->forwardCommand($gui);
                 break;
             case false:
                 switch ($cmd) {
                     case "view":
                     case "markAccredited":
                     case "markAccreditedMulti":
                     case "unmarkAccredited":
                     case "unmarkAccreditedMulti":
                     case "removeUser":
                     case "removeUserMulti":
                     case "markNotRelevantMulti":
                     case "markRelevant":
                     case "markRelevantMulti":
                     case "updateFromCurrentPlan":
                     case "updateFromCurrentPlanMulti":
                     case "acknowledgeCourses":
                     case "acknowledgeCoursesMulti":
                     case "applyFilter":
                     case "resetFilter":
                     case "changeDeadline":
                     case "changeDeadlineMulti":
                     case "changeExpireDate":
                     case "changeExpireDateMulti":
                     case "updateCertificate":
                     case "updateCertificateMulti":
                     case "removeCertificate":
                     case "removeCertificateMulti":
                         $cont = $this->$cmd();
                         $this->tpl->setContent($cont);
                         break;
                     case "confirmedRemoveUsers":
                         $this->confirmedRemoveUsers();
                         break;
                     case "confirmedUpdateFromCurrentPlan":
                         $this->confirmedUpdateFromCurrentPlan();
                         break;
                     case "confirmedAcknowledgeCourses":
                         $this->confirmedAcknowledgeCourses();
                         break;
                     case "confirmedAcknowledgeAllCourses":
                         $this->confirmedAcknowledgeAllCourses();
                         break;
                     case "mailUserMulti":
                         $this->mailToSelectedUsers();
                         break;
                     case "markNotRelevant":
                         $this->markNotRelevant();
                         break;
                     case "confirmedUpdateCertificate":
                         $this->confirmedUpdateCertificate();
                         break;
                     case "confirmedRemovalOfCertificate":
                         $this->confirmedRemovalOfCertificate();
                         break;
                     case "deliverCertificate":
                         if (!$this->permissions->may(ilOrgUnitOperation::OP_MANAGE_MEMBERS)) {
                             $this->tpl->setOnScreenMessage("failure", $this->lng->txt("permission_denied"), true);
                             $this->ctrl->redirect($this, "view");
                         }
                         $usr_id = $this->http_wrapper->query()->retrieve(
                             'cert_usr_id',
                             $this->refinery->kindlyTo()->int()
                         );
                         $this->deliverCertificate($this->object->getId(), $usr_id);
                         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

Parameters

int[] $users

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

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

Referenced by addUsers().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsById()

ilObjStudyProgrammeMembersGUI::getAssignmentsById ( )

protected

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

References ILIAS\Repository\object().

Referenced by executeCommand(), and mailToSelectedUsers().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsFromQuery()

ilObjStudyProgrammeMembersGUI::getAssignmentsFromQuery ( )

protected

Returns: ilPRGAssignment[]

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

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

Referenced by confirmedAcknowledgeAllCourses(), and confirmedAcknowledgeCourses().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultCommand()

ilObjStudyProgrammeMembersGUI::getDefaultCommand ( )

protected

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

Referenced by executeCommand(), and mailToSelectedUsers().

                                           : string
     {
         return self::DEFAULT_CMD;
     }

Here is the caller graph for this function:

◆ getGetPrgsIds()

ilObjStudyProgrammeMembersGUI::getGetPrgsIds ( )

protected

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

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

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLinkTargetForAction()

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

Get the link target for an action on user progress.

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

References ILIAS\Repository\ctrl().

                                                                                          : string
     {
         switch ($action) {
             case self::ACTION_MARK_ACCREDITED:
                 $target_name = "markAccredited";
                 break;
             case self::ACTION_UNMARK_ACCREDITED:
                 $target_name = "unmarkAccredited";
                 break;
             case self::ACTION_SHOW_INDIVIDUAL_PLAN:
                 return $this->individual_plan_gui->getLinkTargetView($ass_id);
             case self::ACTION_REMOVE_USER:
                 $target_name = "removeUser";
                 break;
             case self::ACTION_UNMARK_RELEVANT:
                 $target_name = "markNotRelevant";
                 break;
             case self::ACTION_MARK_RELEVANT:
                 $target_name = "markRelevant";
                 break;
             case self::ACTION_UPDATE_FROM_CURRENT_PLAN:
                 $target_name = "updateFromCurrentPlan";
                 break;
             case self::ACTION_ACKNOWLEDGE_COURSES:
                 $target_name = "acknowledgeCourses";
                 break;
             case self::ACTION_CHANGE_DEADLINE:
                 $target_name = "changeDeadline";
                 break;
             case self::ACTION_CHANGE_EXPIRE_DATE:
                 $target_name = "changeExpireDate";
                 break;
             case self::ACTION_UPDATE_CERTIFICATE:
                 $target_name = "updateCertificate";
                 break;
             case self::ACTION_REMOVE_CERTIFICATE:
                 $target_name = "removeCertificate";
                 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;
     }

Here is the call graph for this function:

◆ getMembersTableGUI()

ilObjStudyProgrammeMembersGUI::getMembersTableGUI ( )

protected

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

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

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

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

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

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

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

Here is the caller graph for this function:

◆ getPostPrgsIds()

ilObjStudyProgrammeMembersGUI::getPostPrgsIds ( )

protected

Returns: PRGProgressId[]

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPrgrsId()

ilObjStudyProgrammeMembersGUI::getPrgrsId ( )

protected

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

References $_GET, and PRGProgressId\createFromString().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStudyProgramme()

ilObjStudyProgrammeMembersGUI::getStudyProgramme ( int $ref_id = null )

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

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

References $ref_id, and ilObjStudyProgramme\getInstanceByRefId().

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

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

References ilToolbarGUI\addComponent(), ilToolbarGUI\addSeparator(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by view().

                                                                                              : void
     {
         if ($separator) {
             $toolbar->addSeparator();
         }
 
         $toolbar->addComponent(
             $this->ui_factory->link()->standard(
                 $this->lng->txt('mail_assignments'),
                 $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 917 of file class.ilObjStudyProgrammeMembersGUI.php.

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

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:

◆ mailToSelectedUsers()

ilObjStudyProgrammeMembersGUI::mailToSelectedUsers ( )

protected

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

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

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markAccredited()

ilObjStudyProgrammeMembersGUI::markAccredited ( )

protected

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

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

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

Here is the call graph for this function:

◆ markAccreditedByProgressId()

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

protected

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

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

Referenced by markAccredited(), and markAccreditedMulti().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markAccreditedMulti()

ilObjStudyProgrammeMembersGUI::markAccreditedMulti ( )

protected

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

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

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

Here is the call graph for this function:

◆ markNotRelevant()

ilObjStudyProgrammeMembersGUI::markNotRelevant ( )

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

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

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markNotRelevantMulti()

ilObjStudyProgrammeMembersGUI::markNotRelevantMulti ( )

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

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

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

Here is the call graph for this function:

◆ markRelevant()

ilObjStudyProgrammeMembersGUI::markRelevant ( )

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

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

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

Here is the call graph for this function:

◆ markRelevantMulti()

ilObjStudyProgrammeMembersGUI::markRelevantMulti ( )

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

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

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

Here is the call graph for this function:

◆ mayCurrentUserEditProgressForUser()

ilObjStudyProgrammeMembersGUI::mayCurrentUserEditProgressForUser ( int $usr_id )

protected

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

References ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN.

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

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

Here is the caller graph for this function:

◆ removeAssignment()

ilObjStudyProgrammeMembersGUI::removeAssignment ( PRGProgressId $pgs_id )

protected

Remove user.

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

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

Referenced by confirmedRemoveUsers().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeCertificate()

ilObjStudyProgrammeMembersGUI::removeCertificate ( )

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

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

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

Here is the call graph for this function:

◆ removeCertificateMulti()

ilObjStudyProgrammeMembersGUI::removeCertificateMulti ( )

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

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

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

Here is the call graph for this function:

◆ removeUser()

ilObjStudyProgrammeMembersGUI::removeUser ( )

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

References confirmRemoveUsers(), and getPrgrsId().

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

Here is the call graph for this function:

◆ removeUserMulti()

ilObjStudyProgrammeMembersGUI::removeUserMulti ( )

protected

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

References confirmRemoveUsers(), and getPostPrgsIds().

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

Here is the call graph for this function:

◆ resetFilter()

ilObjStudyProgrammeMembersGUI::resetFilter ( )

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

References ILIAS\Repository\ctrl(), and 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 89 of file class.ilObjStudyProgrammeMembersGUI.php.

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

◆ setRefId()

ilObjStudyProgrammeMembersGUI::setRefId ( int $ref_id )

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

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

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

Here is the call graph for this function:

◆ showInfoMessage()

ilObjStudyProgrammeMembersGUI::showInfoMessage ( string $lng_var )

protected

Shows ilUtil failed message.

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

References ILIAS\Repository\lng().

Referenced by confirmedRemovalOfCertificate(), confirmedRemoveUsers(), confirmedUpdateCertificate(), and getPostPrgsIds().

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

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

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

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

Here is the caller graph for this function:

◆ showSuccessMessage()

ilObjStudyProgrammeMembersGUI::showSuccessMessage ( string $lng_var )

protected

Shows ilUtil success message.

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

References ILIAS\Repository\lng().

Referenced by confirmedRemovalOfCertificate(), and confirmedRemoveUsers().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unmarkAccredited()

ilObjStudyProgrammeMembersGUI::unmarkAccredited ( )

protected

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

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

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

Here is the call graph for this function:

◆ unmarkAccreditedByProgressId()

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

protected

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

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

Referenced by unmarkAccredited(), and unmarkAccreditedMulti().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unmarkAccreditedMulti()

ilObjStudyProgrammeMembersGUI::unmarkAccreditedMulti ( )

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

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

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

Here is the call graph for this function:

◆ updateCertificate()

ilObjStudyProgrammeMembersGUI::updateCertificate ( )

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

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

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

Here is the call graph for this function:

◆ updateCertificateMulti()

ilObjStudyProgrammeMembersGUI::updateCertificateMulti ( )

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

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

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

Here is the call graph for this function:

◆ updateFromCurrentPlan()

ilObjStudyProgrammeMembersGUI::updateFromCurrentPlan ( )

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

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

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

Here is the call graph for this function:

◆ updateFromCurrentPlanMulti()

ilObjStudyProgrammeMembersGUI::updateFromCurrentPlanMulti ( )

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

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

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

Here is the call graph for this function:

◆ view()

ilObjStudyProgrammeMembersGUI::view ( )

protected

Shows table with all members of the SP.

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

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

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

Here is the call graph for this function:

◆ viewCompletedCourses()

ilObjStudyProgrammeMembersGUI::viewCompletedCourses ( array $assignments )

Shows list of completed courses for each assignment.

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

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

Referenced by acknowledgeCourses(), acknowledgeCoursesMulti(), and confirmedAcknowledgeCourses().

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