This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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.

      {
        $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("Modules/StudyProgramme/templates/css/ilStudyProgramme.css");
    }

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

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.

                                                                   : 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"));
    }

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

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.

                                                               : 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, "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();
    }

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

Referenced by manage(), and view().

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.

                                    : 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);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getAssignmentId()

ilObjStudyProgrammeIndividualPlanGUI::getAssignmentId ( )

protected

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

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

References ILIAS\Repository\refinery().

Referenced by getAssignmentObject(), and updateFromInput().

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.

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

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

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

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.

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

References ILIAS\Repository\ctrl().

Referenced by buildFrame().

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.

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ manage()

ilObjStudyProgrammeIndividualPlanGUI::manage ( )

protected

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

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

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

Here is the call graph for this function:

◆ setParentGUI()

ilObjStudyProgrammeIndividualPlanGUI::setParentGUI ( ilObjStudyProgrammeMembersGUI $parent_gui )

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

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

References $parent_gui.

◆ setRefId()

ilObjStudyProgrammeIndividualPlanGUI::setRefId ( int $ref_id )

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

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

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

Here is the call graph for this function:

◆ showSuccessMessage()

ilObjStudyProgrammeIndividualPlanGUI::showSuccessMessage ( string $lng_var )

protected

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

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

References ILIAS\Repository\lng().

Referenced by updateFromCurrentPlan().

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.

                                                                                      : 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('d.m.Y', $deadline);
            }
 
            $cur_deadline = $progress->getDeadline();
            if ($deadline != $cur_deadline) {
                $programme->changeProgressDeadline($ass->getId(), $acting_user_id, $msgs, $deadline);
            }
        }
    }

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

Referenced by updateFromInput().

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.

                                              : 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");
    }

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

Here is the call graph for this function:

◆ updateFromInput()

ilObjStudyProgrammeIndividualPlanGUI::updateFromInput ( )

protected

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

                                        : 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");
    }

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

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.

                                                                                                 : 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);
            }
        }
    }

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

Referenced by updateFromInput().

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.

                                                                                          : 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);
            }
        }
    }

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

Referenced by updateFromInput().

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.

                             : 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, "Modules/StudyProgramme");
        $tpl->setVariable("CONTENT", $gui->getHTML());
        return $this->buildFrame("view", $tpl->get());
    }