class.ilTestEvaluationUserData.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 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. |
        +-----------------------------------------------------------------------------+
*/

include_once "./Services/Object/classes/class.ilObject.php";
include_once "./Modules/Test/classes/inc.AssessmentConstants.php";

class ilTestEvaluationUserData
{
        var $name;

        var $login;

        var $user_id;

        var $reached;

        var $maxpoints;

        var $mark;

        var $mark_official;

        var $markECTS;

        var $questionsWorkedThrough;

        var $numberOfQuestions;

        var $timeOfWork;

        var $firstVisit;

        var $lastVisit;
        
        var $passed;
        
        var $passes;

        var $questions;
        
        private $passScoring;

        public function __sleep()
        {
                return array('questions', 'passes', 'passed', 'lastVisit', 'firstVisit', 'timeOfWork', 'numberOfQuestions', 
                'questionsWorkedThrough', 'markECTS', 'mark_official', 'mark', 'maxpoints', 'reached', 'user_id', 'login', 
                'name', 'passScoring');
        }

        function ilTestEvaluationUserData($passScoring)
        {
                $this->passes = array();
                $this->questions = array();
                $this->passed = FALSE;
                $this->passScoring = $passScoring;
        }
        
        function getPassScoring()
        {
                return $this->passScoring;
        }
        
        function setPassScoring($passScoring)
        {
                $this->passScoring = $passScoring;
        }
        
        function getPassed()
        {
                return $this->passed;
        }
        
        function setPassed($a_passed)
        {
                $this->passed = ($a_passed ? TRUE : FALSE);
        }
        
        function getName()
        {
                return $this->name;
        }
        
        function setName($a_name)
        {
                $this->name = $a_name;
        }
        
        function getLogin()
        {
                return $this->login;
        }
        
        function setLogin($a_login)
        {
                $this->login = $a_login;
        }
        
        function getReached()
        {
                return $this->getReachedPoints($this->getScoredPass());
        }
        
        function setReached($a_reached)
        {
                $this->reached = $a_reached;
        }
        
        function getMaxpoints()
        {
                return $this->getAvailablePoints($this->getScoredPass());
        }
        
        function setMaxpoints($a_max_points)
        {
                $this->maxpoints = $a_max_points;
        }
        
        function getReachedPointsInPercent()
        {
                return $this->getMaxPoints() ? $this->getReached() / $this->getMaxPoints() * 100.0 : 0;
        }
        
        function getMark()
        {
                return $this->mark;
        }
        
        function setMark($a_mark)
        {
                $this->mark = $a_mark;
        }
        
        function getECTSMark()
        {
                return $this->markECTS;
        }
        
        function setECTSMark($a_mark_ects)
        {
                $this->markECTS = $a_mark_ects;
        }
        
        function getQuestionsWorkedThrough()
        {
                $questionpass = $this->getScoredPass();
                if (!is_object($this->passes[$questionpass])) $questionpass = 0;
                if (is_object($this->passes[$questionpass])) 
                {
                        return $this->passes[$questionpass]->getNrOfAnsweredQuestions();
                }
                return 0;
        }
        
        function setQuestionsWorkedThrough($a_nr)
        {
                $this->questionsWorkedThrough = $a_nr;
        }

        function getNumberOfQuestions()
        {
                $questionpass = $this->getScoredPass();
                if (!is_object($this->passes[$questionpass])) $questionpass = 0;
                if (is_object($this->passes[$questionpass])) 
                {
                        return $this->passes[$questionpass]->getQuestionCount();
                }
                return 0;
//              return $this->numberOfQuestions;
        }
        
        function setNumberOfQuestions($a_nr)
        {
                $this->numberOfQuestions = $a_nr;
        }
        
        function getQuestionsWorkedThroughInPercent()
        {
                return $this->getNumberOfQuestions() ? $this->getQuestionsWorkedThrough() / $this->getNumberOfQuestions() * 100.0 : 0;
        }
        
        function getTimeOfWork()
        {
                $time = 0;
                foreach ($this->passes as $pass)
                {
                        $time += $pass->getWorkingTime();
                }
                return $time;
        }
        
        function setTimeOfWork($a_time_of_work)
        {
                $this->timeOfWork = $a_time_of_work;
        }
        
        function getFirstVisit()
        {
                return $this->firstVisit;
        }
        
        function setFirstVisit($a_time)
        {
                $this->firstVisit = $a_time;
        }
        
        function getLastVisit()
        {
                return $this->lastVisit;
        }
        
        function setLastVisit($a_time)
        {
                $this->lastVisit = $a_time;
        }
        
        function getPasses()
        {
                return $this->passes;
        }
        
        function addPass($pass_nr, $pass)
        {
                $this->passes[$pass_nr] = $pass;
        }
        
        function &getPass($pass_nr)
        {
                if (array_key_exists($pass_nr, $this->passes))
                {
                        return $this->passes[$pass_nr];
                }
                else
                {
                        return NULL;
                }
        }
        
        function getPassCount()
        {
                return count($this->passes);
        }

        function getScoredPass()
        {
                if ($this->getPassScoring() == 1)
                {
                        return $this->getBestPass();
                }
                else
                {
                        return $this->getLastPass();
                }
        }
        
        function getBestPass()
        {
                $bestpoints = 0;
                $bestpass = 0;
                
                $obligationsAnsweredPassExists = $this->doesObligationsAnsweredPassExist();
                
                foreach( $this->passes as $pass )
                {
                        $reached = $this->getReachedPointsInPercentForPass( $pass->getPass() );
                        
                        if($reached >= $bestpoints && ($pass->areObligationsAnswered() || !$obligationsAnsweredPassExists) )
                        {
                                $bestpoints = $reached;
                                $bestpass = $pass->getPass();
                        }
                }
                
                return $bestpass;
        }
        
        function getLastPass()
        {
                $lastpass = 0;
                foreach (array_keys($this->passes) as $pass)
                {
                        if ($pass > $lastpass) $lastpass = $pass;
                }
                return $lastpass;
        }
        
        function addQuestionTitle($question_id, $question_title)
        {
                $this->questionTitles[$question_id] = $question_title;
        }
        
        function getQuestionTitles()
        {
                return $this->questionTitles;
        }

        function &getQuestions($pass = 0)
        {
                if (array_key_exists($pass, $this->questions))
                {
                        return $this->questions[$pass];
                }
                else
                {
                        return NULL;
                }
        }
        
        function addQuestion($original_id, $question_id, $max_points, $sequence = NULL, $pass = 0)
        {
                if( !isset($this->questions[$pass]) )
                {
                        $this->questions[$pass] = array();
                }
                
                $this->questions[$pass][] = array(
                        "id" => $question_id,
                        "o_id" => $original_id,
                        "points" => $max_points,
                        "sequence" => $sequence
                );
        }
        
        function &getQuestion($index, $pass = 0)
        {
                if (array_key_exists($index, $this->questions[$pass]))
                {
                        return $this->questions[$pass][$index];
                }
                else
                {
                        return NULL;
                }
        }
        
        function getQuestionCount($pass = 0)
        {
                $count = 0;
                if (array_key_exists($pass, $this->passes))
                {
                        $count = $this->passes[$pass]->getQuestionCount();
                }
                return $count;
        }

        function getReachedPoints($pass = 0)
        {
                $reached = 0;
                if (array_key_exists($pass, $this->passes))
                {
                        $reached = $this->passes[$pass]->getReachedPoints();
                }
                $reached = ($reached < 0) ? 0 : $reached;
                $reached = round($reached, 2);
                return $reached;
        }

        function getAvailablePoints($pass = 0)
        {
                $available = 0;
                if (!is_object($this->passes[$pass])) $pass = 0;
                if (!is_object($this->passes[$pass])) return 0;
                $available = $this->passes[$pass]->getMaxPoints();
                $available = round($available, 2);
                return $available;
        }

        function getReachedPointsInPercentForPass($pass = 0)
        {
                $reached = $this->getReachedPoints($pass);
                $available = $this->getAvailablePoints($pass);
                $percent = ($available > 0 ) ? $reached / $available : 0;
                return $percent;
        }

        function setUserID($a_usr_id)
        {
                $this->user_id = $a_usr_id;
        }
        
        function getUserID()
        {
                return $this->user_id;
        }

        function setMarkOfficial($a_mark_official)
        {
                $this->mark_official = $a_mark_official;
        }
        
        function getMarkOfficial()
        {
                return $this->mark_official;
        }

        public function getScoredPassObject()
        {
                if ($this->getPassScoring() == 1)
                {
                        return $this->getBestPassObject();
                }
                else
                {
                        return $this->getLastPassObject();
                }
        }
        
        public function getRequestedHintsCountFromScoredPass()
        {
                return $this->getRequestedHintsCount($this->getScoredPass());
        }
        
        public function getRequestedHintsCount($pass)
        {
                if( !isset($this->passes[$pass]) || !($this->passes[$pass] instanceof ilTestEvaluationPassData) )
                {
                        throw new ilTestException("invalid pass index given: $pass");
                }
                
                $requestedHintsCount = $this->passes[$pass]->getRequestedHintsCount();
                
                return $requestedHintsCount;
        }
        
        public function getBestPassObject()
        {
                $bestpoints = 0;
                $bestpassObject = 0;
                
                $obligationsAnsweredPassExists = $this->doesObligationsAnsweredPassExist();
                
                foreach( $this->passes as $pass )
                {
                        $reached = $this->getReachedPointsInPercentForPass( $pass->getPass() );
                        
                        if($reached >= $bestpoints && ($pass->areObligationsAnswered() || !$obligationsAnsweredPassExists) )
                        {
                                $bestpoints = $reached;
                                $bestpassObject = $pass;
                        }
                }
                
                return $bestpassObject;
        }
        
        public function getLastPassObject()
        {
                $lastpassIndex = 0;

                foreach( array_keys($this->passes) as $passIndex )
                {
                        if ($passIndex > $lastpassIndex) $lastpassIndex = $passIndex;
                }
                
                $lastpassObject = $this->passes[$lastpassIndex];
                
                return $lastpassObject;
        }
        
        public function doesObligationsAnsweredPassExist()
        {
                foreach( $this->passes as $pass )
                {
                        if( $pass->areObligationsAnswered() )
                        {
                                return true;
                        }
                }
                
                return false;
        }
        
        public function areObligationsAnswered()
        {
                return $this->getScoredPassObject()->areObligationsAnswered();
        }
        
} // END ilTestEvaluationUserData