class.ilPDStudyProgrammeSimpleListGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2015 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */

require_once("Services/Block/classes/class.ilBlockGUI.php");
require_once('./Modules/StudyProgramme/classes/class.ilObjStudyProgrammeAdmin.php');
require_once 'Services/PersonalDesktop/classes/class.ilPDSelectedItemsBlockGUI.php';

class ilPDStudyProgrammeSimpleListGUI extends ilBlockGUI {
        const BLOCK_TYPE = "prgsimplelist";
        
        protected $il_lng;
        
        protected $il_user;
        
        protected $il_access;
        
        protected $il_setting;

        protected $users_assignments;

        protected $visible_on_pd_mode;
        
        protected $show_info_message;

        public function __construct() {
                global $DIC;
                $lng = $DIC['lng'];
                $ilUser = $DIC['ilUser'];
                $ilAccess = $DIC['ilAccess'];
                $ilSetting = $DIC['ilSetting'];
                $this->il_lng = $lng;
                $this->il_user = $ilUser;
                $this->il_access = $ilAccess;
                $this->il_setting = $ilSetting;
                $this->il_logger = ilLoggerFactory::getLogger('prg');

                // No need to load data, as we won't display this. 
                if (!$this->shouldShowThisList()) {
                        return;
                }

                $this->readUsersAssignments();
                //check which kind of option is selected in settings
                $this->readVisibleOnPDMode();
                //check to display info message if option "read" is selected
                $this->readToShowInfoMessage();
                
                // As this won't be visible we don't have to initialize this.
                if (!$this->userHasReadableStudyProgrammes()) {
                        return;
                }

                $this->setTitle($this->il_lng->txt("objs_prg"));
        }
        
        public function getHTML() {
                // TODO: This should be determined from somewhere up in the hierarchy, as
                // this will lead to problems, when e.g. a command changes. But i don't see
                // how atm...
                if (!$this->shouldShowThisList()) {
                        return "";
                }
                
                if (!$this->userHasReadableStudyProgrammes()) {
                        return "";
                }
                return parent::getHTML();
        }
        
        public function getDataSectionContent() {
                $content = "";
                foreach ($this->users_assignments as $assignment) {
                        if(!$this->isReadable($assignment)) {
                                continue;
                        }

                        try {
                                $list_item = $this->new_ilStudyProgrammeAssignmentListGUI($assignment);
                                $list_item->setShowInfoMessage($this->show_info_message);
                                $list_item->setVisibleOnPDMode($this->visible_on_pd_mode);
                                $content .= $list_item->getHTML();
                        }
                        catch (ilStudyProgrammeNoProgressForAssignmentException $e) {
                                $this->il_logger->alert("$e");
                        }
                        catch(ilStudyProgrammeTreeException $e) {
                                $this->il_logger->alert("$e");
                        }
                }
                return $content;
        }
        
        static public function getBlockType() {
                return self::BLOCK_TYPE;
        }
        
        static public function isRepositoryObject() {
                return false;
        }
        
        public function fillDataSection() {
                assert($this->userHasReadableStudyProgrammes()); // We should not get here.
                $this->tpl->setVariable("BLOCK_ROW", $this->getDataSectionContent());
        }
        
        
        protected function userHasVisibleStudyProgrammes() {
                if (count($this->users_assignments) == 0) {
                        return false;
                }
                foreach ($this->users_assignments as $assignment) {
                        if ($this->isVisible($assignment)) {
                                return true;
                        }
                }
                return false;
        }

        protected function userHasReadableStudyProgrammes() {
                if (count($this->users_assignments) == 0) {
                        return false;
                }
                foreach ($this->users_assignments as $assignment) {
                        if ($this->isReadable($assignment)) {
                                return true;
                        }
                }
                return false;
        }
        
        protected function readVisibleOnPDMode() {
                $this->visible_on_pd_mode = $this->il_setting->get(ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD);
        }

        protected function hasPermission(ilStudyProgrammeUserAssignment $assignment, $permission) {
                $prg = $assignment->getStudyProgramme();
                return $this->il_access->checkAccess($permission, "", $prg->getRefId(), "prg", $prg->getId());
        }

        protected function readToShowInfoMessage() {
                $this->show_info_message = ($_GET['view'] == ilPDSelectedItemsBlockGUI::VIEW_MY_STUDYPROGRAMME);
        }

        protected function isVisible(ilStudyProgrammeUserAssignment $assignment) {
                return $this->hasPermission($assignment,"visible");
        }

        protected function isReadable(ilStudyProgrammeUserAssignment $assignment) {
                if($this->visible_on_pd_mode == ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_ALLWAYS){
                        return true;
                }

                return $this->hasPermission($assignment,"read");
        }
        
        protected function shouldShowThisList() {
                global $DIC;
                $ctrl = $DIC->ctrl();
                return ($_GET["cmd"] == "jumpToSelectedItems" ||
                                ($ctrl->getCmdClass() == "ilpersonaldesktopgui" && $ctrl->getCmd() == "show")
                        ) && !$_GET["expand"];
        }
        
        protected function readUsersAssignments() {
                require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
                $this->users_assignments = ilStudyProgrammeUserAssignment::getInstancesOfUser($this->il_user->getId());
        }
        
        protected function new_ilStudyProgrammeAssignmentListGUI(ilStudyProgrammeUserAssignment $a_assignment) {
                require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeProgressListGUI.php");
                $progress = $a_assignment->getStudyProgramme()->getProgressForAssignment($a_assignment->getId());
                $progress_gui = new ilStudyProgrammeProgressListGUI($progress);
                $progress_gui->setOnlyRelevant(true);
                return $progress_gui;
        }
}