class.ilObjUserTracking.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "./Services/Object/classes/class.ilObject.php";

class ilObjUserTracking extends ilObject
{
        var $valid_time;
        var $extended_data;
        var $learning_progress;
        var $tracking_user_related;
        var $object_statistics_enabled;                 
        var $lp_learner;
        var $session_statistics_enabled;
        var $lp_list_gui;

        // BEGIN ChangeEvent
        private $is_change_event_tracking_enabled;
        // BEGIN ChangeEvent

        const EXTENDED_DATA_LAST_ACCESS = 1;
        const EXTENDED_DATA_READ_COUNT = 2;
        const EXTENDED_DATA_SPENT_SECONDS = 4;
        
        const DEFAULT_TIME_SPAN = 300;

        function __construct($a_id = 0,$a_call_by_reference = true)
        {
                $this->type = "trac";
                parent::__construct($a_id,$a_call_by_reference);

                $this->__readSettings();
        }

        function enableLearningProgress($a_enable)
        {
                $this->learning_progress = (bool)$a_enable;
        }

        function enabledLearningProgress()
        {
                return $this->learning_progress;
        }

        static function _enabledLearningProgress()
        {
                global $ilSetting;

                return (bool)$ilSetting->get("enable_tracking", 0);
        }

        function enableUserRelatedData($a_enable)
        {
                $this->tracking_user_related = (bool)$a_enable;
        }

        function enabledUserRelatedData()
        {
                return (bool)$this->tracking_user_related;
        }

        static function _enabledUserRelatedData()
        {
                global $ilSetting;
                
                return (bool)$ilSetting->get('save_user_related_data');
        }
        
        static function _enabledObjectStatistics()
        {
                global $ilSetting;
                
                return (bool)$ilSetting->get('object_statistics', 0);
        }
        
        public function enableObjectStatistics($newValue)
        {
                $this->object_statistics_enabled = (bool)$newValue;
        }
        public function enabledObjectStatistics()
        {
                return (bool)$this->object_statistics_enabled;
        }
        
        public function enableSessionStatistics($newValue)
        {
                $this->session_statistics_enabled = (bool)$newValue;
        }
        public function enabledSessionStatistics()
        {
                return (bool)$this->session_statistics_enabled;
        }
        
        static function _enabledSessionStatistics()
        {
                global $ilSetting;
                
                return (bool)$ilSetting->get('session_statistics', 1);
        }

        function setValidTimeSpan($a_time_span)
        {
                $this->valid_time = (int)$a_time_span;
        }

        function getValidTimeSpan()
        {
                return (int)$this->valid_time;
        } 
        
        static function _getValidTimeSpan()
        {
                global $ilSetting;
                
                return (int)$ilSetting->get("tracking_time_span", self::DEFAULT_TIME_SPAN);
        }

        // BEGIN ChangeEvent
        public function enableChangeEventTracking($newValue)
        {
                $this->is_change_event_tracking_enabled = (bool)$newValue;
        }
        public function enabledChangeEventTracking()
        {
                return (bool)$this->is_change_event_tracking_enabled;
        }
        // END ChangeEvent
        
        function setExtendedData($a_value)
        {
                $this->extended_data = $a_value;
        }

        function hasExtendedData($a_code)
        {
                return $this->extended_data & $a_code;
        }

        function updateSettings()
        {
                global $ilSetting;

                $ilSetting->set("enable_tracking", (int)$this->enabledLearningProgress());
                $ilSetting->set("save_user_related_data", (int)$this->enabledUserRelatedData());
                $ilSetting->set("tracking_time_span",$this->getValidTimeSpan());
                $ilSetting->set("lp_extended_data", $this->extended_data);
                $ilSetting->set("object_statistics", (int)$this->enabledObjectStatistics());            
                // $ilSetting->set("lp_desktop", (int)$this->hasLearningProgressDesktop());             
                $ilSetting->set("lp_learner", (int)$this->hasLearningProgressLearner());
                $ilSetting->set("session_statistics", (int)$this->enabledSessionStatistics());
                $ilSetting->set("lp_list_gui", (int)$this->hasLearningProgressListGUI());

                /* => REPOSITORY
                // BEGIN ChangeEvent
                require_once 'Services/Tracking/classes/class.ilChangeEvent.php';
                if ($this->enabledChangeEventTracking() != ilChangeEvent::_isActive())
                {
                        if ($this->enabledChangeEventTracking())
                        {
                                ilChangeEvent::_activate();
                        }
                        else
                        {
                                ilChangeEvent::_deactivate();
                        }
                }
                // END ChangeEvent
                */
                
                return true;
        }

        protected function __readSettings()
        {
                global $ilSetting;

                $this->enableLearningProgress($ilSetting->get("enable_tracking",0));
                $this->enableUserRelatedData($ilSetting->get("save_user_related_data",0));
                $this->enableObjectStatistics($ilSetting->get("object_statistics",0));
                $this->setValidTimeSpan($ilSetting->get("tracking_time_span", self::DEFAULT_TIME_SPAN));
                // $this->setLearningProgressDesktop($ilSetting->get("lp_desktop", 1));
                $this->setLearningProgressLearner($ilSetting->get("lp_learner", 1));
                $this->enableSessionStatistics($ilSetting->get("session_statistics", 1)); 
                $this->setLearningProgressListGUI($ilSetting->get("lp_list_gui", 0));

                // BEGIN ChangeEvent
                require_once 'Services/Tracking/classes/class.ilChangeEvent.php';
                $this->enableChangeEventTracking(ilChangeEvent::_isActive());
                // END ChangeEvent
                
                $this->setExtendedData($ilSetting->get("lp_extended_data"),0);

                return true;
        }

        static function _deleteUser($a_usr_id)
        {
                global $ilDB;

                $query = sprintf('DELETE FROM read_event WHERE usr_id = %s ',
                        $ilDB->quote($a_usr_id,'integer'));
                $aff = $ilDB->manipulate($query);                       

                $query = sprintf('DELETE FROM write_event WHERE usr_id = %s ',
                        $ilDB->quote($a_usr_id,'integer'));
                $aff = $ilDB->manipulate($query);

                $query = "DELETE FROM ut_lp_marks WHERE usr_id = ".$ilDB->quote($a_usr_id ,'integer')." ";
                $res = $ilDB->manipulate($query);

                $ilDB->manipulate("DELETE FROM ut_online WHERE usr_id = ".
                        $ilDB->quote($a_usr_id, "integer"));

                return true;
        }
        
        static function _hasLearningProgressOtherUsers()
        {               
                global $rbacsystem;
                
                $obj_id = array_pop(array_keys(ilObject::_getObjectsByType("trac")));   
                $ref_id = array_pop(ilObject::_getAllReferences($obj_id));
                
                return $rbacsystem->checkAccess("lp_other_users", $ref_id);
        }
        
        function setLearningProgressLearner($a_value)
        {
                $this->lp_learner = (bool)$a_value;
        }
        
        function hasLearningProgressLearner()
        {
                return (bool)$this->lp_learner;
        }
        
        static function _hasLearningProgressLearner()
        {
                global $ilSetting;
                                        
                return (bool)$ilSetting->get("lp_learner", 1);
        }
        
        function setLearningProgressListGUI($a_value)
        {
                $this->lp_list_gui = (bool)$a_value;
        }
        
        function hasLearningProgressListGUI()
        {
                return (bool)$this->lp_list_gui;
        }
        
        static function _hasLearningProgressListGUI()
        {
                global $ilSetting;
                                        
                return (bool)$ilSetting->get("lp_list_gui", 0);
        }

} // END class.ilObjUserTracking
?>