Survey matrix evaluation. More...

Inheritance diagram for SurveyMatrixQuestionEvaluation:

Collaboration diagram for SurveyMatrixQuestionEvaluation:

Public Member Functions
	getResults ()

	getGrid ($a_results, $a_abs=true, $a_perc=true)

	getTextAnswers ($a_results)

	getChart ($a_results)

	exportResults ($a_results, $a_do_title, $a_do_label)

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

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

Public Member Functions inherited from SurveyQuestionEvaluation
	__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)

Additional Inherited Members
Protected Member Functions inherited from SurveyQuestionEvaluation
	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 inherited from SurveyQuestionEvaluation
	$lng

	$db

	$question

	$finished_ids

	$chart_width = 400

	$chart_height = 300

Detailed Description

Survey matrix 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.SurveyMatrixQuestionEvaluation.php.

Member Function Documentation

◆ addUserSpecificResults()

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

Definition at line 320 of file class.SurveyMatrixQuestionEvaluation.php.

References $i, $index, $row, array, and SurveyQuestionEvaluation\getSkippedValue().

     {
         $answer_map = array();
         foreach ($a_results as $row_results) {
             $row_title = $row_results[0];
             $row_result = $row_results[1];
             
             $answers = $row_result->getUserResults($a_user_id);
             if ($answers !== null) {
                 foreach ($answers as $answer) {
                     // mc
                     if ($this->question->getSubtype() == 1) {
                         $answer_map[$row_title . "|" . $answer[2]] = $answer[2];
                     } else {
                         $answer_map[$row_title] = $answer[3];
                         $answer_map[$row_title . "|scale"] = $answer[2];                // see #20646
                     }
                     if ($answer[1]) {
                         $answer_map[$row_title . "|txt"] = $answer[1];
                     }
                 }
             }
         }
         
         if (!sizeof($answer_map)) {
             $a_row[] = $this->getSkippedValue();
         } else {
             $a_row[] = "";
         }
         
         for ($i = 0; $i < $this->question->getRowCount(); $i++) {
             $row = $this->question->getRow($i);
             $row_title = $row->title;
             
             $a_row[] = $answer_map[$row_title];
             if ($this->question->getSubtype() == 0) {
                 $a_row[] = $answer_map[$row_title . "|scale"];    // see #20646
             }
             
             if ($row->other) {
                 $a_row[] = $answer_map[$row_title . "|txt"];
             }
             
             // mc
             if ($this->question->getSubtype() == 1) {
                 for ($index = 0; $index < $this->question->getColumnCount(); $index++) {
                     $col = $this->question->getColumn($index);
                     $a_row[] = $answer_map[$row_title . "|" . $col->scale];
                 }
             }
         }
     }

Here is the call graph for this function:

◆ exportResults()

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

Definition at line 195 of file class.SurveyMatrixQuestionEvaluation.php.

References SurveyQuestionEvaluation\$question, $row, $rows, SurveyQuestion\_getQuestionTypeName(), and array.

     {
         $question = $a_results[0][1]->getQuestion();
         
         $rows = array();
         $row = array();
         
         if ($a_do_title) {
             $row[] = $question->getTitle();
         }
         if ($a_do_label) {
             $row[] = $question->label;
         }
         
         $row[] = $question->getQuestiontext();
         $row[] = SurveyQuestion::_getQuestionTypeName($question->getQuestionType());
         
         $row[] = (int) $a_results[0][1]->getUsersAnswered();
         $row[] = (int) $a_results[0][1]->getUsersSkipped();
         $row[] = null;
         $row[] = null;
         $row[] = null;
         $row[] = null;
         $row[] = null;
         
         $rows[] = $row;
         
         foreach ($a_results as $row_result) {
             $row_title = $row_result[0];
             $row_res = $row_result[1];
         
             $row = array();
             
             if ($a_do_title) {
                 $row[] = null;
             }
             if ($a_do_label) {
                 $row[] = null;
             }
 
             $row[] = $row_title;
             $row[] = null;
 
             $row[] = null;
             $row[] = null;
             
             // :TODO:
             $row[] = is_array($row_res->getModeValue())
                 ? implode(", ", $row_res->getModeValue())
                 : $row_res->getModeValue();
             
             $row[] = $row_res->getModeValueAsText();
             $row[] = (int) $row_res->getModeNrOfSelections();
 
             // :TODO:
             $row[] = $row_res->getMedianAsText();
 
             $row[] = $row_res->getMean();
             
             $rows[] = $row;
         }
         return $rows;
     }

Here is the call graph for this function:

◆ getChart()

SurveyMatrixQuestionEvaluation::getChart ( $a_results )

Definition at line 114 of file class.SurveyMatrixQuestionEvaluation.php.

References $chart, $data, $legend, SurveyQuestionEvaluation\$lng, $row, array, ilChartGrid\DATA_BARS, SurveyQuestionEvaluation\getChartColors(), ilChart\getInstanceByType(), ilUtil\shortenText(), and ilChart\TYPE_GRID.

     {
         $lng = $this->lng;
         
         include_once "Services/Chart/classes/class.ilChart.php";
         $chart = ilChart::getInstanceByType(ilChart::TYPE_GRID, $a_results[0][1]->getQuestion()->getId());
         $chart->setXAxisToInteger(true);
         $chart->setStacked(true);
             
         $colors = $this->getChartColors();
         $chart->setColors($colors);
 
         // :TODO:
         //$chart->setsize($this->chart_width, $this->chart_height);
                     
         $data = $labels = $legend = array();
         
         $row_idx = sizeof($a_results);
 
         $row_counter = 0;
         $text_shortened = false;
         foreach ($a_results as $row) {
             $row_idx--;
 
             $row_title = $row[0];
             $row_results = $row[1];
 
             #20363
             $row_title = ++$row_counter . ". " . $row_title;
             $labels[$row_idx] = ilUtil::shortenText($row_title, 50, true);
             if ($labels[$row_idx] != $row_title) {
                 $text_shortened = true;
             }
             //$labels[$row_idx] = wordwrap(ilUtil::shortenText($row_title, 50, true), 30, "<br />");
             
             $vars = $row_results->getVariables();
             if ($vars) {
                 foreach ($vars as $idx => $var) {
                     if (!array_key_exists($idx, $data)) {
                         $data[$idx] = $chart->getDataInstance(ilChartGrid::DATA_BARS);
                         $data[$idx]->setLabel($var->cat->title);
                         $data[$idx]->setBarOptions(0.5, "center", true);
                         $data[$idx]->setFill(1);
                         
                         $legend[] = array(
                             $var->cat->title,
                             $colors[$idx]
                         );
                     }
                     
                     $data[$idx]->addPoint($var->abs, $row_idx);
                 }
             }
         }
 
         //Chart height depending on the number of questions. Not fixed anymore.
         $this->chart_height = count($a_results)*40;
         //Chart width 500px if one or + question string are longer than 60 char. Otherwise the default width still aplied.
         if ($text_shortened) {
             $this->chart_width = 500;
         }
         $chart->setSize($this->chart_width, $this->chart_height);
 
         foreach ($data as $var) {
             $chart->addData($var);
         }
         
         $chart->setTicks(false, $labels, true);
         
         return array(
             $chart->getHTML(),
             $legend
         );
     }

Here is the call graph for this function:

◆ getGrid()

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

Definition at line 49 of file class.SurveyMatrixQuestionEvaluation.php.

References SurveyQuestionEvaluation\$lng, $res, and array.

     {
         $lng = $this->lng;
         
         $res = array(
             "cols" => array(),
             "rows" => array()
         );
         
         $tmp = $a_results;
         $tmp = array_shift($tmp);
         $vars = $tmp[1]->getVariables();
         if ($vars) {
             foreach ($vars as $var) {
                 $res["cols"][] = $var->cat->title;
             }
         }
         $q_counter = 0;
         foreach ($a_results as $results_row) {
             #20363
             $parsed_row = array(
                 ++$q_counter . ". " . $results_row[0]
             );
 
             $vars = $results_row[1]->getVariables();
             if ($vars) {
                 foreach ($vars as $var) {
                     $perc = $var->perc
                         ? sprintf("%.2f", $var->perc*100) . "%"
                         : "0%";
                     
                     if ((bool) $a_abs && (bool) $a_perc) {
                         $parsed_row[] = $var->abs . " / " . $perc;
                     } elseif ((bool) $a_abs) {
                         $parsed_row[] = $var->abs;
                     } else {
                         $parsed_row[] = $perc;
                     }
                 }
             }
             
             $res["rows"][] = $parsed_row;
         }
         return $res;
     }

◆ getResults()

SurveyMatrixQuestionEvaluation::getResults ( )

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

References $r, $results, array, SurveyQuestionEvaluation\getAnswerData(), and SurveyQuestionEvaluation\parseResults().

     {
         $results = array();
         
         $answers = $this->getAnswerData();
         
         // parse rows
         for ($r = 0; $r < $this->question->getRowCount(); $r++) {
             $row_results = new ilSurveyEvaluationResults($this->question);
                     
             $this->parseResults(
                 $row_results,
                 (array) $answers[$r],
                 $this->question->getColumns()
             );
                 
             $results[] = array(
                 $this->question->getRow($r)->title,
                 $row_results
             );
         }
         
         return $results;
     }

Here is the call graph for this function:

◆ getTextAnswers()

SurveyMatrixQuestionEvaluation::getTextAnswers ( $a_results )

Definition at line 95 of file class.SurveyMatrixQuestionEvaluation.php.

References $res, and array.

     {
         $res = array();
         
         foreach ($a_results as $results_row) {
             $texts = $results_row[1]->getMappedTextAnswers();
             if ($texts) {
                 $idx = $results_row[0];
                 foreach ($texts as $answers) {
                     foreach ($answers as $answer) {
                         $res[$idx][] = $answer;
                     }
                 }
             }
         }
         
         return $res;
     }

◆ getUserSpecificVariableTitles()

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

Definition at line 259 of file class.SurveyMatrixQuestionEvaluation.php.

References $i, $index, SurveyQuestionEvaluation\$lng, and $row.

     {
         $lng = $this->lng;
         
         for ($i = 0; $i < $this->question->getRowCount(); $i++) {
             // create row title according label, add 'other column'
             $row = $this->question->getRow($i);
             
             if ($a_do_title && $a_do_label) {
                 $a_title_row[] = $row->title;
                 $a_title_row2[] = $row->label;
 
                 if ($this->question->getSubtype() == 0) {
                     $a_title_row[] = $row->title;        // see #20646
                     $a_title_row2[] = $row->label;        // see #20646
                 }
 
                 if ($row->other) {
                     $a_title_row[] = $row->title;
                     $a_title_row2[] = $lng->txt('other');
                 }
             } elseif ($a_do_title) {
                 $a_title_row[] = $row->title;
                 $a_title_row2[] = "";
 
                 if ($this->question->getSubtype() == 0) {
                     $a_title_row[] = $row->title;        // see #20646
                     $a_title_row2[] = "";                // see #20646
                 }
 
                 if ($row->other) {
                     $a_title_row[] = $row->title;
                     $a_title_row2[] = $lng->txt('other');
                 }
             } else {
                 $a_title_row[] = $row->label;
                 $a_title_row2[] = "";
 
                 if ($this->question->getSubtype() == 0) {
                     $a_title_row[] = $row->label;        // see #20646
                     $a_title_row2[] = "";                // see #20646
                 }
 
                 if ($row->other) {
                     $a_title_row[] = $row->label;
                     $a_title_row2[] = $lng->txt('other');
                 }
             }
             
             // mc
             if ($this->question->getSubtype() == 1) {
                 for ($index = 0; $index < $this->question->getColumnCount(); $index++) {
                     $col = $this->question->getColumn($index);
                     
                     $a_title_row[] = $col->title . " [" . $col->scale . "]";
                     $a_title_row2[] = "";
                 }
             }
         }
     }

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

Modules/SurveyQuestionPool/classes/class.SurveyMatrixQuestionEvaluation.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addUserSpecificResults()

◆ exportResults()

◆ getChart()

◆ getGrid()

◆ getResults()

◆ getTextAnswers()

◆ getUserSpecificVariableTitles()