Class ilObjStudyProgrammeIndividualPlanGUI. More...

Collaboration diagram for ilObjStudyProgrammeIndividualPlanGUI:

Public Member Functions
	__construct (\ilGlobalTemplateInterface $tpl, \ilCtrl $ilCtrl, \ilLanguage $lng, \ilObjUser $ilUser, ilStudyProgrammeProgressRepository $progress_repository, ilStudyProgrammeAssignmentRepository $assignment_repository, ilPRGMessagePrinter $messages)

	setParentGUI ($a_parent_gui)

	setRefId (int $ref_id)

	executeCommand ()

	appendIndividualPlanActions (ilTable2GUI $a_table)

	getLinkTargetView ($a_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

	$ctrl

	$tpl

	$object

	$lng

	$user

Protected Member Functions
	getAssignmentId ()

	getAssignmentObject ()

	view ()

	manage ()

	updateFromCurrentPlan ()

	digestInput (array $post)

	updateFromInput ()

	updateStatus (array $progress_updates, ilPRGMessageCollection $msgs)

	updateDeadlines (array $deadlines, ilPRGMessageCollection $msgs)

	updateRequiredPoints (array $required_points, ilPRGMessageCollection $msgs)

	showSuccessMessage ($a_lng_var)

	buildFrame ($tab, $content)

	getLinkTargetForSubTab ($a_tab, $a_ass_id)

Protected Attributes
	$parent_gui

	$progress_repository

	$assignment_repository

	$messages

	$permissions

Detailed Description

Class ilObjStudyProgrammeIndividualPlanGUI.

Author: : Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

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

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeIndividualPlanGUI::__construct	(	\ilGlobalTemplateInterface	$tpl,
		\ilCtrl	$ilCtrl,
		\ilLanguage	$lng,
		\ilObjUser	$ilUser,
		ilStudyProgrammeProgressRepository	$progress_repository,
		ilStudyProgrammeAssignmentRepository	$assignment_repository,
		ilPRGMessagePrinter	$messages
	)

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

References $assignment_repository, $ilUser, $lng, $messages, $progress_repository, $tpl, ilLanguage\loadLanguageModule(), and user().

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

Here is the call graph for this function:

Member Function Documentation

◆ appendIndividualPlanActions()

ilObjStudyProgrammeIndividualPlanGUI::appendIndividualPlanActions ( ilTable2GUI $a_table )

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

References ilTable2GUI\addCommandButton(), and ilTable2GUI\setFormAction().

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

Here is the call graph for this function:

◆ buildFrame()

ilObjStudyProgrammeIndividualPlanGUI::buildFrame	(	$tab,
		$content
	)

protected

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

References $tpl, ilObjUser\_lookupFullname(), getAssignmentObject(), getLinkTargetForSubTab(), ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN, and ilOrgUnitOperation\OP_VIEW_INDIVIDUAL_PLAN.

Referenced by manage(), and view().

     {
         $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, "Modules/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:

◆ digestInput()

ilObjStudyProgrammeIndividualPlanGUI::digestInput ( array $post )

protected

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

References $ret.

Referenced by updateFromInput().

                                                 : array
     {
         $params = [
             self::POST_VAR_STATUS,
             self::POST_VAR_DEADLINE,
             self::POST_VAR_REQUIRED_POINTS
         ];
 
         $ret = [];
         foreach ($params as $postvar) {
             $ret[$postvar] = [];
             if (array_key_exists($postvar, $post)) {
                 $ret[$postvar] = $post[$postvar];
                 krsort($ret[$postvar], SORT_NUMERIC);
             }
         }
         return $ret;
     }

Here is the caller graph for this function:

◆ executeCommand()

ilObjStudyProgrammeIndividualPlanGUI::executeCommand ( )

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

     {
         $cmd = $this->ctrl->getCmd();
 
         if ($cmd == "") {
             $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);
     }

◆ getAssignmentId()

ilObjStudyProgrammeIndividualPlanGUI::getAssignmentId ( )

protected

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

References $_GET.

Referenced by getAssignmentObject(), and updateFromInput().

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

Here is the caller graph for this function:

◆ getAssignmentObject()

ilObjStudyProgrammeIndividualPlanGUI::getAssignmentObject ( )

protected

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

References getAssignmentId().

Referenced by buildFrame(), manage(), updateFromCurrentPlan(), and view().

     {
         if ($this->assignment_object === null) {
             $id = $this->getAssignmentId();
             $this->assignment_object = $this->assignment_repository->getInstanceById((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	(	$a_tab,
		$a_ass_id
	)

protected

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

Referenced by buildFrame().

     {
         $this->ctrl->setParameter($this, "ass_id", $a_ass_id);
         $lnk = $this->ctrl->getLinkTarget($this, $a_tab);
         $this->ctrl->setParameter($this, "ass_id", null);
         return $lnk;
     }

Here is the caller graph for this function:

◆ getLinkTargetView()

ilObjStudyProgrammeIndividualPlanGUI::getLinkTargetView ( $a_ass_id )

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

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

◆ manage()

ilObjStudyProgrammeIndividualPlanGUI::manage ( )

protected

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

References buildFrame(), getAssignmentObject(), and ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN.

     {
         $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());
         $this->ctrl->setParameter($this, "cmd", "manage");
         $table = new ilStudyProgrammeIndividualPlanTableGUI($this, $ass, $this->progress_repository);
         $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 ( $a_parent_gui )

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

     {
         $this->parent_gui = $a_parent_gui;
     }

◆ setRefId()

ilObjStudyProgrammeIndividualPlanGUI::setRefId ( int $ref_id )

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

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

                                           : void
     {
         $this->ref_id = $a_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 ( $a_lng_var )

protected

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

Referenced by updateFromCurrentPlan().

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

Here is the caller graph for this function:

◆ updateDeadlines()

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

protected

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

References user().

Referenced by updateFromInput().

     {
         $programme = $this->parent_gui->getStudyProgramme();
         $acting_user_id = (int) $this->user->getId();
 
         foreach ($deadlines as $progress_id => $deadline) {
             if (trim($deadline) === '') {
                 $deadline = null;
             } else {
                 $deadline = DateTimeImmutable::createFromFormat('d.m.Y', $deadline);
             }
             
             $progress = $this->progress_repository->get($progress_id);
             $cur_deadline = $progress->getDeadline();
 
             if ($deadline != $cur_deadline) {
                 $programme->changeProgressDeadline($progress_id, $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 192 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

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

     {
         $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"
             );
         }
 
         $prg = $this->parent_gui->getStudyProgramme();
         $progress = $prg->getProgressForAssignment($ass->getId());
         $msgs = $this->messages->getMessageCollection('msg_update_individual_plan');
         $this->object->updatePlanFromRepository(
             $progress->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 238 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $_POST, digestInput(), getAssignmentId(), updateDeadlines(), updateRequiredPoints(), and updateStatus().

     {
         $values = $this->digestInput($_POST);
         $msgs = $this->messages->getMessageCollection('msg_update_individual_plan');
         $this->updateStatus($values[self::POST_VAR_STATUS], $msgs);
         $this->updateDeadlines($values[self::POST_VAR_DEADLINE], $msgs);
         $this->updateRequiredPoints($values[self::POST_VAR_REQUIRED_POINTS], $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 312 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References ilPRGMessageCollection\add(), and user().

Referenced by updateFromInput().

     {
         $programme = $this->parent_gui->getStudyProgramme();
         $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;
             }
 
             $progress = $this->progress_repository->get($progress_id);
             $cur_points = $progress->getAmountOfPoints();
 
             if ($points != $cur_points) {
                 $programme->changeAmountOfPoints($progress_id, $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 254 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References ilPRGMessageCollection\add(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, and user().

Referenced by updateFromInput().

     {
         $programme = $this->parent_gui->getStudyProgramme();
         $acting_user_id = (int) $this->user->getId();
 
         foreach ($progress_updates as $progress_id => $target_status) {
             switch ($target_status) {
                 case ilStudyProgrammeProgress::STATUS_IN_PROGRESS:
 
                     $progress = $this->progress_repository->get($progress_id);
                     $cur_status = $progress->getStatus();
 
                     if ($cur_status == ilStudyProgrammeProgress::STATUS_ACCREDITED) {
                         $programme->unmarkAccredited($progress_id, $acting_user_id, $msgs);
                     }
                     if ($cur_status == ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
                         $programme->markRelevant($progress_id, $acting_user_id, $msgs);
                     }
                     break;
 
                 case ilStudyProgrammeProgress::STATUS_ACCREDITED:
                     $programme->markAccredited($progress_id, $acting_user_id, $msgs);
                     break;
                 
                 case ilStudyProgrammeProgress::STATUS_NOT_RELEVANT:
                     $programme->markNotRelevant($progress_id, $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 146 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $tpl, buildFrame(), getAssignmentObject(), ilObjStudyProgramme\getInstanceByObjId(), and ilOrgUnitOperation\OP_VIEW_INDIVIDUAL_PLAN.

     {
         $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"
             );
         }
         $prg = ilObjStudyProgramme::getInstanceByObjId($ass->getRootId());
         $progress = $prg->getProgressForAssignment($ass->getId());
         
         $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, "Modules/StudyProgramme");
         $tpl->setVariable("CONTENT", $gui->getHTML());
         return $this->buildFrame("view", $tpl->get());
     }