Services/Tracking/classes/class.ilLearningProgressBaseGUI.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

define("LP_MODE_PERSONAL_DESKTOP",1);
define("LP_MODE_ADMINISTRATION",2);
define("LP_MODE_REPOSITORY",3);
define("LP_MODE_USER_FOLDER",4);

define("LP_ACTIVE_SETTINGS",1);
define("LP_ACTIVE_OBJECTS",2);
define("LP_ACTIVE_PROGRESS",3);

include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';

/* Base class for all Learning progress gui classes.
 * Defines modes for presentation according to the context in which it was called
 * E.g: mode LP_MODE_PERSONAL_DESKTOP displays only listOfObjects.
 */

class ilLearningProgressBaseGUI 
{
        var $tpl = null;
        var $ctrl = null;
        var $lng = null;

        var $ref_id = 0;

        var $mode = 0;

        function ilLearningProgressBaseGUI($a_mode,$a_ref_id = 0,$a_usr_id = 0)
        {
                global $tpl,$ilCtrl,$lng,$ilObjDataCache,$ilTabs;

                $this->tpl =& $tpl;
                $this->ctrl =& $ilCtrl;
                $this->lng =& $lng;
                $this->lng->loadLanguageModule('trac');
                $this->tabs_gui =& $ilTabs;

                $this->mode = $a_mode;
                $this->ref_id = $a_ref_id;
                $this->obj_id = $ilObjDataCache->lookupObjId($this->ref_id);
                $this->usr_id = $a_usr_id;

                $this->anonymized = (bool) !ilObjUserTracking::_enabledUserRelatedData();
        }

        function isAnonymized()
        {
                return $this->anonymized;
        }
        
        function getMode()
        {
                return $this->mode;
        }

        function getRefId()
        {
                return $this->ref_id;
        }

        function getObjId()
        {
                return $this->obj_id;
        }

        function getUserId()
        {
                if($this->usr_id)
                {
                        return $this->usr_id;
                }
                if((int) $_GET['user_id'])
                {
                        return (int) $_GET['user_id'];
                }
                return 0;
        }

        // Protected
        function __getDefaultCommand()
        {
                if(strlen($cmd = $this->ctrl->getCmd()))
                {
                        return $cmd;
                }
                return 'show';
        }

        function __setSubTabs($a_active)
        {
                global $rbacsystem,$ilObjDataCache;


                
                switch($this->getMode())
                {
                        case LP_MODE_PERSONAL_DESKTOP:

                                $this->tabs_gui->addSubTabTarget('trac_progress',
                                                                                                 $this->ctrl->getLinkTargetByClass('illplistofprogressgui',''),
                                                                                                 "","","",$a_active == LP_ACTIVE_PROGRESS);
                                $this->tabs_gui->addSubTabTarget('trac_objects',
                                                                                                 $this->ctrl->getLinkTargetByClass("illplistofobjectsgui",''),
                                                                                                 "","","",$a_active == LP_ACTIVE_OBJECTS);
                                break;


                        case LP_MODE_REPOSITORY:

                                if($rbacsystem->checkAccess('edit_learning_progress',$this->getRefId()))
                                {
                                        $this->ctrl->setParameterByClass('illplistofprogressgui','user_id',$this->getUserId());
                                        $this->tabs_gui->addSubTabTarget('trac_progress',
                                                                                           $this->ctrl->getLinkTargetByClass('illplistofprogressgui',''),
                                                                                           "","","",$a_active == LP_ACTIVE_PROGRESS);
                                        if(!$this->isAnonymized())
                                        {
                                                // Check if it is a course
                                                $sub_tab = ($ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($this->getRefId())) == 'crs') ?
                                                        'trac_crs_objects' :
                                                        'trac_objects';

                                                $this->tabs_gui->addSubTabTarget($sub_tab,
                                                                                                                 $this->ctrl->getLinkTargetByClass("illplistofobjectsgui",''),
                                                                                                                 "","","",$a_active == LP_ACTIVE_OBJECTS);
                                        }
                                        $this->tabs_gui->addSubTabTarget('trac_settings',
                                                                                                         $this->ctrl->getLinkTargetByClass('illplistofsettingsgui',''),
                                                                                                         "","","",$a_active == LP_ACTIVE_SETTINGS);
                                }
                                break;

                        case LP_MODE_ADMINISTRATION:
                                
                                $this->tabs_gui->addSubTabTarget('trac_progress',
                                                                         $this->ctrl->getLinkTargetByClass('illplistofprogressgui',''),
                                                                         "","","",$a_active == LP_ACTIVE_PROGRESS);
                                $this->tabs_gui->addSubTabTarget('trac_objects',
                                                                         $this->ctrl->getLinkTargetByClass("illplistofobjectsgui",''),
                                                                         "","","",$a_active == LP_ACTIVE_OBJECTS);
                                break;

                        case LP_MODE_USER_FOLDER:
                                
                                // No tabs default class is lpprogressgui
                                break;

                        default:
                                die ('No valid mode given');
                                break;
                }

                return true;
        }

        function __buildFooter()
        {
                switch($this->getMode())
                {
                        case LP_MODE_PERSONAL_DESKTOP:

                                $this->tpl->show(true);
                }
        }

        function __buildHeader()
        {
                if($this->getMode() == LP_MODE_PERSONAL_DESKTOP)
                {
                        $this->tpl->setCurrentBlock("header_image");
                        $this->tpl->setVariable("IMG_HEADER", ilUtil::getImagePath("icon_pd_b.gif"));
                        $this->tpl->parseCurrentBlock();
                        $this->tpl->setVariable("HEADER",$this->lng->txt("personal_desktop"));
                        
                        // set locator
                        $this->tpl->setVariable("TXT_LOCATOR", $this->lng->txt("locator"));
                        $this->tpl->touchBlock("locator_separator");
                        $this->tpl->setCurrentBlock("locator_item");
                        $this->tpl->setVariable("ITEM", $this->lng->txt("personal_desktop"));
                        $this->tpl->setVariable("LINK_ITEM",
                                                                        $this->ctrl->getLinkTargetByClass("ilpersonaldesktopgui"));
                        $this->tpl->parseCurrentBlock();
                        
                        $this->tpl->setCurrentBlock("locator_item");
                        $this->tpl->setVariable("ITEM", $this->lng->txt("learning_progress"));
                        $this->tpl->setVariable("LINK_ITEM",
                                                                        $this->ctrl->getLinkTargetByClass('illearningprogressgui'));
                        $this->tpl->parseCurrentBlock();
                
                        // catch feedback message
                        sendInfo();
                        // display infopanel if something happened
                        infoPanel();
                }

        }

        function __insertPath(&$a_tpl,$a_ref_id)
        {
                global $tree;

                $path_arr = $tree->getPathFull($a_ref_id);
                $counter = 0;
                foreach($tree->getPathFull($a_ref_id) as $data)
                {
                        if($counter++)
                        {
                                $path .= " -> ";
                        }
                        $path .= $data['title'];
                }
                $a_tpl->setCurrentBlock("path_item");
                $a_tpl->setVariable("PATH_ITEM",$path);
                $a_tpl->parseCurrentBlock();

                $a_tpl->setCurrentBlock("path");
                $a_tpl->parseCurrentBlock();

                return $path;
        }

        function __showImageByStatus(&$tpl,$a_status,$tpl_prefix = "")
        {
                switch($a_status)
                {
                        case LP_STATUS_IN_PROGRESS:
                                $tpl->setVariable($tpl_prefix."STATUS_IMG",ilUtil::getImagePath('scorm/incomplete.gif'));
                                $tpl->setVariable($tpl_prefix."STATUS_ALT",$this->lng->txt($a_status));
                                break;

                        case LP_STATUS_COMPLETED:
                                $tpl->setVariable($tpl_prefix."STATUS_IMG",ilUtil::getImagePath('scorm/complete.gif'));
                                $tpl->setVariable($tpl_prefix."STATUS_ALT",$this->lng->txt($a_status));
                                break;
                        
                        case LP_STATUS_NOT_ATTEMPTED:
                                $tpl->setVariable($tpl_prefix."STATUS_IMG",ilUtil::getImagePath('scorm/not_attempted.gif'));
                                $tpl->setVariable($tpl_prefix."STATUS_ALT",$this->lng->txt($a_status));
                                break;
                }
                return true;
        }


        // Protected Table gui methods
        function &__initTableGUI()
        {
                include_once "./classes/class.ilTableGUI.php";

                return new ilTableGUI(0,false);
        }


        function __showObjectDetails(&$info,$item_id = 0)
        {
                global $ilObjDataCache;

                $details_id = $item_id ? $item_id : $this->details_id;


                // Section object details
                $info->addSection($this->lng->txt('details'));
                $info->addProperty($this->lng->txt('title'),$ilObjDataCache->lookupTitle($details_id));
                if(strlen($desc = $ilObjDataCache->lookupDescription($details_id)))
                {
                        $info->addProperty($this->lng->txt('description'),$desc);
                }
                $info->addProperty($this->lng->txt('trac_mode'),ilLPObjSettings::_mode2Text(ilLPObjSettings::_lookupMode($details_id)));

                if(ilLPObjSettings::_lookupMode($details_id) == LP_MODE_VISITS)
                {
                        $info->addProperty($this->lng->txt('trac_required_visits'),ilLPObjSettings::_lookupVisits($details_id));
                }
                
                include_once './Services/MetaData/classes/class.ilMDEducational.php';
                if($seconds = ilMDEducational::_getTypicalLearningTimeSeconds($details_id))
                {
                        $info->addProperty($this->lng->txt('meta_typical_learning_time'),ilFormat::_secondsToString($seconds));
                }
        }

        function __appendLPDetails(&$info,$item_id,$user_id)
        {
                global $ilObjDataCache;

                $type = $ilObjDataCache->lookupType($item_id);
                
                // Section learning_progress
                $info->addSection($this->lng->txt('trac_learning_progress'));
        
                switch($type)
                {
                        case 'lm':
                                include_once 'Services/Tracking/classes/class.ilLearningProgress.php';
                                $progress = ilLearningProgress::_getProgress($user_id,$item_id);
                        
                                if($progress['access_time'])
                                {
                                        $info->addProperty($this->lng->txt('last_access'),date('Y-m-d H:i:s',$progress['access_time']));
                                }
                                else
                                {
                                        $info->addProperty($this->lng->txt('last_access'),$this->lng->txt('trac_not_accessed'));
                                }
                                $info->addProperty($this->lng->txt('trac_visits'),(int) $progress['visits']);
                                $info->addProperty($this->lng->txt('trac_spent_time'),ilFormat::_secondsToString($progress['spent_time']));
                                $info->addProperty($this->lng->txt('trac_status'),$this->lng->txt($this->__readStatus($item_id,$user_id)));
                                break;

                        case 'tst':
                        case 'crs':
                        case 'sahs':
                                $info->addProperty($this->lng->txt('trac_status'),$this->lng->txt($this->__readStatus($item_id,$user_id)));
                                break;

                }

                include_once 'Services/Tracking/classes/class.ilLPMarks.php';
                if(strlen($mark = ilLPMarks::_lookupMark($user_id,$item_id)))
                {
                        $info->addProperty($this->lng->txt('trac_mark'),$mark);
                }
                if(strlen($comment = ilLPMarks::_lookupComment($user_id,$item_id)))
                {
                        $info->addProperty($this->lng->txt('trac_comment'),$comment);
                }
        }

        function __readStatus($a_obj_id,$user_id)
        {
                include_once 'Services/Tracking/classes/class.ilLPStatusWrapper.php';

                if(in_array($user_id,ilLPStatusWrapper::_getInProgress($a_obj_id)))
                {
                        return $status = LP_STATUS_IN_PROGRESS;
                }
                elseif(in_array($user_id,ilLPStatusWrapper::_getCompleted($a_obj_id)))
                {
                        return $status = LP_STATUS_COMPLETED;
                }
                else
                {
                        return $status = LP_STATUS_NOT_ATTEMPTED;
                }
        }

        function __showButton($a_link,$a_text,$a_target = '')
        {
                $this->tpl->addBlockfile("BUTTONS", "buttons", "tpl.buttons.html");

                // display button
                $this->tpl->setCurrentBlock("btn_cell");
                $this->tpl->setVariable("BTN_LINK",$a_link);
                $this->tpl->setVariable("BTN_TXT",$a_text);
                if($a_target)
                {
                        $this->tpl->setVariable("BTN_TARGET",$a_target);
                }

                $this->tpl->parseCurrentBlock();
        }


        function __sort($a_ids,$a_table,$a_field,$a_id_name)
        {
                global $ilDB;

                if(!$a_ids)
                {
                        return array();
                }

                // use database to sort user array
                $where = "WHERE ".$a_id_name." IN ('";
                $where .= implode("','",$a_ids);
                $where .= "') ";

                $query = "SELECT ".$a_id_name." FROM ".$a_table." ".
                        $where.
                        "ORDER BY ".$a_field;

                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $ids[] = $row->$a_id_name;
                }
                return $ids ? $ids : array();
        }

        function __getPercent($max,$reached)
        {
                if(!$max)
                {
                        return "0%";
                }

                return sprintf("%.2f%%",$reached / $max * 100);
        }

        function __readItemStatusInfo($a_items)
        {
                global $ilObjDataCache;

                foreach($a_items as $item_id)
                {
                        $this->obj_data[$item_id]['mode'] = ilLPObjSettings::_lookupMode($item_id);
                        $this->obj_data[$item_id]['type'] = $ilObjDataCache->lookupType($item_id);
                        if($this->obj_data[$item_id]['mode'] == LP_MODE_TLT)
                        {
                                include_once './Services/MetaData/classes/class.ilMDEducational.php';
                                $this->obj_data[$item_id]['tlt'] = ilMDEducational::_getTypicalLearningTimeSeconds($item_id);
                        }
                        if($this->obj_data[$item_id]['mode'] == LP_MODE_VISITS)
                        {
                                include_once './Services/Tracking/classes/class.ilLPObjSettings.php';
                                $this->obj_data[$item_id]['visits'] = ilLPObjSettings::_lookupVisits($item_id);
                        }
                        if($this->obj_data[$item_id]['mode'] == LP_MODE_SCORM)
                        {
                                include_once './Services/Tracking/classes/class.ilLPCollections.php';
                                $this->obj_data[$item_id]['scos'] = count(ilLPCollections::_getItems($item_id));
                        }
                }
        }


        function __getStatusInfo($a_obj_id,$a_user_id)
        {
                switch($this->obj_data[$a_obj_id]['mode'])
                {
                        case LP_MODE_TEST_PASSED:
                                // Get stored test results
                                include_once './Services/Tracking/classes/class.ilTestResultCache.php';
                                $test_res_cache =& ilTestResultCache::_getInstance();
                                $result = $test_res_cache->get($a_obj_id);

                                foreach($result as $res)
                                {
                                        if($a_user_id == $res['user_id'])
                                        {
                                                return array($this->lng->txt('trac_reached_points'),
                                                                         $this->__getPercent($res['max_points'],$res['reached_points']));
                                        }
                                }
                                        return array($this->lng->txt('trac_reached_points'),
                                                                 "0.00%");
                                                                 
                        case LP_MODE_TLT:
                                if(!$this->obj_data[$a_obj_id]['tlt'])
                                {
                                        return false;
                                }
                                include_once './Services/Tracking/classes/class.ilLearningProgress.php';
                                $user_data = ilLearningProgress::_getProgress($a_user_id,$a_obj_id);

                                return array($this->lng->txt('trac_edit_time'),
                                                         $this->__getPercent($this->obj_data[$a_obj_id]['tlt'],$user_data['spent_time']));

                        case LP_MODE_VISITS:
                                if(!$this->obj_data[$a_obj_id]['visits'])
                                {
                                        return false;
                                }
                                $user_data = ilLearningProgress::_getProgress($a_user_id,$a_obj_id);

                                return array($this->lng->txt('trac_reached_visits'),
                                                         $this->__getPercent($this->obj_data[$a_obj_id]['visits'],$user_data['visits']));

                        case LP_MODE_SCORM:
                                if(!$this->obj_data[$a_obj_id]['scos'])
                                {
                                        return false;
                                }
                                $scorm_data = $this->__readScormCompleted($a_obj_id);
                                return array($this->lng->txt('trac_edited_scos'),
                                                         $this->__getPercent($this->obj_data[$a_obj_id]['scos'],$scorm_data[$a_user_id]));
                }
        }

        function __readScormCompleted($a_obj_id)
        {
                if(is_array($this->scorm_data[$a_obj_id]))
                {
                        return $this->scorm_data[$a_obj_id];
                }

                include_once './content/classes/SCORM/class.ilObjSCORMTracking.php';
                include_once './Services/Tracking/classes/class.ilLPCollections.php';

                $this->scorm_data[$a_obj_id] = ilObjSCORMTracking::_getCountCompletedPerUser(ilLPCollections::_getItems($a_obj_id),$a_obj_id);
                return $this->scorm_data[$a_obj_id];
        }       
}
?>