Class ilObjStudyProgrammeIndividualPlanGUI. More...

Collaboration diagram for ilObjStudyProgrammeIndividualPlanGUI:

Public Member Functions
	__construct ($a_parent_gui, $a_ref_id)

	executeCommand ()

	appendIndividualPlanActions (ilTable2GUI $a_table)

	getManualStatusPostVarTitle ()

	getRequiredPointsPostVarTitle ()

	getManualStatusNone ()

	getManualStatusNotRelevant ()

	getManualStatusAccredited ()

Static Public Member Functions
static	getLinkTargetView ($ctrl, $a_ass_id)

Data Fields
	$ctrl

	$tpl

	$object

	$ilias

	$lng

	$toolbar

	$user

const	MANUAL_STATUS_NONE = 0

const	MANUAL_STATUS_NOT_RELEVANT = 1

const	MANUAL_STATUS_ACCREDITED = 2

Protected Member Functions
	getAssignmentId ()

	getAssignmentObject ()

	view ()

	manage ()

	updateFromCurrentPlan ()

	updateFromInput ()

	updateStatus ()

	updateRequiredPoints ($prgrs_id)

	showSuccessMessage ($a_lng_var)

	getManualStatusUpdates ()

	getRequiredPointsUpdates ($prgrs_id)

	buildFrame ($tab, $content)

	getLinkTargetForSubTab ($a_tab, $a_ass_id)

Protected Attributes
	$ilAccess

	$ilLog

	$parent_gui

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	(	$a_parent_gui,
		$a_ref_id
	)

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

References $ilAccess, $ilCtrl, $ilias, $ilLog, $ilUser, $lng, and $tpl.

                                                               {
                 global $tpl, $ilCtrl, $ilAccess, $ilToolbar, $ilLocator, $tree, $lng, $ilLog, $ilias, $ilUser;
 
                 $this->ref_id = $a_ref_id;
                 $this->parent_gui = $a_parent_gui;
                 $this->tpl = $tpl;
                 $this->ctrl = $ilCtrl;
                 $this->ilAccess = $ilAccess;
                 $this->ilLocator = $ilLocator;
                 $this->tree = $tree;
                 $this->toolbar = $ilToolbar;
                 $this->ilLog = $ilLog;
                 $this->ilias = $ilias;
                 $this->lng = $lng;
                 $this->user = $ilUser;
                 $this->assignment_object = null;
                 
                 $this->object = null;
 
                 $lng->loadLanguageModule("prg");
 
                 $this->tpl->addCss("Modules/StudyProgramme/templates/css/ilStudyProgramme.css");
         }

Member Function Documentation

◆ appendIndividualPlanActions()

ilObjStudyProgrammeIndividualPlanGUI::appendIndividualPlanActions ( ilTable2GUI $a_table )

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

References $tab, $tpl, ilObjUser\_lookupFullname(), getAssignmentObject(), and getLinkTargetForSubTab().

Referenced by manage(), and view().

                                                       {
                 $tpl = new ilTemplate("tpl.indivdual_plan_frame.html", true, true, "Modules/StudyProgramme");
                 $ass = $this->getAssignmentObject();
                 
                 $tpl->setVariable("USERNAME", ilObjUser::_lookupFullname($ass->getUserId()));
                 foreach (array("view", "manage") 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 84 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $cmd.

                                          {
                 $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 106 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $_GET.

Referenced by getAssignmentObject(), and updateFromInput().

                                              {
                 require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
                 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 114 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References getAssignmentId(), and ilStudyProgrammeUserAssignment\getInstance().

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

                                                  {
                 if ($this->assignment_object === null) {
                         $id = $this->getAssignmentId();
                         $this->assignment_object = ilStudyProgrammeUserAssignment::getInstance($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 259 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()

static ilObjStudyProgrammeIndividualPlanGUI::getLinkTargetView	(	$ctrl,
		$a_ass_id
	)

static

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

References $ctrl.

Referenced by ilObjStudyProgrammeMembersGUI\getLinkTargetForAction().

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

Here is the caller graph for this function:

◆ getManualStatusAccredited()

ilObjStudyProgrammeIndividualPlanGUI::getManualStatusAccredited ( )

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

                                                     {
                 return self::MANUAL_STATUS_ACCREDITED;
         }

◆ getManualStatusNone()

ilObjStudyProgrammeIndividualPlanGUI::getManualStatusNone ( )

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

                                               {
                 return self::MANUAL_STATUS_NONE;
         }

◆ getManualStatusNotRelevant()

ilObjStudyProgrammeIndividualPlanGUI::getManualStatusNotRelevant ( )

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

                                                      {
                 return self::MANUAL_STATUS_NOT_RELEVANT;
         }

◆ getManualStatusPostVarTitle()

ilObjStudyProgrammeIndividualPlanGUI::getManualStatusPostVarTitle ( )

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

Referenced by getManualStatusUpdates().

                                                       {
                 return "status";
         }

Here is the caller graph for this function:

◆ getManualStatusUpdates()

ilObjStudyProgrammeIndividualPlanGUI::getManualStatusUpdates ( )

protected

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

References $_POST, and getManualStatusPostVarTitle().

Referenced by updateStatus().

                                                     {
                 $post_var = $this->getManualStatusPostVarTitle();
                 if (!array_key_exists($post_var, $_POST)) {
                         throw new ilException("Expected array $post_var in POST");
                 }
                 return $_POST[$post_var];
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRequiredPointsPostVarTitle()

ilObjStudyProgrammeIndividualPlanGUI::getRequiredPointsPostVarTitle ( )

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

Referenced by getRequiredPointsUpdates().

                                                         {
                 return "required_points";
         }

Here is the caller graph for this function:

◆ getRequiredPointsUpdates()

ilObjStudyProgrammeIndividualPlanGUI::getRequiredPointsUpdates ( $prgrs_id )

protected

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

References $_POST, and getRequiredPointsPostVarTitle().

Referenced by updateRequiredPoints().

                                                                {
                 $post_var = $this->getRequiredPointsPostVarTitle();
                 if (!array_key_exists($post_var, $_POST)) {
                         throw new ilException("Expected array $post_var in POST");
                 }
 
                 $post_value = $_POST[$post_var];
                 return (int)$post_value[$prgrs_id];
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ manage()

ilObjStudyProgrammeIndividualPlanGUI::manage ( )

protected

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

References buildFrame(), and getAssignmentObject().

                                     {
                 require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeIndividualPlanTableGUI.php");
                 $ass = $this->getAssignmentObject();
                 $this->ctrl->setParameter($this, "ass_id", $ass->getId());
                 $this->ctrl->setParameter($this, "cmd", "manage");
                 $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:

◆ showSuccessMessage()

ilObjStudyProgrammeIndividualPlanGUI::showSuccessMessage ( $a_lng_var )

protected

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

References ilUtil\sendSuccess().

Referenced by updateFromCurrentPlan(), and updateFromInput().

                                                           {
                 require_once("Services/Utilities/classes/class.ilUtil.php");
                 ilUtil::sendSuccess($this->lng->txt("prg_$a_lng_var"), true);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateFromCurrentPlan()

ilObjStudyProgrammeIndividualPlanGUI::updateFromCurrentPlan ( )

protected

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

References getAssignmentObject(), and showSuccessMessage().

                                                    {
                 $ass = $this->getAssignmentObject();
                 $ass->updateFromProgram();
                 $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 151 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $changed, getAssignmentId(), showSuccessMessage(), and updateStatus().

                                              {
                 require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgress.php");
                 
                 $changed = false;
                 
                 $changed = $this->updateStatus();
                 
                 $this->ctrl->setParameter($this, "ass_id", $this->getAssignmentId());
                 if ($changed) {
                         $this->showSuccessMessage("update_successful");
                 }
                 $this->ctrl->redirect($this, "manage");
         }

Here is the call graph for this function:

◆ updateRequiredPoints()

ilObjStudyProgrammeIndividualPlanGUI::updateRequiredPoints ( $prgrs_id )

protected

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

References $changed, ilStudyProgrammeUserProgress\getInstanceById(), getRequiredPointsUpdates(), and ilStudyProgrammeProgress\STATUS_IN_PROGRESS.

Referenced by updateStatus().

                                                            {
                 $required_points = $this->getRequiredPointsUpdates($prgrs_id);
                 $changed = false;
         
                 $prgrs = ilStudyProgrammeUserProgress::getInstanceById($prgrs_id);
                 $cur_status = $prgrs->getStatus();
                 if ($cur_status != ilStudyProgrammeProgress::STATUS_IN_PROGRESS) {
                         return false;
                 }
                 
                 if ($required_points < 0) {
                         $required_points = 0;
                 }
                 
                 if ($required_points == $prgrs->getAmountOfPoints()) {
                         return false;
                 }
                 
                 $prgrs->setRequiredAmountOfPoints($required_points, $this->user->getId());
                 return true;
                 
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateStatus()

ilObjStudyProgrammeIndividualPlanGUI::updateStatus ( )

protected

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

References $changed, ilStudyProgrammeUserProgress\getInstanceById(), getManualStatusUpdates(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, and updateRequiredPoints().

Referenced by updateFromInput().

                                           {
                 $status_updates = $this->getManualStatusUpdates();
                 $changed = false;
                 foreach ($status_updates as $prgrs_id => $status) {
                         $prgrs = ilStudyProgrammeUserProgress::getInstanceById($prgrs_id);
                         $cur_status = $prgrs->getStatus();
                         if ($status == self::MANUAL_STATUS_NONE && $cur_status == ilStudyProgrammeProgress::STATUS_ACCREDITED) {
                                 $prgrs->unmarkAccredited($this->user->getId());
                                 $changed = true;
                         }
                         else if ($status == self::MANUAL_STATUS_NONE && $cur_status == ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
                                 $prgrs->markRelevant($this->user->getId());
                                 $changed = true;
                         }
                         else if($status == self::MANUAL_STATUS_NOT_RELEVANT && $cur_status != ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
                                 $prgrs->markNotRelevant($this->user->getId());
                                 $changed = true;
                         }
                         else if($status == self::MANUAL_STATUS_ACCREDITED && $cur_status != ilStudyProgrammeProgress::STATUS_ACCREDITED) {
                                 $prgrs->markAccredited($this->user->getId());
                                 $changed = true;
                         }
 
                         if($cur_status == ilStudyProgrammeProgress::STATUS_IN_PROGRESS) {
                                 $changed = $this->updateRequiredPoints($prgrs_id) || $changed;
                         }
                 }
                 return $changed;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ view()

ilObjStudyProgrammeIndividualPlanGUI::view ( )

protected

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

References $tpl, buildFrame(), and getAssignmentObject().

                                   {
                 require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeIndividualPlanProgressListGUI.php");
                 $gui = new ilStudyProgrammeIndividualPlanProgressListGUI($this->getAssignmentObject()->getRootProgress());
                 $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());
         }