Collaboration diagram for ilObjStudyProgrammeIndividualPlanGUI:

Public Member Functions
	__construct (ilGlobalTemplateInterface $tpl, ilCtrl $ilCtrl, ilLanguage $lng, ilObjUser $ilUser, ilPRGAssignmentDBRepository $assignment_repository, ilPRGMessagePrinter $messages, ILIAS\HTTP\Wrapper\WrapperFactory $http_wrapper, ILIAS\Refinery\Factory $refinery)

	setParentGUI (ilObjStudyProgrammeMembersGUI $parent_gui)

	setRefId (int $ref_id)

	executeCommand ()

	appendIndividualPlanActions (ilTable2GUI $table)

	getLinkTargetView (int $ass_id)

Data Fields
const	POST_VAR_STATUS = "status"

const	POST_VAR_REQUIRED_POINTS = "required_points"

const	POST_VAR_DEADLINE = "deadline"

const	MANUAL_STATUS_NONE = -1

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilObjUser	$user

ilObjStudyProgramme	$object

Protected Member Functions
	getAssignmentId ()

	getAssignmentObject ()

	view ()

	manage ()

	updateFromCurrentPlan ()

	updateFromInput ()

	updateStatus (array $progress_updates, ilPRGMessageCollection $msgs)

	updateDeadlines (array $deadlines, ilPRGMessageCollection $msgs)

	updateRequiredPoints (array $required_points, ilPRGMessageCollection $msgs)

	showSuccessMessage (string $lng_var)

	buildFrame (string $tab, string $content)

	getLinkTargetForSubTab (string $tab, int $ass_id)

Protected Attributes
ilPRGAssignmentDBRepository	$assignment_repository

ilPRGMessagePrinter	$messages

ILIAS HTTP Wrapper WrapperFactory	$http_wrapper

ILIAS Refinery Factory	$refinery

ilPRGAssignment	$assignment_object

ilPRGPermissionsHelper	$permissions

ilObjStudyProgrammeMembersGUI	$parent_gui

int	$ref_id

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeIndividualPlanGUI::__construct	(	ilGlobalTemplateInterface	$tpl,
		ilCtrl	$ilCtrl,
		ilLanguage	$lng,
		ilObjUser	$ilUser,
		ilPRGAssignmentDBRepository	$assignment_repository,
		ilPRGMessagePrinter	$messages,
		ILIAS\HTTP\Wrapper\WrapperFactory	$http_wrapper,
		ILIAS\Refinery\Factory	$refinery
	)

Definition at line 43 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $assignment_repository, $http_wrapper, $lng, $messages, $refinery, $tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), null, ILIAS\Repository\refinery(), and ILIAS\Repository\user().

       {
         $this->tpl = $tpl;
         $this->ctrl = $ilCtrl;
         $this->lng = $lng;
         $this->user = $ilUser;
         $this->assignment_object = null;
         $this->assignment_repository = $assignment_repository;
         $this->messages = $messages;
         $this->http_wrapper = $http_wrapper;
         $this->refinery = $refinery;
         $this->object = null;
         $this->permissions = null;
 
         $lng->loadLanguageModule("prg");
 
         $this->tpl->addCss("assets/css/ilStudyProgramme.css");
     }

Here is the call graph for this function:

Member Function Documentation

◆ appendIndividualPlanActions()

ilObjStudyProgrammeIndividualPlanGUI::appendIndividualPlanActions ( ilTable2GUI $table )

Definition at line 324 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References ilTable2GUI\addCommandButton(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilTable2GUI\setFormAction().

                                                                    : void
     {
         $table->setFormAction($this->ctrl->getFormAction($this));
         $table->addCommandButton("updateFromCurrentPlan", $this->lng->txt("prg_update_from_current_plan"));
         $table->addCommandButton("updateFromInput", $this->lng->txt("save"));
     }

Here is the call graph for this function:

◆ buildFrame()

ilObjStudyProgrammeIndividualPlanGUI::buildFrame	(	string	$tab,
		string	$content
	)

protected

Definition at line 289 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $user_id, ilObjUser\_lookupFullname(), ILIAS\UICore\GlobalTemplate\get(), getAssignmentObject(), getLinkTargetForSubTab(), ILIAS\Repository\lng(), ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN, ilOrgUnitOperation\OP_VIEW_INDIVIDUAL_PLAN, ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), and ILIAS\UICore\GlobalTemplate\setVariable().

Referenced by manage(), and view().

                                                                : string
     {
         $tabs = [];
         if ($this->permissions->may(ilOrgUnitOperation::OP_VIEW_INDIVIDUAL_PLAN)) {
             $tabs[] = 'view';
         }
         if ($this->permissions->may(ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN)) {
             $tabs[] = 'manage';
         }
 
         $tpl = new ilTemplate("tpl.indivdual_plan_frame.html", true, true, "components/ILIAS/StudyProgramme");
         $ass = $this->getAssignmentObject();
         $user_id = $ass->getUserId();
         $tpl->setVariable("USERNAME", ilObjUser::_lookupFullname($user_id));
 
         foreach ($tabs as $_tab) {
             $tpl->setCurrentBlock("sub_tab");
             $tpl->setVariable("CLASS", $_tab === $tab ? "active" : "");
             $tpl->setVariable("LINK", $this->getLinkTargetForSubTab($_tab, $ass->getId()));
             $tpl->setVariable("TITLE", $this->lng->txt("prg_$_tab"));
             $tpl->parseCurrentBlock();
         }
         $tpl->setVariable("CONTENT", $content);
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjStudyProgrammeIndividualPlanGUI::executeCommand ( )

Definition at line 82 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

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

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
 
         if ($cmd === "" || $cmd === null) {
             $cmd = "view";
         }
 
         switch ($cmd) {
             case "view":
             case "manage":
             case "updateFromCurrentPlan":
             case "updateFromInput":
                 $cont = $this->$cmd();
                 break;
             default:
                 throw new ilException("ilObjStudyProgrammeMembersGUI: Command not supported: $cmd");
         }
 
         $this->tpl->setContent($cont);
     }

Here is the call graph for this function:

◆ getAssignmentId()

ilObjStudyProgrammeIndividualPlanGUI::getAssignmentId ( )

protected

Definition at line 104 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References ILIAS\Repository\refinery().

Referenced by getAssignmentObject(), and updateFromInput().

                                         : int
     {
         return $this->http_wrapper->query()->retrieve("ass_id", $this->refinery->kindlyTo()->int());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentObject()

ilObjStudyProgrammeIndividualPlanGUI::getAssignmentObject ( )

protected

Definition at line 109 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $assignment_object, $id, getAssignmentId(), and null.

Referenced by buildFrame(), manage(), updateDeadlines(), updateFromCurrentPlan(), updateRequiredPoints(), updateStatus(), and view().

                                             : ilPRGAssignment
     {
         if ($this->assignment_object === null) {
             $id = $this->getAssignmentId();
             $this->assignment_object = $this->assignment_repository->get((int) $id);
         }
         return $this->assignment_object;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLinkTargetForSubTab()

ilObjStudyProgrammeIndividualPlanGUI::getLinkTargetForSubTab	(	string	$tab,
		int	$ass_id
	)

protected

Definition at line 316 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

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

Referenced by buildFrame().

                                                                        : string
     {
         $this->ctrl->setParameter($this, "ass_id", $ass_id);
         $lnk = $this->ctrl->getLinkTarget($this, $tab);
         $this->ctrl->setParameter($this, "ass_id", null);
         return $lnk;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLinkTargetView()

ilObjStudyProgrammeIndividualPlanGUI::getLinkTargetView ( int $ass_id )

Definition at line 331 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

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

                                                   : string
     {
         $cl = "ilObjStudyProgrammeIndividualPlanGUI";
         $this->ctrl->setParameterByClass($cl, "ass_id", $ass_id);
         $link = $this->ctrl->getLinkTargetByClass($cl, "view");
         $this->ctrl->setParameterByClass($cl, "ass_id", null);
         return $link;
     }

Here is the call graph for this function:

◆ manage()

ilObjStudyProgrammeIndividualPlanGUI::manage ( )

protected

Definition at line 139 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References buildFrame(), ILIAS\Repository\ctrl(), getAssignmentObject(), null, and ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN.

                                : string
     {
         $ass = $this->getAssignmentObject();
 
         if (!in_array(
             $ass->getUserId(),
             $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN)
         )) {
             throw new ilStudyProgrammePositionBasedAccessViolationException(
                 "may not access individual plan of user"
             );
         }
 
         $this->ctrl->setParameter($this, "ass_id", $ass->getId());
         $table = new ilStudyProgrammeIndividualPlanTableGUI($this, $ass);
         $frame = $this->buildFrame("manage", $table->getHTML());
         $this->ctrl->setParameter($this, "ass_id", null);
         return $frame;
     }

Here is the call graph for this function:

◆ setParentGUI()

ilObjStudyProgrammeIndividualPlanGUI::setParentGUI ( ilObjStudyProgrammeMembersGUI $parent_gui )

Definition at line 70 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $parent_gui.

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

◆ setRefId()

ilObjStudyProgrammeIndividualPlanGUI::setRefId ( int $ref_id )

Definition at line 75 of file class.ilObjStudyProgrammeIndividualPlanGUI.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:

◆ showSuccessMessage()

ilObjStudyProgrammeIndividualPlanGUI::showSuccessMessage ( string $lng_var )

protected

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

References ILIAS\Repository\lng().

Referenced by updateFromCurrentPlan().

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

◆ updateDeadlines()

ilObjStudyProgrammeIndividualPlanGUI::updateDeadlines	(	array	$deadlines,
		ilPRGMessageCollection	$msgs
	)

protected

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

References getAssignmentObject(), ilObjStudyProgramme\getInstanceByObjId(), ILIAS\Repository\int(), null, and ILIAS\Repository\user().

Referenced by updateFromInput().

                                                                                       : void
     {
         $ass = $this->getAssignmentObject();
         $acting_user_id = (int) $this->user->getId();
 
         foreach ($deadlines as $progress_id => $deadline) {
             $programme = ilObjStudyProgramme::getInstanceByObjId($progress_id);
             $progress = $ass->getProgressForNode($progress_id);
 
             if (trim($deadline) === '') {
                 $deadline = null;
             } else {
                 $deadline = DateTimeImmutable::createFromFormat('Y-m-d', $deadline);
             }
 
             $cur_deadline = $progress->getDeadline();
             if ($deadline != $cur_deadline) {
                 $programme->changeProgressDeadline($ass->getId(), $acting_user_id, $msgs, $deadline);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateFromCurrentPlan()

ilObjStudyProgrammeIndividualPlanGUI::updateFromCurrentPlan ( )

protected

Definition at line 159 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References ILIAS\Repository\ctrl(), getAssignmentObject(), ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN, showSuccessMessage(), and ILIAS\Repository\user().

                                               : void
     {
         $ass = $this->getAssignmentObject();
 
         if (!in_array(
             $ass->getUserId(),
             $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN)
         )) {
             throw new ilStudyProgrammePositionBasedAccessViolationException(
                 "may not access individual plan of user"
             );
         }
         $msgs = $this->messages->getMessageCollection('msg_update_individual_plan');
         $this->object->updatePlanFromRepository(
             $ass->getId(),
             $this->user->getId(),
             $msgs
         );
 
         $this->ctrl->setParameter($this, "ass_id", $ass->getId());
         $this->showSuccessMessage("update_from_plan_successful");
         $this->ctrl->redirect($this, "manage");
     }

Here is the call graph for this function:

◆ updateFromInput()

ilObjStudyProgrammeIndividualPlanGUI::updateFromInput ( )

protected

Definition at line 183 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References ILIAS\Repository\ctrl(), getAssignmentId(), ILIAS\Repository\refinery(), updateDeadlines(), updateRequiredPoints(), and updateStatus().

                                         : void
     {
         $retrieve = $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->string());
 
         $msgs = $this->messages->getMessageCollection('msg_update_individual_plan');
         if ($this->http_wrapper->post()->has(self::POST_VAR_DEADLINE)) {
             $this->updateDeadlines($this->http_wrapper->post()->retrieve(self::POST_VAR_DEADLINE, $retrieve), $msgs);
         }
         $this->updateStatus($this->http_wrapper->post()->retrieve(self::POST_VAR_STATUS, $retrieve), $msgs);
         if ($this->http_wrapper->post()->has(self::POST_VAR_REQUIRED_POINTS)) {
             $this->updateRequiredPoints($this->http_wrapper->post()->retrieve(self::POST_VAR_REQUIRED_POINTS, $retrieve), $msgs);
         }
 
         if ($msgs->hasAnyMessages()) {
             $this->messages->showMessages($msgs);
         }
 
         $this->ctrl->setParameter($this, "ass_id", $this->getAssignmentId());
         $this->ctrl->redirect($this, "manage");
     }

Here is the call graph for this function:

◆ updateRequiredPoints()

ilObjStudyProgrammeIndividualPlanGUI::updateRequiredPoints	(	array	$required_points,
		ilPRGMessageCollection	$msgs
	)

protected

Definition at line 262 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References ilPRGMessageCollection\add(), getAssignmentObject(), ilObjStudyProgramme\getInstanceByObjId(), ILIAS\Repository\int(), and ILIAS\Repository\user().

Referenced by updateFromInput().

                                                                                                  : void
     {
         $ass = $this->getAssignmentObject();
         $acting_user_id = (int) $this->user->getId();
 
         foreach ($required_points as $progress_id => $points) {
             $points = (int) $points;
 
             if ($points < 0) {
                 $msgs->add(false, 'msg_points_must_be_positive', $progress_id);
                 continue;
             }
             $programme = ilObjStudyProgramme::getInstanceByObjId($progress_id);
             $progress = $ass->getProgressForNode($progress_id);
             $cur_points = $progress->getAmountOfPoints();
 
             if ($points != $cur_points) {
                 $programme->changeAmountOfPoints($ass->getId(), $acting_user_id, $msgs, $points);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateStatus()

ilObjStudyProgrammeIndividualPlanGUI::updateStatus	(	array	$progress_updates,
		ilPRGMessageCollection	$msgs
	)

protected

Definition at line 204 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References ilPRGMessageCollection\add(), getAssignmentObject(), ilObjStudyProgramme\getInstanceByObjId(), ILIAS\Repository\int(), ilPRGProgress\STATUS_ACCREDITED, ilPRGProgress\STATUS_IN_PROGRESS, ilPRGProgress\STATUS_NOT_RELEVANT, and ILIAS\Repository\user().

Referenced by updateFromInput().

                                                                                           : void
     {
         $ass = $this->getAssignmentObject();
         $acting_user_id = (int) $this->user->getId();
 
         foreach ($progress_updates as $progress_id => $target_status) {
             $programme = ilObjStudyProgramme::getInstanceByObjId($progress_id);
             $progress = $ass->getProgressForNode($progress_id);
             switch ($target_status) {
                 case ilPRGProgress::STATUS_IN_PROGRESS:
                     $cur_status = $progress->getStatus();
                     if ($cur_status == ilPRGProgress::STATUS_ACCREDITED) {
                         $programme->unmarkAccredited($ass->getId(), $acting_user_id, $msgs);
                     }
                     if ($cur_status == ilPRGProgress::STATUS_NOT_RELEVANT) {
                         $programme->markRelevant($ass->getId(), $acting_user_id, $msgs);
                     }
                     break;
 
                 case ilPRGProgress::STATUS_ACCREDITED:
                     $programme->markAccredited($ass->getId(), $acting_user_id, $msgs);
                     break;
 
                 case ilPRGProgress::STATUS_NOT_RELEVANT:
                     $programme->markNotRelevant($ass->getId(), $acting_user_id, $msgs);
                     break;
 
                 case self::MANUAL_STATUS_NONE:
                     break;
 
                 default:
                     $msgs->add(false, 'msg_impossible_target_status', $progress_id);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ view()

ilObjStudyProgrammeIndividualPlanGUI::view ( )

protected

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

References buildFrame(), ILIAS\UICore\GlobalTemplate\get(), getAssignmentObject(), ilOrgUnitOperation\OP_VIEW_INDIVIDUAL_PLAN, and ILIAS\UICore\GlobalTemplate\setVariable().

                              : string
     {
         $ass = $this->getAssignmentObject();
 
         if (!in_array(
             $ass->getUserId(),
             $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_VIEW_INDIVIDUAL_PLAN)
         )) {
             throw new ilStudyProgrammePositionBasedAccessViolationException(
                 "may not access individual plan of user"
             );
         }
         $progress = $ass->getProgressForNode($ass->getRootId());
         $gui = new ilStudyProgrammeIndividualPlanProgressListGUI($progress);
         $gui->setOnlyRelevant(true);
         // Wrap a frame around the original gui element to correct rendering.
         $tpl = new ilTemplate("tpl.individual_plan_tree_frame.html", false, false, "components/ILIAS/StudyProgramme");
         $tpl->setVariable("CONTENT", $gui->getHTML());
         return $this->buildFrame("view", $tpl->get());
     }