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

Collaboration diagram for ilSurveyEvaluationResults:

Public Member Functions
	__construct (SurveyQuestion $a_question)

	getQuestion ()

	setUsersAnswered (int $a_value)

	getUsersAnswered ()

	setUsersSkipped (int $a_value)

	getUsersSkipped ()

	setMode ( $a_value, int $a_nr_of_selections)

	getModeValue ()

	getModeValueAsText ()

	getModeNrOfSelections ()

	setMean (float $a_mean)

	getMean ()

	setMedian (string\|array $a_value)

	getMedian ()

	getMedianAsText ()

	addVariable (ilSurveyEvaluationResultsVariable $a_variable)

	getVariables ()

	addAnswer (ilSurveyEvaluationResultsAnswer $a_answer)

	getAnswers ()

	getScaleText ( $a_value)

	getMappedTextAnswers ()

	getUserResults (int $a_active_id)

Protected Member Functions
	getCatTitle (float $a_value)

Protected Attributes
ilLanguage	$lng

SurveyQuestion	$question

int	$users_answered = 0

int	$users_skipped = 0

array string null	$mode_value = null

int	$mode_nr_of_selections = 0

float	$arithmetic_mean = 0

string array null	$median = null

array	$variables = []

array	$answers = []

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 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 23 of file class.ilSurveyEvaluationResults.php.

Constructor & Destructor Documentation

◆ __construct()

ilSurveyEvaluationResults::__construct ( SurveyQuestion $a_question )

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

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

References $DIC, and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ addAnswer()

ilSurveyEvaluationResults::addAnswer ( ilSurveyEvaluationResultsAnswer $a_answer )

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

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

◆ addVariable()

ilSurveyEvaluationResults::addVariable ( ilSurveyEvaluationResultsVariable $a_variable )

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

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

◆ getAnswers()

ilSurveyEvaluationResults::getAnswers ( )

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

                                : array
    {
        return $this->answers ?? [];
    }

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

Here is the caller graph for this function:

◆ getCatTitle()

ilSurveyEvaluationResults::getCatTitle ( float $a_value )

protected

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

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

◆ getMappedTextAnswers()

ilSurveyEvaluationResults::getMappedTextAnswers ( )

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

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

References $res.

Referenced by SurveyQuestionEvaluation\getTextAnswers().

Here is the caller graph for this function:

◆ getMean()

ilSurveyEvaluationResults::getMean ( )

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

                             : float
    {
        return $this->arithmetic_mean;
    }

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

Here is the caller graph for this function:

◆ getMedian()

ilSurveyEvaluationResults::getMedian ( )

Returns: array|string

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

                               : string|array
    {
        return $this->median;
    }

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

Here is the caller graph for this function:

◆ getMedianAsText()

ilSurveyEvaluationResults::getMedianAsText ( )

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

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

References $lng.

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

Here is the caller graph for this function:

◆ getModeNrOfSelections()

ilSurveyEvaluationResults::getModeNrOfSelections ( )

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

                                           : int
    {
        return $this->mode_nr_of_selections;
    }

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

Here is the caller graph for this function:

◆ getModeValue()

ilSurveyEvaluationResults::getModeValue ( )

Returns: array|string

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

                                  : array|string|null
    {
        return $this->mode_value;
    }

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

Here is the caller graph for this function:

◆ getModeValueAsText()

ilSurveyEvaluationResults::getModeValueAsText ( )

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

                                        : string
    {
        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);
    }

References $res, and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Referenced by ilSurveyEvaluationGUI\parseResultsToExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestion()

ilSurveyEvaluationResults::getQuestion ( )

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

                                 : SurveyQuestion
    {
        return $this->question;
    }

References $question.

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

Here is the caller graph for this function:

◆ getScaleText()

ilSurveyEvaluationResults::getScaleText ( $a_value )

Parameters

mixed $a_value

Returns: string

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

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

◆ getUserResults()

ilSurveyEvaluationResults::getUserResults ( int $a_active_id )

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

     : array {
        $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;
    }

◆ getUsersAnswered()

ilSurveyEvaluationResults::getUsersAnswered ( )

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

                                      : int
    {
        return $this->users_answered;
    }

References $users_answered.

◆ getUsersSkipped()

ilSurveyEvaluationResults::getUsersSkipped ( )

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

                                     : int
    {
        return $this->users_skipped;
    }

References $users_skipped.

◆ getVariables()

ilSurveyEvaluationResults::getVariables ( )

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

                                  : array
    {
        return $this->variables ?? [];
    }

Referenced by SurveyQuestionEvaluation\getChart(), and SurveyQuestionEvaluation\getExportGrid().

Here is the caller graph for this function:

◆ setMean()

ilSurveyEvaluationResults::setMean ( float $a_mean )

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

                                          : void
    {
        $this->arithmetic_mean = $a_mean;
    }

◆ setMedian()

ilSurveyEvaluationResults::setMedian ( string|array $a_value )

Parameters

string | array $a_value

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

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

◆ setMode()

ilSurveyEvaluationResults::setMode	(		$a_value,
		int	$a_nr_of_selections
	)

Parameters

array | string $a_value

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

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

◆ setUsersAnswered()

ilSurveyEvaluationResults::setUsersAnswered ( int $a_value )

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

                                                  : void
    {
        $this->users_answered = $a_value;
    }

◆ setUsersSkipped()

ilSurveyEvaluationResults::setUsersSkipped ( int $a_value )

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

                                                 : void
    {
        $this->users_skipped = $a_value;
    }

Field Documentation

◆ $answers

array ilSurveyEvaluationResults::$answers = []

protected

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

◆ $arithmetic_mean

float ilSurveyEvaluationResults::$arithmetic_mean = 0

protected

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

◆ $lng

ilLanguage ilSurveyEvaluationResults::$lng

protected

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

◆ $median

string array null ilSurveyEvaluationResults::$median = null

protected

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

◆ $mode_nr_of_selections

int ilSurveyEvaluationResults::$mode_nr_of_selections = 0

protected

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

◆ $mode_value

array string null ilSurveyEvaluationResults::$mode_value = null

protected

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

◆ $question

SurveyQuestion ilSurveyEvaluationResults::$question

protected

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

Referenced by getQuestion().

◆ $users_answered

int ilSurveyEvaluationResults::$users_answered = 0

protected

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

Referenced by getUsersAnswered().

◆ $users_skipped

int ilSurveyEvaluationResults::$users_skipped = 0

protected

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

Referenced by getUsersSkipped().

◆ $variables

array ilSurveyEvaluationResults::$variables = []

protected

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

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

components/ILIAS/Survey/Evaluation/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

◆ $lng

◆ $median

◆ $mode_nr_of_selections

◆ $mode_value

◆ $question

◆ $users_answered

◆ $users_skipped

◆ $variables