Class ilObjStudyProgrammeIndividualPlanGUI. More...

Collaboration diagram for ilObjStudyProgrammeIndividualPlanGUI:

Public Member Functions
	__construct ($a_parent_gui, $a_ref_id, ilStudyProgrammeUserProgressDB $sp_user_progress_db)

	executeCommand ()

	appendIndividualPlanActions (ilTable2GUI $a_table)

	getManualStatusPostVarTitle ()

	getRequiredPointsPostVarTitle ()

	getDeadlinePostVarTitle ()

	getManualStatusNone ()

	getManualStatusNotRelevant ()

	getManualStatusAccredited ()

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

Data Fields
	$ctrl

	$tpl

	$object

	$ilias

	$lng

	$toolbar

	$user

const	POST_VAR_STATUS = "status"

const	POST_VAR_REQUIRED_POINTS = "required_points"

const	POST_VAR_DEADLINE = "deadline"

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 ()

	updateDeadline (ilStudyProgrammeUserProgress $prgrs)
	Updates current deadline. More...

	updateRequiredPoints ($prgrs_id)

	getDeadlineFromForm ($prgrs_id)
	Get the deadline from form. More...

	postContainDeadline ()
	Checks whether $_POST contains deadline. More...

	showSuccessMessage ($a_lng_var)

	getManualStatusUpdates ()

	getRequiredPointsUpdates ($prgrs_id)

	buildFrame ($tab, $content)

	getLinkTargetForSubTab ($a_tab, $a_ass_id)

Protected Attributes
	$ilAccess

	$ilLog

	$parent_gui

	$sp_user_progress_db

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,
		ilStudyProgrammeUserProgressDB	$sp_user_progress_db
	)

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

References $DIC, $ilAccess, $ilCtrl, $ilias, $ilLog, $ilUser, $lng, $sp_user_progress_db, $tpl, and user().

     {
         global $DIC;
         $tpl = $DIC['tpl'];
         $ilCtrl = $DIC['ilCtrl'];
         $ilAccess = $DIC['ilAccess'];
         $ilToolbar = $DIC['ilToolbar'];
         $ilLocator = $DIC['ilLocator'];
         $tree = $DIC['tree'];
         $lng = $DIC['lng'];
         $ilLog = $DIC['ilLog'];
         $ilias = $DIC['ilias'];
         $ilUser = $DIC['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->sp_user_progress_db = $sp_user_progress_db;
 
         $this->object = 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 362 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 336 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $tab, $tpl, ilObjUser\_lookupFullname(), array, 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 102 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 125 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 134 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $id, 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:

◆ getDeadlineFromForm()

ilObjStudyProgrammeIndividualPlanGUI::getDeadlineFromForm ( $prgrs_id )

protected

Get the deadline from form.

Parameters

int $prgrs_id

Returns: ilDateTime

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

References $_POST, getDeadlinePostVarTitle(), IL_CAL_DATE, and postContainDeadline().

Referenced by updateDeadline().

     {
         $post_var = $this->getDeadlinePostVarTitle();
         if (!$this->postContainDeadline()) {
             throw new ilException("Expected array $post_var in POST");
         }
 
         $post_value = $_POST[$post_var];
         $deadline = $post_value[$prgrs_id];
 
         if ($deadline == "") {
             return null;
         }
 
         return new ilDateTime($deadline, IL_CAL_DATE);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDeadlinePostVarTitle()

ilObjStudyProgrammeIndividualPlanGUI::getDeadlinePostVarTitle ( )

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

Referenced by getDeadlineFromForm(), and postContainDeadline().

     {
         return self::POST_VAR_DEADLINE;
     }

Here is the caller graph for this function:

◆ getLinkTargetForSubTab()

ilObjStudyProgrammeIndividualPlanGUI::getLinkTargetForSubTab	(	$a_tab,
		$a_ass_id
	)

protected

Definition at line 354 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 406 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 401 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

     {
         return self::MANUAL_STATUS_ACCREDITED;
     }

◆ getManualStatusNone()

ilObjStudyProgrammeIndividualPlanGUI::getManualStatusNone ( )

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

     {
         return self::MANUAL_STATUS_NONE;
     }

◆ getManualStatusNotRelevant()

ilObjStudyProgrammeIndividualPlanGUI::getManualStatusNotRelevant ( )

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

     {
         return self::MANUAL_STATUS_NOT_RELEVANT;
     }

◆ getManualStatusPostVarTitle()

ilObjStudyProgrammeIndividualPlanGUI::getManualStatusPostVarTitle ( )

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

Referenced by getManualStatusUpdates().

     {
         return self::POST_VAR_STATUS;
     }

Here is the caller graph for this function:

◆ getManualStatusUpdates()

ilObjStudyProgrammeIndividualPlanGUI::getManualStatusUpdates ( )

protected

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

Referenced by getRequiredPointsUpdates().

     {
         return self::POST_VAR_REQUIRED_POINTS;
     }

Here is the caller graph for this function:

◆ getRequiredPointsUpdates()

ilObjStudyProgrammeIndividualPlanGUI::getRequiredPointsUpdates ( $prgrs_id )

protected

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

References $table, 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, $this->sp_user_progress_db);
         $frame = $this->buildFrame("manage", $table->getHTML());
         $this->ctrl->setParameter($this, "ass_id", null);
         return $frame;
     }

Here is the call graph for this function:

◆ postContainDeadline()

ilObjStudyProgrammeIndividualPlanGUI::postContainDeadline ( )

protected

Checks whether $_POST contains deadline.

Returns: bool

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

References $_POST, and getDeadlinePostVarTitle().

Referenced by getDeadlineFromForm(), and updateStatus().

     {
         $post_var = $this->getDeadlinePostVarTitle();
         if (array_key_exists($post_var, $_POST)) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSuccessMessage()

ilObjStudyProgrammeIndividualPlanGUI::showSuccessMessage ( $a_lng_var )

protected

Definition at line 309 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:

◆ updateDeadline()

ilObjStudyProgrammeIndividualPlanGUI::updateDeadline ( ilStudyProgrammeUserProgress $prgrs )

protected

Updates current deadline.

Parameters

ilStudyProgrammeUserProgress $prgrs

Returns: ilDateTime

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

References getDeadlineFromForm(), ilStudyProgrammeUserProgress\getId(), ilStudyProgrammeUserProgress\setDeadline(), ilStudyProgrammeUserProgress\updateProgress(), and user().

Referenced by updateStatus().

     {
         $deadline = $this->getDeadlineFromForm($prgrs->getId());
         $prgrs->setDeadline($deadline);
         $prgrs->updateProgress($this->user->getId());
 
         return $deadline;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateFromCurrentPlan()

ilObjStudyProgrammeIndividualPlanGUI::updateFromCurrentPlan ( )

protected

Definition at line 166 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 175 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 248 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

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

Referenced by updateStatus().

     {
         $required_points = $this->getRequiredPointsUpdates($prgrs_id);
         $changed = false;
 
         $prgrs = $this->sp_user_progress_db->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 190 of file class.ilObjStudyProgrammeIndividualPlanGUI.php.

References $changed, date, getManualStatusUpdates(), IL_CAL_DATE, postContainDeadline(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_FAILED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, updateDeadline(), updateRequiredPoints(), and user().

Referenced by updateFromInput().

     {
         $status_updates = $this->getManualStatusUpdates();
         $changed = false;
         foreach ($status_updates as $prgrs_id => $status) {
             $prgrs = $this->sp_user_progress_db->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;
             } elseif ($status == self::MANUAL_STATUS_NONE && $cur_status == ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
                 $prgrs->markRelevant($this->user->getId());
                 $changed = true;
             } elseif ($status == self::MANUAL_STATUS_NOT_RELEVANT && $cur_status != ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
                 $prgrs->markNotRelevant($this->user->getId());
                 $changed = true;
             } elseif ($status == self::MANUAL_STATUS_ACCREDITED && $cur_status != ilStudyProgrammeProgress::STATUS_ACCREDITED) {
                 $prgrs->markAccredited($this->user->getId());
                 $changed = true;
             }
 
             $deadline = null;
             if ($this->postContainDeadline()) {
                 $deadline = $this->updateDeadline($prgrs);
             }
 
             if ($cur_status == ilStudyProgrammeProgress::STATUS_IN_PROGRESS) {
                 $changed = $this->updateRequiredPoints($prgrs_id) || $changed;
 
                 if ($deadline !== null && $deadline->get(IL_CAL_DATE) < date("Y-m-d")) {
                     $prgrs->markFailed($this->user->getId());
                 }
             } elseif ($cur_status == ilStudyProgrammeProgress::STATUS_FAILED) {
                 if ($deadline === null || $deadline->get(IL_CAL_DATE) > date("Y-m-d")) {
                     $prgrs->markNotFailed($this->user->getId());
                 }
             }
         }
         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 143 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());
     }