Class for cloze question numeric answers. More...

Inheritance diagram for assAnswerCloze:

Collaboration diagram for assAnswerCloze:

Public Member Functions
	__construct (string $answertext="", float $points=0.0, int $order=0, int $id=-1, int $state=0)
	assAnswerCloze constructor More...

	setLowerBound (string $bound)
	Sets the lower boind. More...

	setUpperBound (string $bound)
	Sets the upper bound. More...

	getLowerBound ()
	Returns the lower bound. More...

	getUpperBound ()
	Returns the upper bound. More...

	setGapSize (int $gap_size)

	getGapSize ()

	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...

Public Member Functions inherited from ASS_AnswerSimple
	__construct ($answertext="", $points=0.0, $order=0, $id=-1)
	ASS_AnswerSimple constructor. More...

	getId ()
	Gets the answer id. More...

	getAnswertext ()
	Gets the answer text. More...

	getPoints ()
	Gets the points. More...

	checkPoints ($a_points)
	Checks, if the point value is numeric. More...

	getOrder ()
	Gets the sort/display order. More...

	setOrder ($order=0)
	Sets the order. More...

	setId ($id=-1)
	Sets the answer id. More...

	setAnswertext ($answertext="")
	Sets the answer text. More...

	setPoints ($points=0.0)
	Sets the points. 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...

	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...

Protected Member Functions
	getNumericValueFromAnswerText ()

	getNumericValueFromText ($text)

Protected Attributes
string	$lowerBound

string	$upperBound

int	$gap_size

Protected Attributes inherited from ASS_AnswerSimple
string	$answertext

	$points

	$order

	$id

Detailed Description

Class for cloze question numeric answers.

assAnswerCloze is a class for cloze questions numeric answers.

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; Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

\

See also: ASS_AnswerBinaryState

@TODO Rework class to represent bounds as numerics instead of strings.

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

Constructor & Destructor Documentation

◆ __construct()

assAnswerCloze::__construct	(	string	$answertext = `""`,
		float	$points = `0.0`,
		int	$order = `0`,
		int	$id = `-1`,
		int	$state = `0`
	)

assAnswerCloze constructor

The constructor takes possible arguments an creates an instance of the assAnswerCloze object.

Parameters

string	$answertext	A string defining the answer text
double	$points	The number of points given for the selected answer
integer	$order	A nonnegative value representing a possible display or sort order @TODO See if the initialization of the bounds to null can be avoided to have them string/numeric at all times.

Definition at line 64 of file class.assAnswerCloze.php.

    {
        parent::__construct($answertext, $points, $order, $id, $state);
        $this->lowerBound = null;
        $this->upperBound = null;
        $this->gap_size = 0;
    }

References ASS_AnswerSimple\$answertext, ASS_AnswerSimple\$id, ASS_AnswerSimple\$order, ASS_AnswerSimple\$points, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ fromNormalized()

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

Restore the object from its normalized representation.

Parameters

array<array-key,mixed> $normalized

Reimplemented from ASS_AnswerSimple.

Definition at line 171 of file class.assAnswerCloze.php.

     : static
    {
        $clone = parent::fromNormalized($normalized, $transformations);
        $clone->lowerBound = $transformations->nullableString($normalized['lower_bound']);
        $clone->upperBound = $transformations->nullableString($normalized['upper_bound']);
        $clone->gap_size = $transformations->int($normalized['gap_size']);
        return $clone;
    }

References ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\int(), and ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\nullableString().

Here is the call graph for this function:

◆ getGapSize()

assAnswerCloze::getGapSize ( )

Returns: int

Definition at line 151 of file class.assAnswerCloze.php.

                                : int
    {
        return $this->gap_size;
    }

References $gap_size.

◆ getLowerBound()

assAnswerCloze::getLowerBound ( )

Returns the lower bound.

Returns: null|string

Definition at line 125 of file class.assAnswerCloze.php.

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

References $lowerBound.

◆ getNumericValueFromAnswerText()

assAnswerCloze::getNumericValueFromAnswerText ( )

protected

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

    {
        return $this->getNumericValueFromText($this->getAnswertext());
    }

References ASS_AnswerSimple\getAnswertext(), and getNumericValueFromText().

Referenced by setLowerBound(), and setUpperBound().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNumericValueFromText()

assAnswerCloze::getNumericValueFromText ( $text )

protected

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

    {
        $eval = new EvalMath();
        $eval->suppress_errors = true;
        return $eval->e(str_replace(",", ".", ilUtil::stripSlashes($text, false)));
    }

References $text, and ilUtil\stripSlashes().

Referenced by getNumericValueFromAnswerText(), setLowerBound(), and setUpperBound().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUpperBound()

assAnswerCloze::getUpperBound ( )

Returns the upper bound.

Returns: null|string

Definition at line 135 of file class.assAnswerCloze.php.

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

References $upperBound.

◆ setGapSize()

assAnswerCloze::setGapSize ( int $gap_size )

Parameters

int $gap_size

Definition at line 143 of file class.assAnswerCloze.php.

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

References $gap_size.

◆ setLowerBound()

assAnswerCloze::setLowerBound ( string $bound )

Sets the lower boind.

Parameters

$bound string A string defining the lower bound of an answer for numeric gaps. @TODO: Refactor method to get rid of "locale magic".

Definition at line 78 of file class.assAnswerCloze.php.

                                                : void
    {
        $boundvalue = $this->getNumericValueFromText($bound);
        $value = $this->getNumericValueFromAnswerText();
 
        if ($boundvalue === false || $boundvalue > $value) {
            $this->lowerBound = $this->getAnswertext();
        } else {
            $this->lowerBound = $bound;
        }
    }

References ASS_AnswerSimple\getAnswertext(), getNumericValueFromAnswerText(), and getNumericValueFromText().

Referenced by assClozeTestGUI\saveNumericGapCorrectionFormProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUpperBound()

assAnswerCloze::setUpperBound ( string $bound )

Sets the upper bound.

Parameters

$bound string A string defining the upper bound of an answer for numeric gaps. @TODO: Refactor method to get rid of "locale magic".

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

                                                : void
    {
        $boundvalue = $this->getNumericValueFromText($bound);
        $value = $this->getNumericValueFromAnswerText();
 
        if ($boundvalue === false || $boundvalue < $value) {
            $this->upperBound = $this->getAnswertext();
        } else {
            $this->upperBound = $bound;
        }
    }

References ASS_AnswerSimple\getAnswertext(), getNumericValueFromAnswerText(), and getNumericValueFromText().

Referenced by assClozeTestGUI\saveNumericGapCorrectionFormProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toNormalized()

assAnswerCloze::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

Reimplemented from ASS_AnswerSimple.

Definition at line 157 of file class.assAnswerCloze.php.

     : array|float|bool|int|string|null
    {
        return [
            ...$transformations->normalize(parent::toNormalized($transformations, $context)),
            'lower_bound' => $this->lowerBound,
            'upper_bound' => $this->upperBound,
            'gap_size' => $this->gap_size,
        ];
    }

References $gap_size, $lowerBound, and $upperBound.

Field Documentation

◆ $gap_size

int assAnswerCloze::$gap_size

protected

Definition at line 51 of file class.assAnswerCloze.php.

Referenced by getGapSize(), setGapSize(), and toNormalized().

◆ $lowerBound

string assAnswerCloze::$lowerBound

protected

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

Referenced by getLowerBound(), and toNormalized().

◆ $upperBound

string assAnswerCloze::$upperBound

protected

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

Referenced by getUpperBound(), and toNormalized().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fromNormalized()

◆ getGapSize()

◆ getLowerBound()

◆ getNumericValueFromAnswerText()

◆ getNumericValueFromText()

◆ getUpperBound()

◆ setGapSize()

◆ setLowerBound()

◆ setUpperBound()

◆ toNormalized()

Field Documentation

◆ $gap_size

◆ $lowerBound

◆ $upperBound