This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for SurveyMetricQuestionEvaluation:

Collaboration diagram for SurveyMetricQuestionEvaluation:

Public Member Functions
	getGrid ( $a_results, bool $a_abs=true, bool $a_perc=true)

	getChart ($a_results)

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

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

Public Member Functions inherited from SurveyQuestionEvaluation
	__construct (SurveyQuestion $a_question, array $a_finished_ids=[])

	getResults ()
	Get results. More...

	getSumScores ()
	Get sum score for this question for all active ids of run. More...

	parseUserSpecificResults ($a_qres, int $a_user_id)

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

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

	getChart ($a_results)

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

	exportResults ( $a_results, bool $a_do_title, bool $a_do_label)

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

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

	addUserSpecificResults (array &$a_row, int $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...

Protected Member Functions inherited from SurveyQuestionEvaluation
	isSumScoreValid (int $nr_answer_records)
	Is sum score ok (question needs to be fully answered) More...

	supportsSumScore ()

	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 ()

Additional Inherited Members
Protected Attributes inherited from SurveyQuestionEvaluation
ilLanguage	$lng

ilDBInterface	$db

SurveyQuestion	$question

array	$finished_ids

int	$chart_width = 400

int	$chart_height = 300

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Survey metric 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 24 of file class.SurveyMetricQuestionEvaluation.php.

Member Function Documentation

◆ addUserSpecificResults()

SurveyMetricQuestionEvaluation::addUserSpecificResults	(	array &	$a_row,
		int	$a_user_id,
			$a_results
	)

Parameters

array | ilSurveyEvaluationResults $a_results

Reimplemented from SurveyQuestionEvaluation.

Definition at line 208 of file class.SurveyMetricQuestionEvaluation.php.

     : void {
        $answer = $a_results->getUserResults($a_user_id);
        if (count($answer) === 0) {
            $a_row[] = $this->getSkippedValue();
        } else {
            $a_row[] = $answer[0][0];
        }
    }

◆ getChart()

SurveyMetricQuestionEvaluation::getChart ( $a_results )

Parameters

array | ilSurveyEvaluationResults $a_results

Reimplemented from SurveyQuestionEvaluation.

Definition at line 122 of file class.SurveyMetricQuestionEvaluation.php.

                                        : ?array
    {
        $lng = $this->lng;
 
        $chart = ilChart::getInstanceByType(ilChart::TYPE_GRID, $a_results->getQuestion()->getId());
        $chart->setYAxisToInteger(true);
 
        $colors = $this->getChartColors();
        $chart->setColors($colors);
 
        // :TODO:
        $chart->setSize((string) $this->chart_width, (string) $this->chart_height);
 
        $data = $chart->getDataInstance(ilChartGrid::DATA_BARS);
        $data->setLabel($lng->txt("category_nr_selected"));
        $data->setBarOptions(0.5, "center");
        $data->setFill(1);
 
        $total = count($a_results->getAnswers());
        if ($total > 0) {
            $cumulated = array();
            foreach ($a_results->getAnswers() as $answer) {
                $cumulated[$answer->value] = ($cumulated[$answer->value] ?? 0) + 1;
            }
 
            $labels = array();
            foreach ($cumulated as $value => $count) {
                $data->addPoint($value, $count);
                $labels[$value] = $value;
            }
            $chart->addData($data);
 
            $chart->setTicks($labels, false, true);
 
            return array(
                $chart->getHTML(),
                null
            );
        }
        return null;
    }

References $data, $lng, ilChartGrid\DATA_BARS, ilSurveyEvaluationResults\getAnswers(), ilChart\getInstanceByType(), ilSurveyEvaluationResults\getQuestion(), and ilChart\TYPE_GRID.

Here is the call graph for this function:

◆ getExportGrid()

SurveyMetricQuestionEvaluation::getExportGrid ( $a_results )

Get grid data.

Parameters

ilSurveyEvaluationResults | array $a_results

Reimplemented from SurveyQuestionEvaluation.

Definition at line 173 of file class.SurveyMetricQuestionEvaluation.php.

                                             : array
    {
        $lng = $this->lng;
 
        $res = array(
            "cols" => array(
                $lng->txt("value"),
                $lng->txt("category_nr_selected"),
                $lng->txt("svy_fraction_of_selections")
            ),
            "rows" => array()
        );
 
        // as we have no variables build rows from answers directly
        $total = count($a_results->getAnswers());
        if ($total > 0) {
            $cumulated = array();
            foreach ($a_results->getAnswers() as $answer) {
                $cumulated[$answer->value] = ($cumulated[$answer->value] ?? 0) + 1;
            }
            foreach ($cumulated as $value => $count) {
                $res["rows"][] = array(
                    $value,
                    $count,
                    sprintf("%.2f", $count / $total * 100) . "%"
                );
            }
        }
 
        return $res;
    }

References $lng, $res, and ilSurveyEvaluationResults\getAnswers().

Here is the call graph for this function:

◆ getGrid()

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

Parameters

array | ilSurveyEvaluationResults $a_results

Reimplemented from SurveyQuestionEvaluation.

Definition at line 58 of file class.SurveyMetricQuestionEvaluation.php.

     : array {
        $lng = $this->lng;
 
        if ($a_abs && $a_perc) {
            $cols = array(
                $lng->txt("category_nr_selected"),
                $lng->txt("svy_fraction_of_selections")
            );
        } elseif ($a_abs) {
            $cols = array(
                $lng->txt("category_nr_selected")
            );
        } else {
            $cols = array(
                $lng->txt("svy_fraction_of_selections")
            );
        }
 
        $res = array(
            "cols" => $cols,
            "rows" => array()
        );
 
        // as we have no variables build rows from answers directly
        $answ = $a_results->getAnswers();
        $total = count($answ);
 
        if ($total > 0) {
            $cumulated = array();
            foreach ($a_results->getAnswers() as $answer) {
                $cumulated[$answer->value] = ($cumulated[$answer->value] ?? 0) + 1;
            }
            foreach ($cumulated as $value => $count) {
                $perc = sprintf("%.2f", $count / $total * 100) . "%";
                if ($a_abs && $a_perc) {
                    $res["rows"][] = array(
                        $value,
                        $count,
                        $perc
                    );
                } elseif ($a_abs) {
                    $res["rows"][] = array(
                        $value,
                        $count
                    );
                } else {
                    $res["rows"][] = array(
                        $value,
                        $perc
                    );
                }
            }
        }
 
        return $res;
    }

References $cols, and $lng.

◆ parseResults()

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

protected

Parse answer data into results instance.

Reimplemented from SurveyQuestionEvaluation.

Definition at line 30 of file class.SurveyMetricQuestionEvaluation.php.

     : void {
        parent::parseResults($a_results, $a_answers);
 
        // add arithmetic mean
        $total = $sum = 0;
        foreach ($a_answers as $answers) {
            foreach ($answers as $answer) {
                $total++;
                $sum += $answer["value"];
            }
        }
        if ($total > 0) {
            $a_results->setMean($sum / $total);
        }
    }

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

Modules/SurveyQuestionPool/Questions/class.SurveyMetricQuestionEvaluation.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addUserSpecificResults()

◆ getChart()

◆ getExportGrid()

◆ getGrid()

◆ parseResults()