Survey question evaluation. More...

Inheritance diagram for SurveyQuestionEvaluation:

Collaboration diagram for SurveyQuestionEvaluation:

Public Member Functions
	__construct (SurveyQuestion $a_question, array $a_finished_ids=null)
	Constructor. More...

	getResults ()
	Get results. More...

	parseUserSpecificResults ($a_qres, $a_user_id)

	getGrid ($a_results, $a_abs=true, $a_perc=true)
	Get grid data. More...

	getTextAnswers ($a_results)
	Get text answers. More...

	getChart ($a_results)
	Get chart. More...

	getSkippedValue ()
	Get caption for skipped value. More...

	exportResults ($a_results, $a_do_title, $a_do_label)

	getExportGrid ($a_results)
	Get grid data. More...

	getUserSpecificVariableTitles (array &$a_title_row, array &$a_title_row2, $a_do_title, $a_do_label)
	Get title columns for user-specific export. More...

	addUserSpecificResults (array &$a_row, $a_user_id, $a_results)

Protected Member Functions
	parseResults (ilSurveyEvaluationResults $a_results, array $a_answers, SurveyCategories $a_categories=null)
	Parse answer data into results instance. More...

	getChartColors ()

	getSurveyId ()

	getNrOfParticipants ()
	Returns the number of participants for a survey. More...

	getAnswerData ()

Protected Attributes
	$lng

	$db

	$question

	$finished_ids

	$chart_width = 400

	$chart_height = 300

Detailed Description

Survey question evaluation.

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 12 of file class.SurveyQuestionEvaluation.php.

Constructor & Destructor Documentation

◆ __construct()

SurveyQuestionEvaluation::__construct	(	SurveyQuestion	$a_question,
		array	$a_finished_ids = `null`
	)

Constructor.

Parameters

SurveyQuestion	$a_question
array	$a_finished_ids

Returns: self

Definition at line 36 of file class.SurveyQuestionEvaluation.php.

References $DIC.

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->db = $DIC->database();
         $this->question = $a_question;
         $this->finished_ids = $a_finished_ids;
     }

Member Function Documentation

◆ addUserSpecificResults()

SurveyQuestionEvaluation::addUserSpecificResults	(	array &	$a_row,
			$a_user_id,
			$a_results
	)

abstract

Parameters

array	$a_row
int	$a_user_id
ilSurveyEvaluationResults \| array	$a_results

Referenced by getUserSpecificVariableTitles().

Here is the caller graph for this function:

◆ exportResults()

SurveyQuestionEvaluation::exportResults	(	$a_results,
		$a_do_title,
		$a_do_label
	)

Definition at line 442 of file class.SurveyQuestionEvaluation.php.

References $question, $res, and SurveyQuestion\_getQuestionTypeName().

     {
         $question = $a_results->getQuestion();
         
         $res = array();
         
         if ($a_do_title) {
             $res[] = $question->getTitle();
         }
         if ($a_do_label) {
             $res[] = $question->label;
         }
         
         $res[] = $question->getQuestiontext();
         $res[] = SurveyQuestion::_getQuestionTypeName($question->getQuestionType());
         
         $res[] = (int) $a_results->getUsersAnswered();
         $res[] = (int) $a_results->getUsersSkipped();
         
         // :TODO:
         $res[] = is_array($a_results->getModeValue())
             ? implode(", ", $a_results->getModeValue())
             : $a_results->getModeValue();
         
         $res[] = $a_results->getModeValueAsText();
         $res[] = (int) $a_results->getModeNrOfSelections();
         
         // :TODO:
         $res[] = $a_results->getMedianAsText();
         
         $res[] = $a_results->getMean();
                 
         return array($res);
     }

Here is the call graph for this function:

◆ getAnswerData()

SurveyQuestionEvaluation::getAnswerData ( )

protected

Definition at line 413 of file class.SurveyQuestionEvaluation.php.

References $db, $ilDB, $res, and $row.

Referenced by SurveyMatrixQuestionEvaluation\getResults(), and getResults().

     {
         $ilDB = $this->db;
         
         $res = array();
         
         $sql = "SELECT svy_answer.* FROM svy_answer" .
             " JOIN svy_finished ON (svy_finished.finished_id = svy_answer.active_fi)" .
             " WHERE svy_answer.question_fi = " . $ilDB->quote($this->question->getId(), "integer") .
             " AND svy_finished.survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer");
         if (is_array($this->finished_ids)) {
             $sql .= " AND " . $ilDB->in("svy_finished.finished_id", $this->finished_ids, "", "integer");
         }
         $set = $ilDB->query($sql);
         while ($row = $ilDB->fetchAssoc($set)) {
             $res[(int) $row["rowvalue"]][(int) $row["active_fi"]][] = array(
                 "value" => $row["value"],
                 "text" => $row["textanswer"]
             );
         }
         
         return $res;
     }

Here is the caller graph for this function:

◆ getChart()

SurveyQuestionEvaluation::getChart ( $a_results )

Get chart.

Parameters

ilSurveyEvaluationResults | array $a_results

Returns: array

Definition at line 321 of file class.SurveyQuestionEvaluation.php.

References $data, $legend, ilChartGrid\DATA_BARS, getChartColors(), ilChart\getInstanceByType(), and ilChart\TYPE_GRID.

Referenced by ilSurveyEvaluationGUI\renderDetails().

     {
         include_once "Services/Chart/classes/class.ilChart.php";
         $chart = ilChart::getInstanceByType(ilChart::TYPE_GRID, $a_results->getQuestion()->getId());
         $chart->setYAxisToInteger(true);
 
         $colors = $this->getChartColors();
         $chart->setColors($colors);
             
         // :TODO:
         $chart->setsize($this->chart_width, $this->chart_height);
                     
         $vars = $a_results->getVariables();
         
         $legend = $labels = array();
         foreach ($vars as $idx => $var) {
             $data = $chart->getDataInstance(ilChartGrid::DATA_BARS);
             $data->setBarOptions(0.5, "center");
             $data->setFill(1);
             $chart->addData($data);
                     
             // labels
             $labels[$idx] = "";
             $legend[] = array(
                 $var->cat->title,
                 $colors[$idx]
             );
             $data->setLabel($var->cat->title);
             
             $data->addPoint($idx, $var->abs);
         }
         
         $chart->setTicks($labels, false, true);
 
         return array(
             $chart->getHTML(),
             $legend
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChartColors()

SurveyQuestionEvaluation::getChartColors ( )

protected

Definition at line 293 of file class.SurveyQuestionEvaluation.php.

Referenced by SurveyMetricQuestionEvaluation\getChart(), SurveyMatrixQuestionEvaluation\getChart(), and getChart().

     {
         return array(
             // flot "default" theme
             "#edc240", "#afd8f8", "#cb4b4b", "#4da74d", "#9440ed",
             // http://godsnotwheregodsnot.blogspot.de/2012/09/color-distribution-methodology.html
             "#1CE6FF", "#FF34FF", "#FF4A46", "#008941", "#006FA6", "#A30059",
             "#FFDBE5", "#7A4900", "#0000A6", "#63FFAC", "#B79762", "#004D43", "#8FB0FF", "#997D87",
             "#5A0007", "#809693", "#FEFFE6", "#1B4400", "#4FC601", "#3B5DFF", "#4A3B53", "#FF2F80",
             "#61615A", "#BA0900", "#6B7900", "#00C2A0", "#FFAA92", "#FF90C9", "#B903AA", "#D16100",
             "#DDEFFF", "#000035", "#7B4F4B", "#A1C299", "#300018", "#0AA6D8", "#013349", "#00846F",
             "#372101", "#FFB500", "#C2FFED", "#A079BF", "#CC0744", "#C0B9B2", "#C2FF99", "#001E09",
             "#00489C", "#6F0062", "#0CBD66", "#EEC3FF", "#456D75", "#B77B68", "#7A87A1", "#788D66",
             "#885578", "#FAD09F", "#FF8A9A", "#D157A0", "#BEC459", "#456648", "#0086ED", "#886F4C",
             "#34362D", "#B4A8BD", "#00A6AA", "#452C2C", "#636375", "#A3C8C9", "#FF913F", "#938A81",
             "#575329", "#00FECF", "#B05B6F", "#8CD0FF", "#3B9700", "#04F757", "#C8A1A1", "#1E6E00",
             "#7900D7", "#A77500", "#6367A9", "#A05837", "#6B002C", "#772600", "#D790FF", "#9B9700",
             "#549E79", "#FFF69F", "#201625", "#72418F", "#BC23FF", "#99ADC0", "#3A2465", "#922329",
             "#5B4534", "#FDE8DC", "#404E55", "#0089A3", "#CB7E98", "#A4E804", "#324E72", "#6A3A4C"
         );
     }

Here is the caller graph for this function:

◆ getExportGrid()

SurveyQuestionEvaluation::getExportGrid ( $a_results )

Get grid data.

Parameters

ilSurveyEvaluationResults | array $a_results

Returns: array

Definition at line 483 of file class.SurveyQuestionEvaluation.php.

References $lng, and $res.

Referenced by ilSurveyEvaluationGUI\exportResultsDetailsExcel().

     {
         $lng = $this->lng;
         
         $res = array(
             "cols" => array(
                 $lng->txt("title"),
                 $lng->txt("value"),
                 $lng->txt("category_nr_selected"),
                 $lng->txt("svy_fraction_of_selections")
             ),
             "rows" => array()
         );
         
         $vars = $a_results->getVariables();
         if ($vars) {
             foreach ($vars as $var) {
                 $res["rows"][] = array(
                     $var->cat->title,
                     $var->cat->scale,
                     $var->abs,
                     $var->perc
                         ? sprintf("%.2f", $var->perc * 100) . "%"
                         : "0%"
                 );
             }
         }
         
         return $res;
     }

Here is the caller graph for this function:

◆ getGrid()

SurveyQuestionEvaluation::getGrid	(	$a_results,
		$a_abs = `true`,
		$a_perc = `true`
	)

Get grid data.

Parameters

ilSurveyEvaluationResults \| array	$a_results
bool	$a_abs
bool	$a_perc

Returns: array

Definition at line 228 of file class.SurveyQuestionEvaluation.php.

References $cols, $lng, and $res.

Referenced by ilSurveyEvaluationGUI\renderDetails().

     {
         $lng = $this->lng;
         
         if ((bool) $a_abs && (bool) $a_perc) {
             $cols = array(
                 $lng->txt("category_nr_selected"),
                 $lng->txt("svy_fraction_of_selections")
             );
         } elseif ((bool) $a_abs) {
             $cols = array(
                 $lng->txt("category_nr_selected")
             );
         } else {
             $cols = array(
                 $lng->txt("svy_fraction_of_selections")
             );
         }
                 
         $res = array(
             "cols" => $cols,
             "rows" => array()
         );
         
         $vars = $a_results->getVariables();
         if ($vars) {
             foreach ($vars as $var) {
                 $perc = $var->perc
                     ? sprintf("%.2f", $var->perc * 100) . "%"
                     : "0%";
                 
                 if ((bool) $a_abs && (bool) $a_perc) {
                     $res["rows"][] = array(
                         $var->cat->title,
                         $var->abs,
                         $perc
                     );
                 } elseif ((bool) $a_abs) {
                     $res["rows"][] = array(
                         $var->cat->title,
                         $var->abs
                     );
                 } else {
                     $res["rows"][] = array(
                         $var->cat->title,
                         $perc
                     );
                 }
             }
         }
         
         return $res;
     }

Here is the caller graph for this function:

◆ getNrOfParticipants()

SurveyQuestionEvaluation::getNrOfParticipants ( )

protected

Returns the number of participants for a survey.

Returns: integer The number of participants

Definition at line 400 of file class.SurveyQuestionEvaluation.php.

References $db, $finished_ids, and $ilDB.

Referenced by parseResults().

     {
         $ilDB = $this->db;
         
         if (is_array($this->finished_ids)) {
             return sizeof($this->finished_ids);
         }
         
         $set = $ilDB->query("SELECT finished_id FROM svy_finished" .
             " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer"));
         return $set->numRows();
     }

Here is the caller graph for this function:

◆ getResults()

SurveyQuestionEvaluation::getResults ( )

Get results.

Returns: ilSurveyEvaluationResults|array

Definition at line 56 of file class.SurveyQuestionEvaluation.php.

References $results, getAnswerData(), and parseResults().

     {
         $results = new ilSurveyEvaluationResults($this->question);
         $answers = $this->getAnswerData();
                                         
         $this->parseResults(
             $results,
             (array) $answers[0],
             method_exists($this->question, "getCategories")
                 ? $this->question->getCategories()
                 : null
         );
         
         return $results;
     }

Here is the call graph for this function:

◆ getSkippedValue()

SurveyQuestionEvaluation::getSkippedValue ( )

Get caption for skipped value.

Returns: string

Definition at line 371 of file class.SurveyQuestionEvaluation.php.

References ilObjSurvey\getSurveySkippedValue().

Referenced by SurveyTextQuestionEvaluation\addUserSpecificResults(), SurveySingleChoiceQuestionEvaluation\addUserSpecificResults(), SurveyMultipleChoiceQuestionEvaluation\addUserSpecificResults(), SurveyMetricQuestionEvaluation\addUserSpecificResults(), and SurveyMatrixQuestionEvaluation\addUserSpecificResults().

     {
         include_once "Modules/Survey/classes/class.ilObjSurvey.php";
         return ilObjSurvey::getSurveySkippedValue();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSurveyId()

SurveyQuestionEvaluation::getSurveyId ( )

protected

Definition at line 382 of file class.SurveyQuestionEvaluation.php.

References $db, $ilDB, and $row.

     {
         $ilDB = $this->db;
         
         // #18968
         $set = $ilDB->query("SELECT survey_fi" .
             " FROM svy_svy_qst" .
             " WHERE question_fi = " . $ilDB->quote($this->question->getId(), "integer"));
         $row = $ilDB->fetchAssoc($set);
         return $row["survey_fi"];
     }

◆ getTextAnswers()

SurveyQuestionEvaluation::getTextAnswers ( $a_results )

Get text answers.

Parameters

ilSurveyEvaluationResults | array $a_results

Returns: array

Definition at line 288 of file class.SurveyQuestionEvaluation.php.

Referenced by ilSurveyEvaluationGUI\exportResultsDetailsExcel(), and ilSurveyEvaluationGUI\renderDetails().

     {
         return $a_results->getMappedTextAnswers();
     }

Here is the caller graph for this function:

◆ getUserSpecificVariableTitles()

SurveyQuestionEvaluation::getUserSpecificVariableTitles	(	array &	$a_title_row,
		array &	$a_title_row2,
			$a_do_title,
			$a_do_label
	)

Get title columns for user-specific export.

Parameters

array	$a_title_row
array	$a_title_row2
bool	$a_do_title
bool	$a_do_label

Definition at line 522 of file class.SurveyQuestionEvaluation.php.

References addUserSpecificResults().

     {
         // type-specific
     }

Here is the call graph for this function:

◆ parseResults()

SurveyQuestionEvaluation::parseResults	(	ilSurveyEvaluationResults	$a_results,
		array	$a_answers,
		SurveyCategories	$a_categories = `null`
	)

protected

Parse answer data into results instance.

Parameters

ilSurveyEvaluationResults	$a_results
array	$a_answers
SurveyCategories	$a_categories

Definition at line 79 of file class.SurveyQuestionEvaluation.php.

References $c, $i, $total, ilSurveyEvaluationResults\addAnswer(), ilSurveyEvaluationResults\addVariable(), getNrOfParticipants(), ilSurveyEvaluationResults\setMedian(), ilSurveyEvaluationResults\setMode(), ilSurveyEvaluationResults\setUsersAnswered(), and ilSurveyEvaluationResults\setUsersSkipped().

Referenced by SurveyMatrixQuestionEvaluation\getResults(), and getResults().

     {
         $num_users_answered = sizeof($a_answers);
 
         $a_results->setUsersAnswered($num_users_answered);
         $a_results->setUsersSkipped($this->getNrOfParticipants() - $num_users_answered);
         
         // parse answers
         $has_multi = false;
         $selections = array();
         foreach ($a_answers as $active_id => $answers) {
             // :TODO:
             if (sizeof($answers) > 1) {
                 $has_multi = true;
             }
             foreach ($answers as $answer) {
                 // map selection value to scale/category
                 if ($a_categories &&
                     $answer["value"] != "") {
                     $scale = $a_categories->getCategoryForScale($answer["value"] + 1);
                     if ($scale instanceof ilSurveyCategory) {
                         $answer["value"] = $scale->scale;
                     }
                 }
                 
                 $parsed = new ilSurveyEvaluationResultsAnswer(
                     $active_id,
                     $answer["value"],
                     $answer["text"]
                 );
                 $a_results->addAnswer($parsed);
 
                 if ($answer["value"] != "") {
                     $selections[$answer["value"]]++;
                 }
             }
         }
         
         $total = array_sum($selections);
 
         if ($total) {
             // mode
             $mode_nr = max($selections);
             $tmp_mode = $selections;
             asort($tmp_mode, SORT_NUMERIC);
             $mode = array_keys($tmp_mode, $mode_nr);
             $a_results->setMode($mode, $mode_nr);
             
             if (!$has_multi) {
                 // median
                 ksort($selections, SORT_NUMERIC);
                 $median = array();
                 foreach ($selections as $value => $count) {
                     for ($i = 0; $i < $count; $i++) {
                         $median[] = $value;
                     }
                 }
                 if ($total % 2 == 0) {
                     $lower = $median[($total / 2) - 1];
                     $upper = $median[($total / 2)];
                     $median_value = 0.5 * ($lower + $upper);
                     if ($a_categories &&
                         round($median_value) != $median_value) {
                         // mapping calculated value to scale values
                         $median_value = array($lower, $upper);
                     }
                 } else {
                     $median_value = $median[(($total + 1) / 2) - 1];
                 }
                 $a_results->setMedian($median_value);
             }
         }
         
         if ($a_categories) {
             // selections by category
             for ($c = 0; $c < $a_categories->getCategoryCount(); $c++) {
                 $cat = $a_categories->getCategory($c);
                 $scale = $cat->scale;
 
                 $var = new ilSurveyEvaluationResultsVariable(
                     $cat,
                     $selections[$scale],
                     $total
                             ? $selections[$scale] / $total
                             : null
                 );
                 $a_results->addVariable($var);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseUserSpecificResults()

SurveyQuestionEvaluation::parseUserSpecificResults	(	$a_qres,
		$a_user_id
	)

Definition at line 170 of file class.SurveyQuestionEvaluation.php.

     {
         $parsed_results = array();
         
         if (is_array($a_qres)) {
             foreach ($a_qres as $row_idx => $row_results) {
                 $row_title = $row_results[0];
                 $user_results = $row_results[1]->getUserResults($a_user_id);
                 if ($user_results) {
                     foreach ($user_results as $item) {
                         // :TODO: layout
                         $tmp = $row_title . ": ";
                         if ($item[0] !== "") {
                             $tmp .= $item[0];
                         }
                         if ($item[1] && $item[0]) {
                             $tmp .= ", \"" . nl2br($item[1]) . "\"";
                         } elseif ($item[1]) {
                             $tmp .= "\"" . nl2br($item[1]) . "\"";
                         }
                         $parsed_results[$row_idx . "-" . $item[2]] = $tmp;
                     }
                 }
             }
         } else {
             $user_results = $a_qres->getUserResults($a_user_id);
             if ($user_results) {
                 foreach ($user_results as $item) {
                     // :TODO: layout
                     if ($item[0] !== "") {
                         $tmp = $item[0];
                     }
                     if ($item[1] && $item[0]) {
                         $tmp .= ", \"" . nl2br($item[1]) . "\"";
                     } elseif ($item[1]) {
                         $tmp = "\"" . nl2br($item[1]) . "\"";
                     }
                     $parsed_results[$item[2]] = $tmp;
                 }
             }
         }
         
         return $parsed_results;
     }