Class ilObjStudyProgrammeMembersGUI. More...

Collaboration diagram for ilObjStudyProgrammeMembersGUI:

Public Member Functions
	__construct ($a_parent_gui, $a_ref_id)

	executeCommand ()

	addUsers ($a_users)

	viewCompletedCourses ($a_completed_courses, $a_users)

	addUsersWithAcknowledgedCourses ()

	markAccredited ()

	unmarkAccredited ()

	removeUser ()

	getStudyProgramme ($a_ref_id=null)

	getLinkTargetForAction ($a_action, $a_prgrs_id, $a_ass_id)
	Get the link target for an action on user progress. More...

Data Fields
	$ctrl

	$tpl

	$object

	$ilias

	$lng

	$toolbar

	$user

Protected Member Functions
	view ()

	_addUsers ($a_users)

	getProgressObject ()

	showSuccessMessage ($a_lng_var)

	initSearchGUI ()

Protected Attributes
	$ilAccess

	$ilLog

	$parent_gui

Detailed Description

Class ilObjStudyProgrammeMembersGUI.

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

@ilCtrl_Calls ilObjStudyProgrammeMembersGUI: ilStudyProgrammeRepositorySearchGUI @ilCtrl_Calls ilObjStudyProgrammeMembersGUI: ilObjStudyProgrammeIndividualPlanGUI @ilCtrl_Calls ilObjStudyProgrammeMembersGUI: ilObjFileGUI

Definition at line 16 of file class.ilObjStudyProgrammeMembersGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeMembersGUI::__construct	(	$a_parent_gui,
		$a_ref_id
	)

Definition at line 64 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                              {
                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->progress_object = null;
                
                $this->object = null;
 
                $lng->loadLanguageModule("prg");
        }

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

Here is the call graph for this function:

Member Function Documentation

◆ _addUsers()

ilObjStudyProgrammeMembersGUI::_addUsers ( $a_users )

protected

Definition at line 228 of file class.ilObjStudyProgrammeMembersGUI.php.

                                               {
                $prg = $this->getStudyProgramme();
 
                $assignments = array();
 
                foreach ($a_users as $user_id) {
                        $assignments[$user_id] = $prg->assignUser($user_id);
                }
 
                if (count($a_users) == 1) {
                        ilUtil::sendSuccess($this->lng->txt("prg_added_member"), true);
                }
                if (count($a_users) > 1) {
                        ilUtil::sendSuccess($this->lng->txt("prg_added_members"), true);
                }
 
                return $assignments;
        }

References getStudyProgramme(), and ilUtil\sendSuccess().

Referenced by addUsers(), and addUsersWithAcknowledgedCourses().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addUsers()

ilObjStudyProgrammeMembersGUI::addUsers ( $a_users )

Definition at line 158 of file class.ilObjStudyProgrammeMembersGUI.php.

                                           {
                $prg = $this->getStudyProgramme();
 
                $completed_courses = array();
 
                foreach ($a_users as $user_id) {
                        $completed_crss = $prg->getCompletedCourses($user_id);
                        if ($completed_crss) {
                                $completed_courses[$user_id] = $completed_crss;
                        }
                }
 
                if (count($completed_courses) > 0) {
                        $this->viewCompletedCourses($completed_courses, $a_users);
                        return true;
                }
 
                $this->_addUsers($a_users);
 
                $this->ctrl->redirect($this, "view");
        }

References _addUsers(), getStudyProgramme(), and viewCompletedCourses().

Here is the call graph for this function:

◆ addUsersWithAcknowledgedCourses()

ilObjStudyProgrammeMembersGUI::addUsersWithAcknowledgedCourses ( )

Definition at line 210 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                          {
                $users = $_POST["users"];
                $assignments = $this->_addUsers($users);
 
                $completed_programmes = $_POST["courses"];
                foreach ($completed_programmes as $user_id => $prg_ref_ids) {
                        $ass_id = $assignments[$user_id]->getId();
                        foreach ($prg_ref_ids as $ids) {
                                list($prg_ref_id, $crs_id, $crsr_id) = explode(";", $ids);
                                $prg = $this->getStudyProgramme($prg_ref_id);
                                $progress = $prg->getProgressForAssignment($ass_id);
                                $progress->setLPCompleted($crsr_id, $user_id);
                        }
                }
 
                $this->ctrl->redirect($this, "view");
        }

References $_POST, _addUsers(), and getStudyProgramme().

Here is the call graph for this function:

◆ executeCommand()

ilObjStudyProgrammeMembersGUI::executeCommand ( )

Definition at line 96 of file class.ilObjStudyProgrammeMembersGUI.php.

                                         {
                $cmd = $this->ctrl->getCmd();
                $next_class = $this->ctrl->getNextClass($this);
                
                
                if ($cmd == "") {
                        $cmd = "view";
                }
                
                # TODO: Check permission of user!!
                
                switch ($next_class) {
                        case "ilstudyprogrammerepositorysearchgui":             
                                require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeRepositorySearchGUI.php");
                                $rep_search = new ilStudyProgrammeRepositorySearchGUI();
                                $rep_search->setCallback($this, "addUsers");
                                
                                $this->ctrl->setReturn($this, "view");
                                $this->ctrl->forwardCommand($rep_search);
                                return;
                        case "ilobjstudyprogrammeindividualplangui":
                                require_once("./Modules/StudyProgramme/classes/class.ilObjStudyProgrammeIndividualPlanGUI.php");
                                $individual_plan_gui = new ilObjStudyProgrammeIndividualPlanGUI( $this, $this->ref_id);
                                $this->ctrl->forwardCommand($individual_plan_gui);
                                return;
                        case false:
                                switch ($cmd) {
                                        case "view":
                                        case "markAccredited":
                                        case "unmarkAccredited":
                                        case "removeUser":
                                        case "addUsersWithAcknowledgedCourses":
                                                $cont = $this->$cmd();
                                                break;
                                        default:
                                                throw new ilException("ilObjStudyProgrammeMembersGUI: ".
                                                                                          "Command not supported: $cmd");
                                }
                                break;
                        default:
                                throw new ilException("ilObjStudyProgrammeMembersGUI: Can't forward to next class $next_class");
                }
                
                $this->tpl->setContent($cont);
        }

References $cmd.

◆ getLinkTargetForAction()

ilObjStudyProgrammeMembersGUI::getLinkTargetForAction	(	$a_action,
		$a_prgrs_id,
		$a_ass_id
	)

Get the link target for an action on user progress.

Parameters

int	$a_action	One of ilStudyProgrammeUserProgress::ACTION_*
int	$a_prgrs_id	Id of the progress object to act on.
int	$a_ass_id	Id of the assignment object to act on.

Returns: string The link to the action.

Definition at line 322 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                                                  {
                require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgress.php");
                
                switch ($a_action) {
                        case ilStudyProgrammeUserProgress::ACTION_MARK_ACCREDITED:
                                $target_name = "markAccredited";
                                break;
                        case ilStudyProgrammeUserProgress::ACTION_UNMARK_ACCREDITED:
                                $target_name = "unmarkAccredited";
                                break;
                        case ilStudyProgrammeUserProgress::ACTION_SHOW_INDIVIDUAL_PLAN:
                                require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgrammeIndividualPlanGUI.php");
                                return ilObjStudyProgrammeIndividualPlanGUI::getLinkTargetView($this->ctrl, $a_ass_id);
                        case ilStudyProgrammeUserProgress::ACTION_REMOVE_USER:
                                $target_name = "removeUser";
                                break;
                        default:
                                throw new ilException("Unknown action: $action");
                }
                
                $this->ctrl->setParameter($this, "prgrs_id", $a_prgrs_id);
                $link = $this->ctrl->getLinkTarget($this, $target_name);
                $this->ctrl->setParameter($this, "prgrs_id", null);
                return $link;
        }

References ilStudyProgrammeUserProgress\ACTION_MARK_ACCREDITED, ilStudyProgrammeUserProgress\ACTION_REMOVE_USER, ilStudyProgrammeUserProgress\ACTION_SHOW_INDIVIDUAL_PLAN, ilStudyProgrammeUserProgress\ACTION_UNMARK_ACCREDITED, and ilObjStudyProgrammeIndividualPlanGUI\getLinkTargetView().

Here is the call graph for this function:

◆ getProgressObject()

ilObjStudyProgrammeMembersGUI::getProgressObject ( )

protected

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

                                               {
                if ($this->progress_object === null) {
                        require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgress.php");
                        if (!is_numeric($_GET["prgrs_id"])) {
                                throw new ilException("Expected integer 'prgrs_id'");
                        }
                        $id = (int)$_GET["prgrs_id"];
                        $this->progress_object = ilStudyProgrammeUserProgress::getInstanceById($id);
                }
                return $this->progress_object;
        }

References $_GET, and ilStudyProgrammeUserProgress\getInstanceById().

Referenced by markAccredited(), removeUser(), and unmarkAccredited().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStudyProgramme()

ilObjStudyProgrammeMembersGUI::getStudyProgramme ( $a_ref_id = null )

Definition at line 306 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                            {
                if ($a_ref_id === null) {
                        $a_ref_id = $this->ref_id;
                }
                require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
                return ilObjStudyProgramme::getInstanceByRefId($a_ref_id);
        }

References $ref_id, and ilObjStudyProgramme\getInstanceByRefId().

Referenced by _addUsers(), addUsers(), addUsersWithAcknowledgedCourses(), and view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSearchGUI()

ilObjStudyProgrammeMembersGUI::initSearchGUI ( )

protected

Definition at line 293 of file class.ilObjStudyProgrammeMembersGUI.php.

                                           {
                require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeRepositorySearchGUI.php");
                ilStudyProgrammeRepositorySearchGUI::fillAutoCompleteToolbar(
                        $this,
                        $this->toolbar,
                        array(
                                "auto_complete_name"    => $this->lng->txt("user"),
                                "submit_name"                   => $this->lng->txt("add"),
                                "add_search"                    => true
                        )
                );
        }

References ilStudyProgrammeRepositorySearchGUI\fillAutoCompleteToolbar().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markAccredited()

ilObjStudyProgrammeMembersGUI::markAccredited ( )

Definition at line 247 of file class.ilObjStudyProgrammeMembersGUI.php.

                                         {
                require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgress.php");
                $prgrs = $this->getProgressObject();
                $prgrs->markAccredited($this->user->getId());
                $this->showSuccessMessage("mark_accredited_success");
                $this->ctrl->redirect($this, "view");
        }

References getProgressObject(), showSuccessMessage(), and user().

Here is the call graph for this function:

◆ removeUser()

ilObjStudyProgrammeMembersGUI::removeUser ( )

Definition at line 263 of file class.ilObjStudyProgrammeMembersGUI.php.

                                     {
                require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgress.php");
                $prgrs = $this->getProgressObject();
                $ass = $prgrs->getAssignment();
                $prg = $ass->getStudyProgramme();
                if ($prg->getRefId() != $this->ref_id) {
                        throw new ilException("Can only remove users from the node they where assigned to.");
                }
                $ass->deassign();
                $this->showSuccessMessage("remove_user_success");
                $this->ctrl->redirect($this, "view");
        }

References getProgressObject(), and showSuccessMessage().

Here is the call graph for this function:

◆ showSuccessMessage()

ilObjStudyProgrammeMembersGUI::showSuccessMessage ( $a_lng_var )

protected

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

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

References ilUtil\sendSuccess().

Referenced by markAccredited(), removeUser(), and unmarkAccredited().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unmarkAccredited()

ilObjStudyProgrammeMembersGUI::unmarkAccredited ( )

Definition at line 255 of file class.ilObjStudyProgrammeMembersGUI.php.

                                           {
                require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgress.php");
                $prgrs = $this->getProgressObject();
                $prgrs->unmarkAccredited();
                $this->showSuccessMessage("unmark_accredited_success");
                $this->ctrl->redirect($this, "view");
        }

References getProgressObject(), and showSuccessMessage().

Here is the call graph for this function:

◆ view()

ilObjStudyProgrammeMembersGUI::view ( )

protected

Definition at line 142 of file class.ilObjStudyProgrammeMembersGUI.php.

                                  {
                require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeMembersTableGUI.php");
                
                if ($this->getStudyProgramme()->isActive()) {
                        $this->initSearchGUI();
                }
                
                if (!$this->getStudyProgramme()->isActive()) {
                        ilUtil::sendInfo($this->lng->txt("prg_no_members_not_active"));
                }
                
                $prg_id = ilObject::_lookupObjId($this->ref_id);
                $table = new ilStudyProgrammeMembersTableGUI($prg_id, $this->ref_id, $this, "view");
                return $table->getHTML();
        }

References ilObject\_lookupObjId(), getStudyProgramme(), initSearchGUI(), and ilUtil\sendInfo().

Here is the call graph for this function:

◆ viewCompletedCourses()

ilObjStudyProgrammeMembersGUI::viewCompletedCourses	(	$a_completed_courses,
		$a_users
	)

Definition at line 180 of file class.ilObjStudyProgrammeMembersGUI.php.

                                                                             {
                require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeAcknowledgeCompletedCoursesTableGUI.php");
 
                $tpl = new ilTemplate("tpl.acknowledge_completed_courses.html", true, true, "Modules/StudyProgramme");
                $tpl->setVariable("TITLE", $this->lng->txt("prg_acknowledge_completed_courses"));
                $tpl->setVariable("CAPTION_ADD", $this->lng->txt("btn_next"));
                $tpl->setVariable("CAPTION_CANCEL", $this->lng->txt("cancel"));
                $tpl->setVariable("FORM_ACTION", $this->ctrl->getFormAction($this));
                $tpl->setVariable("ADD_CMD", "addUsersWithAcknowledgedCourses");
                $tpl->setVariable("CANCEL_CMD", "view");
 
                foreach ($a_completed_courses as $user_id => $completed_courses) {
                        $names = ilObjUser::_lookupName($user_id);
                        $tpl->setCurrentBlock("usr_section");
                        $tpl->setVariable("FIRSTNAME", $names["firstname"]);
                        $tpl->setVariable("LASTNAME", $names["lastname"]);
                        $table = new ilStudyProgrammeAcknowledgeCompletedCoursesTableGUI($this, $user_id, $completed_courses);
                        $tpl->setVariable("TABLE", $table->getHTML());
                        $tpl->parseCurrentBlock();
                }
 
                foreach ($a_users as $usr_id) {
                        $tpl->setCurrentBlock("usr_ids_section");
                        $tpl->setVariable("USR_ID", $usr_id);
                        $tpl->parseCurrentBlock();
                }
 
                $this->tpl->setContent($tpl->get());
        }