Survey evaluation answers. More...

Collaboration diagram for ilSurveyEvaluationResults:

Public Member Functions
	__construct (SurveyQuestion $a_question)

	getQuestion ()

	setUsersAnswered ($a_value)

	getUsersAnswered ()

	setUsersSkipped ($a_value)

	getUsersSkipped ()

	setMode ($a_value, $a_nr_of_selections)

	getModeValue ()

	getModeValueAsText ()

	getModeNrOfSelections ()

	setMean ($a_mean)

	getMean ()

	setMedian ($a_value)

	getMedian ()

	getMedianAsText ()

	addVariable (ilSurveyEvaluationResultsVariable $a_variable)

	getVariables ()

	addAnswer (ilSurveyEvaluationResultsAnswer $a_answer)

	getAnswers ()

	getMappedTextAnswers ()

	getUserResults ($a_active_id)

Protected Member Functions
	getScaleText ($a_value)

	getCatTitle ($a_value)

Protected Attributes
	$question

	$users_answered

	$users_skipped

	$mode_value

	$mode_nr_of_selections

	$arithmetic_mean

	$median

	$variables = array()

	$answers = array()

Detailed Description

Survey evaluation answers.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 10 of file class.ilSurveyEvaluationResults.php.

Constructor & Destructor Documentation

◆ __construct()

ilSurveyEvaluationResults::__construct ( SurveyQuestion $a_question )

Definition at line 22 of file class.ilSurveyEvaluationResults.php.

         {               
                 $this->question = $a_question;
         }

Member Function Documentation

◆ addAnswer()

ilSurveyEvaluationResults::addAnswer ( ilSurveyEvaluationResultsAnswer $a_answer )

Definition at line 150 of file class.ilSurveyEvaluationResults.php.

Referenced by SurveyQuestionEvaluation\parseResults().

         {
                 $this->answers[] = $a_answer;
         }       

Here is the caller graph for this function:

◆ addVariable()

ilSurveyEvaluationResults::addVariable ( ilSurveyEvaluationResultsVariable $a_variable )

Definition at line 137 of file class.ilSurveyEvaluationResults.php.

Referenced by SurveyQuestionEvaluation\parseResults().

         {
                 $this->variables[] = $a_variable;
         }

Here is the caller graph for this function:

◆ getAnswers()

ilSurveyEvaluationResults::getAnswers ( )

Definition at line 155 of file class.ilSurveyEvaluationResults.php.

References $answers.

Referenced by getUserResults().

         {
                 if(sizeof($this->answers))
                 {
                         return $this->answers;
                 }
         }

Here is the caller graph for this function:

◆ getCatTitle()

ilSurveyEvaluationResults::getCatTitle ( $a_value )

protected

Definition at line 181 of file class.ilSurveyEvaluationResults.php.

         {
                 if(!sizeof($this->variables))
                 {
                         return $a_value;
                 }
                 else
                 {
                         foreach($this->variables as $var)
                         {
                                 if($var->cat->scale == $a_value)
                                 {
                                         return $var->cat->title;
                                 }
                         }
                 }
         }

◆ getMappedTextAnswers()

ilSurveyEvaluationResults::getMappedTextAnswers ( )

Definition at line 199 of file class.ilSurveyEvaluationResults.php.

References $res, array, and getScaleText().

         {
                 $res = array();
                 
                 foreach($this->answers as $answer)
                 {
                         if($answer->text)
                         {                               
                                 $res[$this->getScaleText($answer->value)][] = $answer->text;
                         }
                 }
                 
                 return $res;
         }

Here is the call graph for this function:

◆ getMean()

ilSurveyEvaluationResults::getMean ( )

Definition at line 98 of file class.ilSurveyEvaluationResults.php.

References $arithmetic_mean.

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

         {
                 return $this->arithmetic_mean;
         }

Here is the caller graph for this function:

◆ getMedian()

ilSurveyEvaluationResults::getMedian ( )

Definition at line 110 of file class.ilSurveyEvaluationResults.php.

References $median.

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

         {
                 return $this->median;
         }       

Here is the caller graph for this function:

◆ getMedianAsText()

ilSurveyEvaluationResults::getMedianAsText ( )

Definition at line 115 of file class.ilSurveyEvaluationResults.php.

References $lng, and getScaleText().

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

         {
                 global $lng;
                 
                 if($this->median === null)
                 {
                         return;
                 }
                 
                 if(!is_array($this->median))
                 {
                         return $this->getScaleText($this->median);
                 }
                 else
                 {
                         return $lng->txt("median_between")." ".
                                 $this->getScaleText($this->median[0])." ".
                                 $lng->txt("and")." ".
                                 $this->getScaleText($this->median[1]);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModeNrOfSelections()

ilSurveyEvaluationResults::getModeNrOfSelections ( )

Definition at line 88 of file class.ilSurveyEvaluationResults.php.

References $mode_nr_of_selections.

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

         {
                 return $this->mode_nr_of_selections;
         }

Here is the caller graph for this function:

◆ getModeValue()

ilSurveyEvaluationResults::getModeValue ( )

Definition at line 60 of file class.ilSurveyEvaluationResults.php.

References $mode_value.

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

         {
                 return $this->mode_value;
         }

Here is the caller graph for this function:

◆ getModeValueAsText()

ilSurveyEvaluationResults::getModeValueAsText ( )

Definition at line 65 of file class.ilSurveyEvaluationResults.php.

References $mode_value, $res, array, and getScaleText().

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

         {
                 if($this->mode_value === null)
                 {
                         return;
                 }
                 
                 $res = array();
                 
                 $mvalues = $this->mode_value;
                 if(!is_array($mvalues))
                 {
                         $mvalues = array($mvalues);
                 }
                 sort($mvalues, SORT_NUMERIC);
                 foreach($mvalues as $value)
                 {
                         $res[] = $this->getScaleText($value);
                 }
                 
                 return implode(", ", $res);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestion()

ilSurveyEvaluationResults::getQuestion ( )

Definition at line 27 of file class.ilSurveyEvaluationResults.php.

References $question.

         {
                 return $this->question;
         }

◆ getScaleText()

ilSurveyEvaluationResults::getScaleText ( $a_value )

protected

Definition at line 163 of file class.ilSurveyEvaluationResults.php.

Referenced by getMappedTextAnswers(), getMedianAsText(), getModeValueAsText(), and getUserResults().

         {
                 if(!sizeof($this->variables))
                 {
                         return $a_value;
                 }
                 else
                 {
                         foreach($this->variables as $var)
                         {
                                 if($var->cat->scale == $a_value)
                                 {
                                         return $var->cat->title." [".$a_value."]";
                                 }
                         }                               
                 }
         }

Here is the caller graph for this function:

◆ getUserResults()

ilSurveyEvaluationResults::getUserResults ( $a_active_id )

Definition at line 214 of file class.ilSurveyEvaluationResults.php.

References $answers, $res, array, getAnswers(), and getScaleText().

         {
                 $res = array();
         
                 $answers = $this->getAnswers();
                 if($answers)
                 {
                         foreach($answers as $answer)
                         {
                                 if($answer->active_id == $a_active_id)
                                 {
                                         $res[] = array(
                                                 $this->getScaleText($answer->value), 
                                                 $answer->text,
                                                 $answer->value,
                                                 $this->getCatTitle($answer->value)
                                         );
                                 }
                         }
                 }       
                 
                 return $res;
         }

Here is the call graph for this function:

◆ getUsersAnswered()

ilSurveyEvaluationResults::getUsersAnswered ( )

Definition at line 37 of file class.ilSurveyEvaluationResults.php.

References $users_answered.

         {
                 return $this->users_answered;
         }

◆ getUsersSkipped()

ilSurveyEvaluationResults::getUsersSkipped ( )

Definition at line 47 of file class.ilSurveyEvaluationResults.php.

References $users_skipped.

         {
                 return $this->users_skipped;
         }

◆ getVariables()

ilSurveyEvaluationResults::getVariables ( )

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

References $variables.

         {
                 if(sizeof($this->variables))
                 {
                         return $this->variables;
                 }
         }

◆ setMean()

ilSurveyEvaluationResults::setMean ( $a_mean )

Definition at line 93 of file class.ilSurveyEvaluationResults.php.

Referenced by SurveyMetricQuestionEvaluation\parseResults().

         {
                 $this->arithmetic_mean = (float)$a_mean;
         }

Here is the caller graph for this function:

◆ setMedian()

ilSurveyEvaluationResults::setMedian ( $a_value )

Definition at line 103 of file class.ilSurveyEvaluationResults.php.

Referenced by SurveyQuestionEvaluation\parseResults().

         {
                 $this->median = is_array($a_value)
                         ? $a_value
                         : trim($a_value);
         }       

Here is the caller graph for this function:

◆ setMode()

ilSurveyEvaluationResults::setMode	(	$a_value,
		$a_nr_of_selections
	)

Definition at line 52 of file class.ilSurveyEvaluationResults.php.

Referenced by SurveyQuestionEvaluation\parseResults().

         {
                 $this->mode_value = is_array($a_value)
                         ? $a_value
                         : trim($a_value);
                 $this->mode_nr_of_selections = (int)$a_nr_of_selections;
         }

Here is the caller graph for this function:

◆ setUsersAnswered()

ilSurveyEvaluationResults::setUsersAnswered ( $a_value )

Definition at line 32 of file class.ilSurveyEvaluationResults.php.

Referenced by SurveyQuestionEvaluation\parseResults().

         {
                 $this->users_answered = (int)$a_value;
         }

Here is the caller graph for this function:

◆ setUsersSkipped()

ilSurveyEvaluationResults::setUsersSkipped ( $a_value )

Definition at line 42 of file class.ilSurveyEvaluationResults.php.

Referenced by SurveyQuestionEvaluation\parseResults().

         {
                 $this->users_skipped = (int)$a_value;
         }

Here is the caller graph for this function:

Field Documentation

◆ $answers

ilSurveyEvaluationResults::$answers = array()

protected

Definition at line 20 of file class.ilSurveyEvaluationResults.php.

Referenced by getAnswers(), and getUserResults().

◆ $arithmetic_mean

ilSurveyEvaluationResults::$arithmetic_mean

protected

Definition at line 17 of file class.ilSurveyEvaluationResults.php.

Referenced by getMean().

◆ $median

ilSurveyEvaluationResults::$median

protected

Definition at line 18 of file class.ilSurveyEvaluationResults.php.

Referenced by getMedian().

◆ $mode_nr_of_selections

ilSurveyEvaluationResults::$mode_nr_of_selections

protected

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

Referenced by getModeNrOfSelections().

◆ $mode_value

ilSurveyEvaluationResults::$mode_value

protected

Definition at line 15 of file class.ilSurveyEvaluationResults.php.

Referenced by getModeValue(), and getModeValueAsText().

◆ $question

ilSurveyEvaluationResults::$question

protected

Definition at line 12 of file class.ilSurveyEvaluationResults.php.

Referenced by getQuestion().

◆ $users_answered

ilSurveyEvaluationResults::$users_answered

protected

Definition at line 13 of file class.ilSurveyEvaluationResults.php.

Referenced by getUsersAnswered().

◆ $users_skipped

ilSurveyEvaluationResults::$users_skipped

protected

Definition at line 14 of file class.ilSurveyEvaluationResults.php.

Referenced by getUsersSkipped().

◆ $variables

ilSurveyEvaluationResults::$variables = array()

protected

Definition at line 19 of file class.ilSurveyEvaluationResults.php.

Referenced by getVariables().

The documentation for this class was generated from the following file:

Modules/Survey/classes/class.ilSurveyEvaluationResults.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAnswer()

◆ addVariable()

◆ getAnswers()

◆ getCatTitle()

◆ getMappedTextAnswers()

◆ getMean()

◆ getMedian()

◆ getMedianAsText()

◆ getModeNrOfSelections()

◆ getModeValue()

◆ getModeValueAsText()

◆ getQuestion()

◆ getScaleText()

◆ getUserResults()

◆ getUsersAnswered()

◆ getUsersSkipped()

◆ getVariables()

◆ setMean()

◆ setMedian()

◆ setMode()

◆ setUsersAnswered()

◆ setUsersSkipped()

Field Documentation

◆ $answers

◆ $arithmetic_mean

◆ $median

◆ $mode_nr_of_selections

◆ $mode_value

◆ $question

◆ $users_answered

◆ $users_skipped

◆ $variables