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

Collaboration diagram for assFormulaQuestionResult:

Public Member Functions
	__construct (private string $result, private ?string $range_min_txt, private ?string $range_max_txt, private float $tolerance, private ?assFormulaQuestionUnit $unit, private ?string $formula, private float $points, private int $precision, private bool $rating_simple=true, private ?float $rating_sign=null, private ?float $rating_value=null, private ?float $rating_unit=null, private float $result_type=0)

	substituteFormula (array $variables, array $results)

	calculateFormula ($variables, $results, $question_id=0, $use_precision=true)

	findValidRandomVariables ($variables, $results)

	suggestRange ($variables, $results)

	isCorrect ($variables, $results, $value, $unit=null)

	getReachedPoints (array $variables, array $results, string $answer_value, ?assFormulaQuestionUnit $answer_unit, array $units)

	getResultInfo ($variables, $results, $value, $unit, $units)

	setResult ($result)

	getResult ()

	setRangeMin (?string $range_min)

	getRangeMin ()

	getRangeMinBase ()

	setRangeMax (?string $range_max)

	getRangeMax ()

	getRangeMaxBase ()

	setTolerance ($tolerance)

	getTolerance ()

	setUnit (?assFormulaQuestionUnit $unit)

	getUnit ()

	setFormula (?string $formula)

	getFormula ()

	setPoints (float $points)

	getPoints ()

	setRatingSimple (bool $rating_simple)

	getRatingSimple ()

	setRatingSign (float $rating_sign)

	getRatingSign ()

	setRatingValue (float $rating_value)

	getRatingValue ()

	setRatingUnit (float $rating_unit)

	getRatingUnit ()

	setPrecision (float $precision)

	getPrecision ()

	setResultType (int $a_result_type)

	getResultType ()

	setRangeMaxTxt (string $range_max_txt)

	getRangeMaxTxt ()

	setRangeMinTxt (string $range_min_txt)

	getRangeMinTxt ()

	getAvailableResultUnits ($question_id)

Static Public Member Functions
static	getResultTypeByQstId ($a_qst_id, $a_result)

static	isCoprimeFraction ($numerator, $denominator)

static	convertDecimalToCoprimeFraction ($decimal_value, $tolerance=1.e-9)

static	getGreatestCommonDivisor ($a, $b)

Data Fields
const	RESULT_NO_SELECTION = 0

const	RESULT_DEC = 1

const	RESULT_FRAC = 2

const	RESULT_CO_FRAC = 3

Protected Member Functions
	isInTolerance ($user_answer, $expected, $tolerated_percentage)

Private Member Functions
	checkSign (float $v1, float $v2)

	calculateCorrectResult (array $variables, array $results)

	transformAnswerValueAccordingToType (string $value, ?assFormulaQuestionUnit $unit)

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Refinery	$refinery

ilLanguage	$lng

	$available_units = []

float	$range_min = null

float	$range_max = null

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 Formula Question Result

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version

Id: class.assFormulaQuestionResult.php 944 2009-11-09 16:11:30Z hschottm

\

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

Constructor & Destructor Documentation

◆ __construct()

assFormulaQuestionResult::__construct	(	private string	$result,
		private ?string	$range_min_txt,
		private ?string	$range_max_txt,
		private float	$tolerance,
		private ?assFormulaQuestionUnit	$unit,
		private ?string	$formula,
		private float	$points,
		private int	$precision,
		private bool	$rating_simple = `true`,
		private ?float	$rating_sign = `null`,
		private ?float	$rating_value = `null`,
		private ?float	$rating_unit = `null`,
		private float	$result_type = `0`
	)

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

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

       {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
         $this->refinery = $DIC->refinery();
         $this->lng = $DIC->language();
         $this->setRangeMin($range_min_txt);
         $this->setRangeMax($range_max_txt);
 
         if ($rating_sign === null) {
             $this->rating_sign = 33;
         }
         if ($rating_value === null) {
             $this->rating_value = 34;
         }
         if ($rating_unit === null) {
             $this->rating_unit = 33;
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ calculateCorrectResult()

assFormulaQuestionResult::calculateCorrectResult	(	array	$variables,
		array	$results
	)

private

Definition at line 461 of file class.assFormulaQuestionResult.php.

References calculateFormula().

Referenced by getReachedPoints().

                                                                              : float
     {
         return round(
             $this->calculateFormula($variables, $results),
             $this->precision
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateFormula()

assFormulaQuestionResult::calculateFormula	(	$variables,
		$results,
		$question_id = `0`,
		$use_precision = `true`
	)

Definition at line 101 of file class.assFormulaQuestionResult.php.

References $res, $results, ilMath\_div(), getAvailableResultUnits(), getPrecision(), getResultType(), getUnit(), and substituteFormula().

Referenced by calculateCorrectResult().

     {
         $resultunits = [];
         if ($question_id > 0) {
             $resultunits = $this->getAvailableResultUnits($question_id);
         }
 
         $formula = $this->substituteFormula($variables, $results);
         if (preg_match_all("/(\\\$v\\d+)/ims", $formula, $matches)) {
             foreach ($matches[1] as $variable) {
                 $varObj = $variables[$variable];
                 if (!is_object($varObj) || !is_numeric($varObj->getValue())) {
                     continue;
                 }
                 $value = $varObj->getBaseValue();
                 $formula = preg_replace("/\\\$" . substr($variable, 1) . "(?![0-9]+)/", "(" . $value . ")" . "\\1", $formula);
             }
         }
         $math = new EvalMath();
         $math->suppress_errors = true;
 
         $formula = str_replace(",", ".", $formula);
         $result = $math->evaluate($formula);
         if ($this->getUnit() !== null) {
             $result = ilMath::_div($result, $this->getUnit()->getFactor(), 100);
         }
 
         // @todo DON'T USE ilMath::_mul() ... bcmul() returns wrong result !!!!
 
         if ($use_precision == true) {
             $res = $result * 1;
             if (is_numeric($this->getPrecision())) {
                 if ($this->getResultType() == self::RESULT_DEC || $this->getResultType() == self::RESULT_NO_SELECTION) {
                     $result = ilMath::_round($res, $this->getPrecision());
                 }
             }
         }
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkSign()

assFormulaQuestionResult::checkSign	(	float	$v1,
		float	$v2
	)

private

Definition at line 409 of file class.assFormulaQuestionResult.php.

Referenced by getReachedPoints(), and getResultInfo().

                                                     : bool
     {
         return ($v1 >= 0.0 && $v2 >= 0.0) || ($v1 <= 0.0 && $v2 <= 0.0);
     }

Here is the caller graph for this function:

◆ convertDecimalToCoprimeFraction()

static assFormulaQuestionResult::convertDecimalToCoprimeFraction	(	$decimal_value,
		$tolerance = `1.e-9`
	)

static

Definition at line 773 of file class.assFormulaQuestionResult.php.

References Vendor\Package\$a, and Vendor\Package\$b.

Referenced by assFormulaQuestion\getBestSolution(), and assFormulaQuestion\substituteVariables().

     {
         if (empty($decimal_value)) {
             return '';
         }
 
         $to_string = (string) $decimal_value;
         $is_negative = strpos($to_string, '-') === 0;
         if ($is_negative) {
             $decimal_value = substr($decimal_value, 1);
         }
         $h1 = 1;
         $h2 = 0;
         $k1 = 0;
         $k2 = 1;
         $b = 1 / $decimal_value;
         do {
             $b = 1 / $b;
             $a = floor($b);
             $aux = $h1;
             $h1 = $a * $h1 + $h2;
             $h2 = $aux;
             $aux = $k1;
             $k1 = $a * $k1 + $k2;
             $k2 = $aux;
             $b = $b - $a;
         } while ((abs($decimal_value - $h1 / $k1) > $decimal_value * $tolerance) || ($k1 < 0 || $b < 0));
         if ($k1 == 1) {
             $result = $h1;
             $checkResult = $h1;
         } else {
             $result = "$h1/$k1";
             $checkResult = ($h1 / $k1);
         }
         if ($is_negative) {
             $result = '-' . $result;
             $checkResult = ($h1 / $k1) * -1;
         }
         if ($to_string == $checkResult . '' || $checkResult . '' == $result) {
             return $result;
         } else {
             return [$to_string,$result];
         }
     }

Here is the caller graph for this function:

◆ findValidRandomVariables()

assFormulaQuestionResult::findValidRandomVariables	(	$variables,
		$results
	)

Definition at line 141 of file class.assFormulaQuestionResult.php.

References $results, getRangeMax(), getRangeMaxBase(), getRangeMin(), getRangeMinBase(), and substituteFormula().

                                                                   : void
     {
         $i = 0;
         $inRange = false;
         while ($i < 1000 && !$inRange) {
             $formula = $this->substituteFormula($variables, $results);
             if (preg_match_all("/(\\\$v\\d+)/ims", $formula, $matches)) {
                 foreach ($matches[1] as $variable) {
                     $varObj = $variables[$variable];
                     if (!is_object($varObj)) {
                         continue;
                     }
                     $varObj->setRandomValue();
                     $formula = preg_replace("/\\\$" . substr($variable, 1) . "(?![0-9]+)/", "(" . $varObj->getBaseValue() . ")" . "\\1", $formula);
                 }
             }
             $math = new EvalMath();
             $math->suppress_errors = true;
             $result = $math->evaluate($formula);
             $inRange = (is_numeric($result)) ? true : false;
             if ($inRange) {
                 if (is_numeric($this->getRangeMin())) {
                     if ($result < $this->getRangeMinBase()) {
                         $inRange = false;
                     }
                 }
                 if (is_numeric($this->getRangeMax())) {
                     if ($result > $this->getRangeMaxBase()) {
                         $inRange = false;
                     }
                 }
             }
             $i++;
         }
     }

Here is the call graph for this function:

◆ getAvailableResultUnits()

assFormulaQuestionResult::getAvailableResultUnits ( $question_id )

Definition at line 828 of file class.assFormulaQuestionResult.php.

References $available_units, $DIC, $ilDB, and $res.

Referenced by calculateFormula().

                                                          : array
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $res = $ilDB->queryF(
             '
                         SELECT * FROM il_qpl_qst_fq_res_unit
                         WHERE question_fi = %s
                         ORDER BY result',
             ['integer'],
             [$question_id]
         );
 
 
         while ($row = $ilDB->fetchAssoc($res)) {
             $this->available_units[$row['result']][] = $row['unit_fi'] ;
         }
 
         return $this->available_units;
     }

Here is the caller graph for this function:

◆ getFormula()

assFormulaQuestionResult::getFormula ( )

Definition at line 651 of file class.assFormulaQuestionResult.php.

Referenced by assFormulaQuestion\buildResultsForLog(), and substituteFormula().

                                 : ?string
     {
         return $this->formula;
     }

Here is the caller graph for this function:

◆ getGreatestCommonDivisor()

static assFormulaQuestionResult::getGreatestCommonDivisor	(	$a,
		$b
	)

static

Definition at line 818 of file class.assFormulaQuestionResult.php.

References Vendor\Package\$a, and Vendor\Package\$b.

     {
         if ($b > 0) {
             return self::getGreatestCommonDivisor($b, $a % $b);
         } else {
             return $a;
         }
     }

◆ getPoints()

assFormulaQuestionResult::getPoints ( )

Definition at line 661 of file class.assFormulaQuestionResult.php.

Referenced by assFormulaQuestion\buildResultsForLog(), getReachedPoints(), and getResultInfo().

                                : float
     {
         return $this->points;
     }

Here is the caller graph for this function:

◆ getPrecision()

assFormulaQuestionResult::getPrecision ( )

Definition at line 711 of file class.assFormulaQuestionResult.php.

Referenced by assFormulaQuestion\buildResultsForLog(), calculateFormula(), isCorrect(), isInTolerance(), suggestRange(), and transformAnswerValueAccordingToType().

                                   : int
     {
         return $this->precision;
     }

Here is the caller graph for this function:

◆ getRangeMax()

assFormulaQuestionResult::getRangeMax ( )

Definition at line 612 of file class.assFormulaQuestionResult.php.

References $range_max.

Referenced by findValidRandomVariables(), and getRangeMaxBase().

                                  : ?float
     {
         return $this->range_max;
     }

Here is the caller graph for this function:

◆ getRangeMaxBase()

assFormulaQuestionResult::getRangeMaxBase ( )

Definition at line 617 of file class.assFormulaQuestionResult.php.

References ilMath\_mul(), getRangeMax(), and getUnit().

Referenced by findValidRandomVariables().

     {
         if ($this->getUnit() !== null) {
             return ilMath::_mul($this->getRangeMax(), $this->getUnit()->getFactor(), 100);
         }
 
         return $this->getRangeMax();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRangeMaxTxt()

assFormulaQuestionResult::getRangeMaxTxt ( )

Definition at line 731 of file class.assFormulaQuestionResult.php.

Referenced by assFormulaQuestion\buildResultsForLog().

                                     : string
     {
         return $this->range_max_txt;
     }

Here is the caller graph for this function:

◆ getRangeMin()

assFormulaQuestionResult::getRangeMin ( )

Definition at line 587 of file class.assFormulaQuestionResult.php.

References $range_min.

Referenced by findValidRandomVariables(), and getRangeMinBase().

                                  : ?float
     {
         return $this->range_min;
     }

Here is the caller graph for this function:

◆ getRangeMinBase()

assFormulaQuestionResult::getRangeMinBase ( )

Definition at line 592 of file class.assFormulaQuestionResult.php.

References ilMath\_mul(), getRangeMin(), and getUnit().

Referenced by findValidRandomVariables().

     {
         if ($this->getUnit() !== null) {
             return ilMath::_mul($this->getRangeMin(), $this->getUnit()->getFactor(), 100);
         }
 
         return $this->getRangeMin();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRangeMinTxt()

assFormulaQuestionResult::getRangeMinTxt ( )

Definition at line 741 of file class.assFormulaQuestionResult.php.

Referenced by assFormulaQuestion\buildResultsForLog().

                                     : string
     {
         return $this->range_min_txt;
     }

Here is the caller graph for this function:

◆ getRatingSign()

assFormulaQuestionResult::getRatingSign ( )

Definition at line 681 of file class.assFormulaQuestionResult.php.

Referenced by getReachedPoints(), and getResultInfo().

                                    : float
     {
         return $this->rating_sign;
     }

Here is the caller graph for this function:

◆ getRatingSimple()

assFormulaQuestionResult::getRatingSimple ( )

Definition at line 671 of file class.assFormulaQuestionResult.php.

Referenced by getReachedPoints(), and getResultInfo().

                                      : bool
     {
         return $this->rating_simple;
     }

Here is the caller graph for this function:

◆ getRatingUnit()

assFormulaQuestionResult::getRatingUnit ( )

Definition at line 701 of file class.assFormulaQuestionResult.php.

Referenced by getReachedPoints(), and getResultInfo().

                                    : float
     {
         return $this->rating_unit;
     }

Here is the caller graph for this function:

◆ getRatingValue()

assFormulaQuestionResult::getRatingValue ( )

Definition at line 691 of file class.assFormulaQuestionResult.php.

Referenced by getReachedPoints(), and getResultInfo().

                                     : float
     {
         return $this->rating_value;
     }

Here is the caller graph for this function:

◆ getReachedPoints()

assFormulaQuestionResult::getReachedPoints	(	array	$variables,
		array	$results,
		string	$answer_value,
		?assFormulaQuestionUnit	$answer_unit,
		array	$units
	)

Parameters

assFormulaQuestionUnit[] $units

Definition at line 417 of file class.assFormulaQuestionResult.php.

References ilMath\_div(), ilMath\_mul(), calculateCorrectResult(), checkSign(), assFormulaQuestionUnit\getBaseUnit(), getPoints(), getRatingSign(), getRatingSimple(), getRatingUnit(), getRatingValue(), getTolerance(), isCorrect(), isInTolerance(), and transformAnswerValueAccordingToType().

      : float {
         if ($this->getRatingSimple()) {
             return $this->isCorrect($variables, $results, $answer_value, $answer_unit)
             ? $this->getPoints()
             : 0.0;
         }
 
         $result = $this->calculateCorrectResult($variables, $results);
         $float_value = $this->transformAnswerValueAccordingToType($answer_value, $answer_unit);
 
         $points = 0.0;
         if ($answer_unit instanceof assFormulaQuestionUnit && $answer_unit instanceof assFormulaQuestionUnit) {
             $base1 = $units[$answer_unit->getBaseUnit()] ?? null;
             $base2 = $units[$answer_unit->getBaseUnit()] ?? null;
             if (
                 $base1 instanceof assFormulaQuestionUnit
                 && $base2 instanceof assFormulaQuestionUnit
                 && $base1->getId() === $base2->getId()
             ) {
                 $points += ilMath::_mul($this->getPoints(), ilMath::_div($this->getRatingUnit(), 100));
             }
         }
 
         if ($float_value === null) {
             return $points;
         }
 
         if ($this->checkSign($result, $float_value)) {
             $points += ilMath::_mul($this->getPoints(), ilMath::_div($this->getRatingSign(), 100));
         }
 
         if ($this->isInTolerance(abs($float_value), abs($result), $this->getTolerance())) {
             $points += ilMath::_mul($this->getPoints(), ilMath::_div($this->getRatingValue(), 100));
         }
 
         return $points;
     }

Here is the call graph for this function:

◆ getResult()

assFormulaQuestionResult::getResult ( )

Definition at line 571 of file class.assFormulaQuestionResult.php.

Referenced by assFormulaQuestion\addResult(), assFormulaQuestion\addResultUnit(), assFormulaQuestion\addResultUnits(), assFormulaQuestion\buildResultsForLog(), assFormulaQuestion\getResultUnits(), assFormulaQuestion\hasResultUnit(), assFormulaQuestionGUI\resetSavedPreviewSession(), and substituteFormula().

                                : string
     {
         return $this->result;
     }

Here is the caller graph for this function:

◆ getResultInfo()

assFormulaQuestionResult::getResultInfo	(	$variables,
		$results,
		$value,
		$unit,
		$units
	)

Definition at line 507 of file class.assFormulaQuestionResult.php.

References $results, ilMath\_mul(), checkSign(), getPoints(), getRatingSign(), getRatingSimple(), getRatingUnit(), getRatingValue(), getTolerance(), getUnit(), isCorrect(), isInTolerance(), and substituteFormula().

                                                                               : array
     {
         if ($this->getRatingSimple()) {
             if ($this->isCorrect($variables, $results, $value, $units[$unit] ?? null)) {
                 return ["points" => $this->getPoints()];
             } else {
                 return ["points" => 0];
             }
         } else {
             $totalpoints = 0;
             $formula = $this->substituteFormula($variables, $results);
             if (preg_match_all("/(\\\$v\\d+)/ims", $formula, $matches)) {
                 foreach ($matches[1] as $variable) {
                     $varObj = $variables[$variable];
                     $formula = preg_replace("/\\\$" . substr($variable, 1) . "(?![0-9]+)/", "(" . $varObj->getBaseValue() . ")" . "\\1", $formula);
                 }
             }
             $math = new EvalMath();
             $math->suppress_errors = true;
             $result = $math->evaluate($formula);
             if ($this->getUnit() !== null) {
                 $result = ilMath::_mul($result, $this->getUnit()->getFactor(), 100);
             }
             if (is_object($unit)) {
                 $value = ilMath::_mul($value, $unit->getFactor(), 100);
             } else {
             }
             $details = [];
             if ($this->checkSign($result, $value)) {
                 $points = ilMath::_mul($this->getPoints(), $this->getRatingSign() / 100);
                 $totalpoints += $points;
                 $details['sign'] = $points;
             }
             if ($this->isInTolerance(abs($value), abs($result), $this->getTolerance())) {
                 $points = ilMath::_mul($this->getPoints(), $this->getRatingValue() / 100);
                 $totalpoints += $points;
                 $details['value'] = $points;
             }
             if ($this->getUnit() !== null) {
                 $base1 = $units[$unit];
                 if (is_object($base1)) {
                     $base1 = $units[$base1->getBaseUnit()];
                 }
                 $base2 = $units[$this->getUnit()->getBaseUnit()];
                 if (is_object($base1) && is_object($base2) && $base1->getId() == $base2->getId()) {
                     $points = ilMath::_mul($this->getPoints(), $this->getRatingUnit() / 100);
                     $totalpoints += $points;
                     $details['unit'] = $points;
                 }
             }
             $details['points'] = $totalpoints;
             return $details;
         }
     }

Here is the call graph for this function:

◆ getResultType()

assFormulaQuestionResult::getResultType ( )

Definition at line 721 of file class.assFormulaQuestionResult.php.

Referenced by assFormulaQuestion\buildResultsForLog(), calculateFormula(), isCorrect(), and transformAnswerValueAccordingToType().

                                    : int
     {
         return (int) $this->result_type;
     }

Here is the caller graph for this function:

◆ getResultTypeByQstId()

static assFormulaQuestionResult::getResultTypeByQstId	(	$a_qst_id,
		$a_result
	)

static

Definition at line 746 of file class.assFormulaQuestionResult.php.

References $DIC, $ilDB, and $res.

Referenced by assFormulaQuestionGUI\getPreview(), and assFormulaQuestionGUI\getTestOutput().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $res = $ilDB->queryF(
             '
                         SELECT result_type
                         FROM il_qpl_qst_fq_res
                         WHERE question_fi = %s
                         AND result = %s',
             ['integer', 'text'],
             [$a_qst_id, $a_result]
         );
 
         $row = $ilDB->fetchAssoc($res);
 
         return $row['result_type'];
     }

Here is the caller graph for this function:

◆ getTolerance()

assFormulaQuestionResult::getTolerance ( )

Definition at line 631 of file class.assFormulaQuestionResult.php.

Referenced by assFormulaQuestion\buildResultsForLog(), getReachedPoints(), getResultInfo(), and isCorrect().

                                   : float
     {
         return $this->tolerance;
     }

Here is the caller graph for this function:

◆ getUnit()

assFormulaQuestionResult::getUnit ( )

Definition at line 641 of file class.assFormulaQuestionResult.php.

Referenced by assFormulaQuestion\buildResultsForLog(), calculateFormula(), getRangeMaxBase(), getRangeMinBase(), getResultInfo(), isCorrect(), and suggestRange().

                              : ?assFormulaQuestionUnit
     {
         return $this->unit;
     }

Here is the caller graph for this function:

◆ isCoprimeFraction()

static assFormulaQuestionResult::isCoprimeFraction	(	$numerator,
		$denominator
	)

static

Definition at line 766 of file class.assFormulaQuestionResult.php.

                                                                       : bool
     {
         $gcd = self::getGreatestCommonDivisor(abs($numerator), abs($denominator));
 
         return $gcd == 1 ? true : false;
     }

◆ isCorrect()

assFormulaQuestionResult::isCorrect	(	$variables,
		$results,
		$value,
		$unit = `null`
	)

Parameters

	$variables	array formula variables containing units
	$results	array formula results containing units
	$value	string user input value
null	$unit	user input unit

Returns: bool

Definition at line 219 of file class.assFormulaQuestionResult.php.

References $results, ilMath\_div(), ilMath\_mul(), getPrecision(), getResultType(), getTolerance(), getUnit(), isInTolerance(), RESULT_CO_FRAC, RESULT_DEC, RESULT_FRAC, RESULT_NO_SELECTION, and substituteFormula().

Referenced by getReachedPoints(), and getResultInfo().

                                                                          : bool
     {
         // The user did not answer the question ....
         if ($value === null || 0 == strlen($value)) {
             return false;
         }
         $value = str_replace(' ', '', $value);
 
         $formula = $this->substituteFormula($variables, $results);
 
         $check_valid_chars = true;
 
         if (preg_match_all("/(\\\$v\\d+)/ims", $formula, $matches)) {
             foreach ($matches[1] as $variable) {
                 $varObj = $variables[$variable];
                 if (!is_object($varObj) || !is_numeric($varObj->getValue())) {
                     continue;
                 }
 
                 if ($varObj->getUnit() != null) {
                     //convert unit and value to baseunit.... because vars could have different units
                     if ($varObj->getUnit()->getBaseUnit() != -1) {
                         $tmp_value = $varObj->getValue() * $varObj->getUnit()->getFactor();
                     } else {
                         $tmp_value = $varObj->getValue();
                     }
                 } else {
                     $tmp_value = $varObj->getValue();
                 }
 
                 $formula = preg_replace("/\\\$" . substr($variable, 1) . "(?![0-9]+)/", "(" . $tmp_value . ")" . "\\1", $formula);
             }
         }
 
         $math = new EvalMath();
         $math->suppress_errors = true;
         $result = $math->evaluate($formula); // baseunit-result!!
         $resultWithRespectedUnit = $result;
 
         if ($this->getUnit() !== null) {
             //there is a "fix" result_unit defined!
 
             // if expected resultunit != baseunit convert to "fix" result_unit
             if ($this->getUnit()->getBaseUnit() != -1) {
                 $resultWithRespectedUnit = ilMath::_div($result, $this->getUnit()->getFactor());
             }
         } elseif ($this->getUnit() == null && $unit != null) {
             // there is no "fix" result_unit defined, but the user has selected a unit ...
             // so .... there are "available resultunits" in multi-selectbox selected
             // -> check if selected user-unit is baseunit
             if ($unit->getFactor() != 1 && strlen(trim($unit->getFactor())) != 1) {
                 // result is already calculated to baseunit.... -> get correct precision..
                 $resultWithRespectedUnit = ilMath::_div($result, $unit->getFactor());
             }
         }
 
         $result = substr($result, 0, strlen($resultWithRespectedUnit));
 
         //      check for valid chars ("0-9",",|.|/","0-9","e|E","+|-","0-9")
         $has_valid_chars = preg_match("/^-?([0-9]*)(,|\\.|\\/){0,1}([0-9]*)([eE][\\+|-]([0-9])+)?$/", $value, $matches);
         if (!$has_valid_chars) {
             $check_valid_chars = false;
         } elseif (
             (isset($matches[2]) && $matches[2] == '/') &&
             (isset($matches[4]) && strtolower($matches[4]) == "e") &&
             (!isset($matches[1]) || !strlen($matches[1]) || !isset($matches[3]) || !strlen($matches[3]) || $matches[3] == 0)) {
             $check_valid_chars = false;
         }
 
         // result_type extension
         switch ($this->getResultType()) {
             case assFormulaQuestionResult::RESULT_DEC:
                 if (substr_count($value, '.') == 1 || substr_count($value, ',') == 1) {
                     $exp_val = $value;
                     $frac_value = str_replace(',', '.', $exp_val);
                 } else {
                     $frac_value = $value;
                 }
 
                 if (substr_count($value, '/') >= 1) {
                     $check_fraction = false;
                 } else {
                     $check_fraction = true;
                 }
                 break;
 
             case assFormulaQuestionResult::RESULT_FRAC:
             case assFormulaQuestionResult::RESULT_CO_FRAC:
                 $exp_val = explode('/', $value);
                 if (count($exp_val) == 1) {
                     $frac_value = ilMath::_div($exp_val[0], 1);
 
                     if (ilMath::_equals($frac_value, $resultWithRespectedUnit, $this->getPrecision())) {
                         $check_fraction = true;
                     } else {
                         $check_fraction = false;
                     }
                 } else {
                     try {
                         $frac_value = ilMath::_div($exp_val[0], $exp_val[1]);
                     } catch (ilMathDivisionByZeroException $ex) {
                         if ($result) {
                             return false;
                         } else {
                             return true;
                         }
                     }
                     $frac_value = str_replace(',', '.', $frac_value);
 
                     if (ilMath::_equals($frac_value, $resultWithRespectedUnit, $this->getPrecision())) {
                         $check_fraction = true;
                     }
 
                     if ($this->getResultType() == assFormulaQuestionResult::RESULT_CO_FRAC) {
                         if (!self::isCoprimeFraction($exp_val[0], $exp_val[1])) {
                             $check_fraction = false;
                         }
                     }
                 }
 
                 if (substr_count($value, '.') >= 1 || substr_count($value, ',') >= 1) {
                     $check_fraction = false;
                 }
                 break;
 
             case assFormulaQuestionResult::RESULT_NO_SELECTION:
             default:
                 if (substr_count($value, '.') == 1 || substr_count($value, ',') == 1) {
                     $frac_value = str_replace(',', '.', $value);
                 } elseif (substr_count($value, '/') == 1) {
                     $exp_val = explode('/', $value);
                     try {
                         $frac_value = ilMath::_div($exp_val[0], $exp_val[1]);
                     } catch (ilMathDivisionByZeroException $ex) {
                         if ($result) {
                             return false;
                         } else {
                             return true;
                         }
                     }
                 } else {
                     $frac_value = $value;
                 }
 
                 $check_fraction = true;
                 break;
         }
 
         if (is_object($unit)) {
             if (isset($frac_value)) {
                 $value = ilMath::_mul($frac_value, $unit->getFactor(), 100);
             }
         }
 
         $frac_value = ilMath::_round($frac_value, $this->getPrecision());
         $resultWithRespectedUnit = ilMath::_round($resultWithRespectedUnit, $this->getPrecision());
 
         $checkvalue = false;
         if (isset($frac_value)) {
             if ($this->isInTolerance($frac_value, $resultWithRespectedUnit, $this->getTolerance())) {
                 $checkvalue = true;
             }
         } else {
             if ($this->isInTolerance($value, $resultWithRespectedUnit, $this->getTolerance())) {
                 $checkvalue = true;
             }
         }
 
         $checkunit = true;
         if ($this->getUnit() !== null) {
             if (is_object($unit)) {
                 if ($unit->getId() != $this->getUnit()->getId()) {
                     $checkunit = false;
                 }
             }
         }
         return $checkvalue && $checkunit && $check_fraction && $check_valid_chars;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInTolerance()

assFormulaQuestionResult::isInTolerance	(	$user_answer,
		$expected,
		$tolerated_percentage
	)

protected

Definition at line 398 of file class.assFormulaQuestionResult.php.

References ilMath\_add(), ilMath\_div(), ilMath\_mul(), ilMath\_sub(), and getPrecision().

Referenced by getReachedPoints(), getResultInfo(), and isCorrect().

                                                                                     : bool
     {
         $user_answer = ilMath::_mul($user_answer, 1, $this->getPrecision());
         $tolerance_abs = abs(ilMath::_div(ilMath::_mul($tolerated_percentage, $expected, 100), 100));
         $lower_boundary = ilMath::_sub($expected, $tolerance_abs);
         $upper_boundary = ilMath::_add($expected, $tolerance_abs);
 
         return $lower_boundary <= $user_answer
             && $user_answer <= $upper_boundary;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFormula()

assFormulaQuestionResult::setFormula ( ?string $formula )

Definition at line 646 of file class.assFormulaQuestionResult.php.

                                                 : void
     {
         $this->formula = $formula;
     }

◆ setPoints()

assFormulaQuestionResult::setPoints ( float $points )

Definition at line 656 of file class.assFormulaQuestionResult.php.

                                             : void
     {
         $this->points = $points;
     }

◆ setPrecision()

assFormulaQuestionResult::setPrecision ( float $precision )

Definition at line 706 of file class.assFormulaQuestionResult.php.

                                                   : void
     {
         $this->precision = $precision;
     }

◆ setRangeMax()

assFormulaQuestionResult::setRangeMax ( ?string $range_max )

Definition at line 601 of file class.assFormulaQuestionResult.php.

Referenced by __construct(), and suggestRange().

                                                    : void
     {
         if ($range_max === null) {
             return;
         }
 
         $math = new EvalMath();
         $math->suppress_errors = true;
         $this->range_max = (float) $math->evaluate($range_max);
     }

Here is the caller graph for this function:

◆ setRangeMaxTxt()

assFormulaQuestionResult::setRangeMaxTxt ( string $range_max_txt )

Definition at line 726 of file class.assFormulaQuestionResult.php.

                                                          : void
     {
         $this->range_max_txt = $range_max_txt;
     }

◆ setRangeMin()

assFormulaQuestionResult::setRangeMin ( ?string $range_min )

Definition at line 576 of file class.assFormulaQuestionResult.php.

Referenced by __construct(), and suggestRange().

                                                    : void
     {
         if ($range_min === null) {
             return;
         }
 
         $math = new EvalMath();
         $math->suppress_errors = true;
         $this->range_min = (float) $math->evaluate($range_min);
     }

Here is the caller graph for this function:

◆ setRangeMinTxt()

assFormulaQuestionResult::setRangeMinTxt ( string $range_min_txt )

Definition at line 736 of file class.assFormulaQuestionResult.php.

                                                          : void
     {
         $this->range_min_txt = $range_min_txt;
     }

◆ setRatingSign()

assFormulaQuestionResult::setRatingSign ( float $rating_sign )

Definition at line 676 of file class.assFormulaQuestionResult.php.

                                                      : void
     {
         $this->rating_sign = $rating_sign;
     }

◆ setRatingSimple()

assFormulaQuestionResult::setRatingSimple ( bool $rating_simple )

Definition at line 666 of file class.assFormulaQuestionResult.php.

                                                         : void
     {
         $this->rating_simple = $rating_simple;
     }

◆ setRatingUnit()

assFormulaQuestionResult::setRatingUnit ( float $rating_unit )

Definition at line 696 of file class.assFormulaQuestionResult.php.

                                                      : void
     {
         $this->rating_unit = $rating_unit;
     }

◆ setRatingValue()

assFormulaQuestionResult::setRatingValue ( float $rating_value )

Definition at line 686 of file class.assFormulaQuestionResult.php.

                                                        : void
     {
         $this->rating_value = $rating_value;
     }

◆ setResult()

assFormulaQuestionResult::setResult ( $result )

Definition at line 566 of file class.assFormulaQuestionResult.php.

                                       : void
     {
         $this->result = $result;
     }

◆ setResultType()

assFormulaQuestionResult::setResultType ( int $a_result_type )

Definition at line 716 of file class.assFormulaQuestionResult.php.

                                                      : void
     {
         $this->result_type = $a_result_type;
     }

◆ setTolerance()

assFormulaQuestionResult::setTolerance ( $tolerance )

Definition at line 626 of file class.assFormulaQuestionResult.php.

                                             : void
     {
         $this->tolerance = $tolerance;
     }

◆ setUnit()

assFormulaQuestionResult::setUnit ( ?assFormulaQuestionUnit $unit )

Definition at line 636 of file class.assFormulaQuestionResult.php.

                                                           : void
     {
         $this->unit = $unit;
     }

◆ substituteFormula()

assFormulaQuestionResult::substituteFormula	(	array	$variables,
		array	$results
	)

Definition at line 75 of file class.assFormulaQuestionResult.php.

References getFormula(), getResult(), and ILIAS\Repository\lng().

Referenced by calculateFormula(), findValidRandomVariables(), getResultInfo(), isCorrect(), and suggestRange().

                                                                        : false|string
     {
         $formula = $this->getFormula();
         preg_match_all('/\$r\d+/mi', $formula, $matches);
 
         foreach ($matches[0] as $result) {
             if ($result === $this->getResult()) {
                 $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('errRecursionInResult'));
                 return false;
             }
 
             if (!isset($results[$result]) || !$results[$result] instanceof self) {
                 $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('errFormulaQuestion'));
                 return false;
             }
 
             $formula = preg_replace(
                 '/\\' . $result . '(?!\d)/m',
                 $results[$result]->substituteFormula($variables, $results),
                 $formula,
             );
         }
 
         return "({$formula})";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ suggestRange()

assFormulaQuestionResult::suggestRange	(	$variables,
		$results
	)

Definition at line 177 of file class.assFormulaQuestionResult.php.

References $results, ilMath\_div(), ilMath\_mul(), getPrecision(), getUnit(), setRangeMax(), setRangeMin(), and substituteFormula().

                                                       : void
     {
         //              @todo Check this
         $range_min = null;
         $range_max = null;
         for ($i = 0; $i < 1000; $i++) {
             $formula = $this->substituteFormula($variables, $results);
             if (preg_match_all("/(\\\$v\\d+)/ims", $formula, $matches)) {
                 foreach ($matches[1] as $variable) {
                     $varObj = $variables[$variable];
                     if (!is_object($varObj)) {
                         continue;
                     }
                     $varObj->setRandomValue();
                     $formula = preg_replace("/\\\$" . substr($variable, 1) . "(?![0-9]+)/", "(" . $varObj->getBaseValue() . ")" . "\\1", $formula);
                 }
             }
             $math = new EvalMath();
             $math->suppress_errors = true;
             $result = $math->evaluate($formula);
             if (($range_min == null) || ($result < $range_min)) {
                 $range_min = $result;
             }
             if (($range_max == null) || ($result > $range_max)) {
                 $range_max = $result;
             }
         }
         if ($this->getUnit() !== null) {
             $range_min = ilMath::_div($range_min, $this->getUnit()->getFactor());
             $range_max = ilMath::_div($range_max, $this->getUnit()->getFactor());
         }
         $this->setRangeMin(ilMath::_mul($range_min, 1, $this->getPrecision()));
         $this->setRangeMax(ilMath::_mul($range_max, 1, $this->getPrecision()));
     }

Here is the call graph for this function:

◆ transformAnswerValueAccordingToType()

assFormulaQuestionResult::transformAnswerValueAccordingToType	(	string	$value,
		?assFormulaQuestionUnit	$unit
	)

private

Definition at line 469 of file class.assFormulaQuestionResult.php.

References ilMath\_div(), getPrecision(), getResultType(), ILIAS\Repository\refinery(), and ILIAS\Refinery\transform().

Referenced by getReachedPoints().

      : ?float {
         switch ($this->getResultType()) {
             case self::RESULT_DEC:
                 break;
             case self::RESULT_FRAC:
             case self::RESULT_CO_FRAC:
                 $exp_val = explode('/', $value);
                 $value = ilMath::_div(
                     $exp_val[0],
                     count($exp_val) === 1 ? 1 : $exp_val[1],
                     $this->getPrecision()
                 );
                 break;
             case self::RESULT_NO_SELECTION:
             default:
                 $exp_val = explode('/', $value);
 
                 if (count($exp_val) === 2
                     && (float) $exp_val[1] === 0.0) {
                     return null;
                 }
 
                 $value = ilMath::_div(
                     $exp_val[0],
                     count($exp_val) === 1 ? 1 : $exp_val[1],
                     100
                 );
         }
 
         return $this->refinery->byTrying([
             $this->refinery->kindlyTo()->float(),
             $this->refinery->always(null),
         ])->transform(round($value, $this->precision));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $available_units

assFormulaQuestionResult::$available_units = []

private

Definition at line 38 of file class.assFormulaQuestionResult.php.

Referenced by getAvailableResultUnits().

◆ $lng

ilLanguage assFormulaQuestionResult::$lng

private

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

◆ $main_tpl

ilGlobalTemplateInterface assFormulaQuestionResult::$main_tpl

private

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

◆ $range_max

float assFormulaQuestionResult::$range_max = null

private

Definition at line 40 of file class.assFormulaQuestionResult.php.

Referenced by getRangeMax().

◆ $range_min

float assFormulaQuestionResult::$range_min = null

private

Definition at line 39 of file class.assFormulaQuestionResult.php.

Referenced by getRangeMin().

◆ $refinery

Refinery assFormulaQuestionResult::$refinery

private

Definition at line 35 of file class.assFormulaQuestionResult.php.

◆ RESULT_CO_FRAC

const assFormulaQuestionResult::RESULT_CO_FRAC = 3

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

Referenced by assFormulaQuestion\getBestSolution(), isCorrect(), assFormulaQuestionTest\simpleRatedCalculationsData(), and assFormulaQuestion\substituteVariables().

◆ RESULT_DEC

const assFormulaQuestionResult::RESULT_DEC = 1

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

Referenced by isCorrect(), assFormulaQuestionTest\simpleRatedCalculationsData(), and assFormulaQuestion\substituteVariables().

◆ RESULT_FRAC

const assFormulaQuestionResult::RESULT_FRAC = 2

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

Referenced by assFormulaQuestion\getBestSolution(), isCorrect(), assFormulaQuestionTest\simpleRatedCalculationsData(), and assFormulaQuestion\substituteVariables().

◆ RESULT_NO_SELECTION

const assFormulaQuestionResult::RESULT_NO_SELECTION = 0

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

Referenced by isCorrect(), assFormulaQuestionTest\simpleRatedCalculationsData(), and assFormulaQuestion\substituteVariables().

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

components/ILIAS/TestQuestionPool/classes/class.assFormulaQuestionResult.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ calculateCorrectResult()

◆ calculateFormula()

◆ checkSign()

◆ convertDecimalToCoprimeFraction()

◆ findValidRandomVariables()

◆ getAvailableResultUnits()

◆ getFormula()

◆ getGreatestCommonDivisor()

◆ getPoints()

◆ getPrecision()

◆ getRangeMax()

◆ getRangeMaxBase()

◆ getRangeMaxTxt()

◆ getRangeMin()

◆ getRangeMinBase()

◆ getRangeMinTxt()

◆ getRatingSign()

◆ getRatingSimple()

◆ getRatingUnit()

◆ getRatingValue()

◆ getReachedPoints()

◆ getResult()

◆ getResultInfo()

◆ getResultType()

◆ getResultTypeByQstId()

◆ getTolerance()

◆ getUnit()

◆ isCoprimeFraction()

◆ isCorrect()

◆ isInTolerance()

◆ setFormula()

◆ setPoints()

◆ setPrecision()

◆ setRangeMax()

◆ setRangeMaxTxt()

◆ setRangeMin()

◆ setRangeMinTxt()

◆ setRatingSign()

◆ setRatingSimple()

◆ setRatingUnit()

◆ setRatingValue()

◆ setResult()

◆ setResultType()

◆ setTolerance()

◆ setUnit()

◆ substituteFormula()

◆ suggestRange()

◆ transformAnswerValueAccordingToType()

Field Documentation

◆ $available_units

◆ $lng

◆ $main_tpl

◆ $range_max

◆ $range_min

◆ $refinery

◆ RESULT_CO_FRAC

◆ RESULT_DEC

◆ RESULT_FRAC

◆ RESULT_NO_SELECTION