Formula Question Variable. More...

Inheritance diagram for assFormulaQuestionVariable:

Collaboration diagram for assFormulaQuestionVariable:

Public Member Functions
	__construct (private string $variable, private string $range_min_txt, private string $range_max_txt, private ?assFormulaQuestionUnit $unit=null, private int $precision=0, private int $intprecision=1)

	getRandomValue ()

	setRandomValue ()

	isIntPrecisionValid (?int $int_precision, float $min_range, float $max_range)

	setValue ($value)

	getValue ()

	getBaseValue ()

	setPrecision (int $precision)

	getPrecision ()

	setVariable ($variable)

	getVariable ()

	setRangeMin (string $range_min)

	getRangeMin ()

	setRangeMax (string $range_max)

	getRangeMax ()

	setUnit (?assFormulaQuestionUnit $unit)

	getUnit ()

	setIntprecision ($intprecision)

	getIntprecision ()

	setRangeMaxTxt (string $range_max_txt)

	getRangeMaxTxt ()

	setRangeMinTxt (string $range_min_txt)

	getRangeMinTxt ()

	toNormalized (Transformations $transformations, array $context=[])
	Convert the internal state of the implementing object into a language-neutral array structure. More...

	fromNormalized (array $normalized, Transformations $transformations)
	Restore the object from its normalized representation. More...

	toNormalized (Transformations $transformations, array $context=[])
	Convert the internal state of the implementing object into a language-neutral array structure. More...

	fromNormalized (array $normalized, Transformations $transformations)
	Restore the object from its normalized representation. More...

Private Attributes
	$value = null

float	$range_min

float	$range_max

Detailed Description

Formula Question Variable.

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.assFormulaQuestionVariable.php 465 2009-06-29 08:27:36Z hschottm

\

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

Constructor & Destructor Documentation

◆ __construct()

assFormulaQuestionVariable::__construct	(	private string	$variable,
		private string	$range_min_txt,
		private string	$range_max_txt,
		private ?assFormulaQuestionUnit	$unit = `null`,
		private int	$precision = `0`,
		private int	$intprecision = `1`
	)

Definition at line 37 of file class.assFormulaQuestionVariable.php.

      {
        $this->setRangeMin($range_min_txt);
        $this->setRangeMax($range_max_txt);
    }

References setRangeMax(), and setRangeMin().

Here is the call graph for this function:

Member Function Documentation

◆ fromNormalized()

assFormulaQuestionVariable::fromNormalized	(	array	$normalized,
		Transformations	$transformations
	)

Restore the object from its normalized representation.

Parameters

array<array-key,mixed> $normalized

Implements ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\FromNormalized.

Definition at line 224 of file class.assFormulaQuestionVariable.php.

     : static
    {
        $clone = clone $this;
        $clone->variable = $transformations->string($normalized['variable']);
        $clone->range_min = $transformations->float($normalized['range_min']);
        $clone->range_max = $transformations->float($normalized['range_max']);
        $clone->range_min_txt = $transformations->string($normalized['range_min_txt']);
        $clone->range_max_txt = $transformations->string($normalized['range_max_txt']);
        $clone->unit = $transformations->denormalize($normalized['unit'], new assFormulaQuestionUnit());
        $clone->precision = $transformations->int($normalized['precision']);
        $clone->intprecision = $transformations->int($normalized['intprecision']);
 
        return $clone;
    }

References ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\denormalize(), ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\float(), ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\int(), and ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\string().

Here is the call graph for this function:

◆ getBaseValue()

assFormulaQuestionVariable::getBaseValue ( )

Definition at line 112 of file class.assFormulaQuestionVariable.php.

    {
        if (!is_object($this->getUnit())) {
            return $this->value;
        } else {
            return ilMath::_mul($this->value, $this->getUnit()->getFactor());
        }
    }

References $value, ilMath\_mul(), and getUnit().

Here is the call graph for this function:

◆ getIntprecision()

assFormulaQuestionVariable::getIntprecision ( )

Definition at line 180 of file class.assFormulaQuestionVariable.php.

                                     : int
    {
        return $this->intprecision;
    }

Referenced by assFormulaQuestion\buildVariablesForLog(), and getRandomValue().

Here is the caller graph for this function:

◆ getPrecision()

assFormulaQuestionVariable::getPrecision ( )

Definition at line 126 of file class.assFormulaQuestionVariable.php.

                                  : int
    {
        return $this->precision;
    }

Referenced by assFormulaQuestion\buildVariablesForLog(), and getRandomValue().

Here is the caller graph for this function:

◆ getRandomValue()

assFormulaQuestionVariable::getRandomValue ( )

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

                                    : float
    {
        if (
            $this->getPrecision() === 0
            && !$this->isIntPrecisionValid(
                $this->getIntprecision(),
                $this->getRangeMin(),
                $this->getRangeMax()
            )
        ) {
            global $DIC;
            $DIC['tpl']->setOnScreenMessage('failure', $DIC['lng']->txt('err_divider_too_big'));
            return 0.0;
        }
 
        $mul = ilMath::_pow(10, $this->getPrecision());
        $r1 = round((float) ilMath::_mul($this->getRangeMin(), $mul));
        $r2 = round((float) ilMath::_mul($this->getRangeMax(), $mul));
        $calc_val = $this->getRangeMin() - 1.0;
 
        $rounded_range_min = round($this->getRangeMin(), $this->getPrecision());
        $rounded_range_max = round($this->getRangeMax(), $this->getPrecision());
        while ($calc_val < $rounded_range_min || $calc_val > $rounded_range_max) {
            $rnd = random_int((int) $r1, (int) $r2);
            $calc_val = (float) ilMath::_div($rnd, $mul, $this->getPrecision());
 
            if ($this->getPrecision() === 0 && $this->getIntprecision() > 0) {
                $modulo = $calc_val % $this->getIntprecision();
                if ($modulo !== 0) {
                    $calc_val = $modulo < ilMath::_div($this->getIntprecision(), 2)
                        ? (float) ilMath::_sub($calc_val, $modulo, $this->getPrecision())
                        : (float) ilMath::_add($calc_val, ilMath::_sub($this->getIntprecision(), $modulo, $this->getPrecision()), $this->getPrecision());
                }
            }
        }
 
        return $calc_val;
    }

References $DIC, ilMath\_add(), ilMath\_div(), ilMath\_mul(), ilMath\_pow(), ilMath\_sub(), getIntprecision(), getPrecision(), getRangeMax(), getRangeMin(), and isIntPrecisionValid().

Referenced by setRandomValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRangeMax()

assFormulaQuestionVariable::getRangeMax ( )

Definition at line 160 of file class.assFormulaQuestionVariable.php.

                                 : float
    {
        return $this->range_max;
    }

References $range_max.

Referenced by getRandomValue().

Here is the caller graph for this function:

◆ getRangeMaxTxt()

assFormulaQuestionVariable::getRangeMaxTxt ( )

Definition at line 190 of file class.assFormulaQuestionVariable.php.

                                    : string
    {
        return $this->range_max_txt;
    }

Referenced by assFormulaQuestion\buildVariablesForLog().

Here is the caller graph for this function:

◆ getRangeMin()

assFormulaQuestionVariable::getRangeMin ( )

Definition at line 148 of file class.assFormulaQuestionVariable.php.

                                 : float
    {
        return $this->range_min;
    }

References $range_min.

Referenced by getRandomValue().

Here is the caller graph for this function:

◆ getRangeMinTxt()

assFormulaQuestionVariable::getRangeMinTxt ( )

Definition at line 200 of file class.assFormulaQuestionVariable.php.

                                    : string
    {
        return $this->range_min_txt;
    }

Referenced by assFormulaQuestion\buildVariablesForLog().

Here is the caller graph for this function:

◆ getUnit()

assFormulaQuestionVariable::getUnit ( )

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

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

Referenced by assFormulaQuestion\buildVariablesForLog(), and getBaseValue().

Here is the caller graph for this function:

◆ getValue()

assFormulaQuestionVariable::getValue ( )

Definition at line 107 of file class.assFormulaQuestionVariable.php.

    {
        return $this->value;
    }

References $value.

◆ getVariable()

assFormulaQuestionVariable::getVariable ( )

Definition at line 136 of file class.assFormulaQuestionVariable.php.

                                 : string
    {
        return $this->variable;
    }

Referenced by assFormulaQuestion\addVariable(), and assFormulaQuestion\buildVariablesForLog().

Here is the caller graph for this function:

◆ isIntPrecisionValid()

assFormulaQuestionVariable::isIntPrecisionValid	(	?int	$int_precision,
		float	$min_range,
		float	$max_range
	)

Definition at line 93 of file class.assFormulaQuestionVariable.php.

                                                                                                : bool
    {
        return $int_precision !== null && $int_precision <= max(abs($max_range), abs($min_range));
    }

Referenced by getRandomValue().

Here is the caller graph for this function:

◆ setIntprecision()

assFormulaQuestionVariable::setIntprecision ( $intprecision )

Definition at line 175 of file class.assFormulaQuestionVariable.php.

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

◆ setPrecision()

assFormulaQuestionVariable::setPrecision ( int $precision )

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

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

◆ setRandomValue()

assFormulaQuestionVariable::setRandomValue ( )

Definition at line 88 of file class.assFormulaQuestionVariable.php.

                                    : void
    {
        $this->setValue($this->getRandomValue());
    }

References getRandomValue(), and setValue().

Here is the call graph for this function:

◆ setRangeMax()

assFormulaQuestionVariable::setRangeMax ( string $range_max )

Definition at line 153 of file class.assFormulaQuestionVariable.php.

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

References $range_max.

Referenced by __construct().

Here is the caller graph for this function:

◆ setRangeMaxTxt()

assFormulaQuestionVariable::setRangeMaxTxt ( string $range_max_txt )

Definition at line 185 of file class.assFormulaQuestionVariable.php.

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

◆ setRangeMin()

assFormulaQuestionVariable::setRangeMin ( string $range_min )

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

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

References $range_min.

Referenced by __construct().

Here is the caller graph for this function:

◆ setRangeMinTxt()

assFormulaQuestionVariable::setRangeMinTxt ( string $range_min_txt )

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

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

◆ setUnit()

assFormulaQuestionVariable::setUnit ( ?assFormulaQuestionUnit $unit )

Definition at line 165 of file class.assFormulaQuestionVariable.php.

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

◆ setValue()

assFormulaQuestionVariable::setValue ( $value )

Definition at line 102 of file class.assFormulaQuestionVariable.php.

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

References $value.

Referenced by setRandomValue().

Here is the caller graph for this function:

◆ setVariable()

assFormulaQuestionVariable::setVariable ( $variable )

Definition at line 131 of file class.assFormulaQuestionVariable.php.

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

◆ toNormalized()

assFormulaQuestionVariable::toNormalized	(	Transformations	$transformations,
		array	$context = `[]`
	)

Convert the internal state of the implementing object into a language-neutral array structure.

The resulting array must contain only null, scalar values (string, int, float, bool) and nested arrays following the same rules.

Parameters

array<string,mixed> $context

Returns: array<array-key, mixed>|float|bool|int|string|null

Implements ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\ToNormalized.

Definition at line 206 of file class.assFormulaQuestionVariable.php.

     : array|float|bool|int|string|null
    {
        return [
            'variable' => $this->variable,
            'range_min' => $this->range_min,
            'range_max' => $this->range_max,
            'range_min_txt' => $this->range_min_txt,
            'range_max_txt' => $this->range_max_txt,
            'unit' => $transformations->normalize($this->unit),
            'precision' => $this->precision,
            'intprecision' => $this->intprecision,
        ];
    }

References $range_max, $range_min, and ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\normalize().

Here is the call graph for this function:

Field Documentation

◆ $range_max

float assFormulaQuestionVariable::$range_max

private

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

Referenced by getRangeMax(), setRangeMax(), and toNormalized().

◆ $range_min

float assFormulaQuestionVariable::$range_min

private

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

Referenced by getRangeMin(), setRangeMin(), and toNormalized().

◆ $value

assFormulaQuestionVariable::$value = null

private

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

Referenced by getBaseValue(), getValue(), and setValue().

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fromNormalized()

◆ getBaseValue()

◆ getIntprecision()

◆ getPrecision()

◆ getRandomValue()

◆ getRangeMax()

◆ getRangeMaxTxt()

◆ getRangeMin()

◆ getRangeMinTxt()

◆ getUnit()

◆ getValue()

◆ getVariable()

◆ isIntPrecisionValid()

◆ setIntprecision()

◆ setPrecision()

◆ setRandomValue()

◆ setRangeMax()

◆ setRangeMaxTxt()

◆ setRangeMin()

◆ setRangeMinTxt()

◆ setUnit()

◆ setValue()

◆ setVariable()

◆ toNormalized()

Field Documentation

◆ $range_max

◆ $range_min

◆ $value