Class for simple answers. More...

Inheritance diagram for ASS_AnswerSimple:

Collaboration diagram for ASS_AnswerSimple:

Public Member Functions
	__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 Attributes
string	$answertext

	$points

	$order

	$id

Detailed Description

Class for simple answers.

ASS_AnswerSimple is a class for simple answers used for example in cloze tests with text gap.

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

\

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

Constructor & Destructor Documentation

◆ __construct()

ASS_AnswerSimple::__construct	(	$answertext = `""`,
		$points = `0.0`,
		$order = `0`,
		$id = `-1`
	)

ASS_AnswerSimple constructor.

The constructor takes possible arguments an creates an instance of the ASS_AnswerSimple 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
integer	$id	The database id of the answer

Reimplemented in ASS_AnswerTrueFalse.

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

    {
        $this->answertext = $answertext;
        $this->setPoints($points);
        $this->order = $order;
        $this->id = $id;
    }

References $answertext, $id, $order, $points, and setPoints().

Here is the call graph for this function:

Member Function Documentation

◆ checkPoints()

ASS_AnswerSimple::checkPoints ( $a_points )

Checks, if the point value is numeric.

Parameters

$a_points double Points which are checked if they're numeric.

Returns: boolean true if the point value is numeric, false otherwise

See also: $points

@TODO Find usages and see if this method can be set deprecated due to the simpleton-pattern it is on is_numeric.

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

                                          : bool
    {
        return is_numeric($a_points);
    }

Referenced by setPoints(), ASS_AnswerImagemap\setPointsUnchecked(), and ASS_AnswerMultipleResponse\setPointsUnchecked().

Here is the caller graph for this function:

◆ fromNormalized()

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

Reimplemented in ASS_AnswerBinaryState, ASS_AnswerBinaryStateImage, assAnswerCloze, ASS_AnswerImagemap, ASS_AnswerMultipleResponse, ASS_AnswerMultipleResponseImage, and ASS_AnswerTrueFalse.

Definition at line 235 of file class.assAnswerSimple.php.

     : static
    {
        return new static(
            $transformations->string($normalized['answertext']),
            $transformations->float($normalized['points']),
            $transformations->int($normalized['order']),
            $transformations->denormalize($normalized['id'], Id::class)->getId()
        );
    }

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:

◆ getAnswertext()

ASS_AnswerSimple::getAnswertext ( )

Gets the answer text.

Returns the answer text

Returns: string answer text

See also: $answertext

Definition at line 106 of file class.assAnswerSimple.php.

                                   : string
    {
        return $this->answertext;
    }

References $answertext.

Referenced by assSingleChoiceGUI\buildAnswerPresentationForStatistics(), assMultipleChoiceGUI\buildAnswerPresentationForStatistics(), ilAssClozeTestFeedback\buildSelectGapOptionFeedbackLabel(), ilAssClozeTestFeedback\buildTextGapGivenAnswerFeedbackLabel(), assMultipleChoice\getCorrectSolutionForTextOutput(), assTextQuestion\getCorrectSolutionForTextOutput(), assAnswerCloze\getNumericValueFromAnswerText(), assAnswerCloze\setLowerBound(), assAnswerCloze\setUpperBound(), assTextQuestion\toLog(), and assTextSubset\toLog().

Here is the caller graph for this function:

◆ getId()

ASS_AnswerSimple::getId ( )

Gets the answer id.

Returns the answer id

Returns: integer answer id

See also: $id

Definition at line 92 of file class.assAnswerSimple.php.

                           : int
    {
        return $this->id;
    }

References $id.

◆ getOrder()

ASS_AnswerSimple::getOrder ( )

Gets the sort/display order.

Returns a nonnegative order value for display or sorting

Returns: integer order

See also: $order

Definition at line 150 of file class.assAnswerSimple.php.

                              : int
    {
        return $this->order;
    }

References $order.

◆ getPoints()

ASS_AnswerSimple::getPoints ( )

Gets the points.

Returns the points

Returns: double points

See also: $points

Definition at line 120 of file class.assAnswerSimple.php.

                               : float
    {
        return $this->points;
    }

References $points.

Referenced by assSingleChoice\getCorrectSolutionForTextOutput(), ASS_AnswerMultipleResponse\getPointsChecked(), assMultipleChoiceGUI\populateSpecificFeedbackInline(), assTextQuestion\toLog(), and assTextSubset\toLog().

Here is the caller graph for this function:

◆ setAnswertext()

ASS_AnswerSimple::setAnswertext ( $answertext = "" )

Sets the answer text.

Sets the answer text

Parameters

string $answertext The answer text

See also: $answertext

Definition at line 194 of file class.assAnswerSimple.php.

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

References $answertext.

Referenced by assClozeTestGUI\saveNumericGapCorrectionFormProperty().

Here is the caller graph for this function:

◆ setId()

ASS_AnswerSimple::setId ( $id = -1 )

Sets the answer id.

Parameters

integer $id answer id

See also: $id

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

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

References $id.

◆ setOrder()

ASS_AnswerSimple::setOrder ( $order = 0 )

Sets the order.

Sets the nonnegative order value which can be used for sorting or displaying multiple answers

Parameters

integer $order A nonnegative integer

See also: $order

@TODO Find usage and see if we can get rid of "magic ignorance" of the input value.

Definition at line 166 of file class.assAnswerSimple.php.

                                        : void
    {
        if ($order >= 0) {
            $this->order = $order;
        }
    }

References $order.

Referenced by assClozeTest\addAnswerOptionValue().

Here is the caller graph for this function:

◆ setPoints()

ASS_AnswerSimple::setPoints ( $points = 0.0 )

Sets the points.

Sets the points given for selecting the answer. You can even use negative values for wrong answers.

Parameters

double $points The points given for the answer

See also: $points

@TODO Find usages and see if we can get rid of "magic nullification" here.

Definition at line 210 of file class.assAnswerSimple.php.

                                            : void
    {
        $new_points = str_replace(",", ".", $points);
        if ($this->checkPoints($new_points)) {
            $this->points = $new_points;
        } else {
            $this->points = 0.0;
        }
    }

References $points, and checkPoints().

Referenced by __construct(), assSingleChoiceGUI\saveCorrectionsFormProperties(), assClozeTestGUI\saveNumericGapCorrectionFormProperty(), and ASS_AnswerMultipleResponse\setPointsChecked().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toNormalized()

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

Reimplemented in ASS_AnswerBinaryState, ASS_AnswerBinaryStateImage, assAnswerCloze, ASS_AnswerImagemap, ASS_AnswerMultipleResponse, ASS_AnswerMultipleResponseImage, and ASS_AnswerTrueFalse.

Definition at line 221 of file class.assAnswerSimple.php.

     : array|float|bool|int|string|null
    {
        return [
            'id' => $transformations->normalize(new Id($this->id, 'answer')),
            'answertext' => $this->answertext,
            'points' => $this->points,
            'order' => $this->order,
        ];
    }

References $answertext, $order, $points, and ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\normalize().

Here is the call graph for this function:

Field Documentation

◆ $answertext

string ASS_AnswerSimple::$answertext

protected

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

Referenced by ASS_AnswerImagemap\__construct(), ASS_AnswerTrueFalse\__construct(), __construct(), ASS_AnswerBinaryState\__construct(), assAnswerCloze\__construct(), ASS_AnswerMultipleResponse\__construct(), ASS_AnswerBinaryStateImage\__construct(), ASS_AnswerMultipleResponseImage\__construct(), getAnswertext(), setAnswertext(), and toNormalized().

◆ $id

ASS_AnswerSimple::$id

protected

Definition at line 63 of file class.assAnswerSimple.php.

Referenced by ASS_AnswerImagemap\__construct(), __construct(), ASS_AnswerBinaryState\__construct(), assAnswerCloze\__construct(), ASS_AnswerMultipleResponse\__construct(), ASS_AnswerBinaryStateImage\__construct(), ASS_AnswerMultipleResponseImage\__construct(), getId(), and setId().

◆ $order

ASS_AnswerSimple::$order

protected

Definition at line 54 of file class.assAnswerSimple.php.

Referenced by ASS_AnswerTrueFalse\__construct(), __construct(), ASS_AnswerBinaryState\__construct(), assAnswerCloze\__construct(), ASS_AnswerMultipleResponse\__construct(), ASS_AnswerBinaryStateImage\__construct(), ASS_AnswerMultipleResponseImage\__construct(), getOrder(), setOrder(), and toNormalized().

◆ $points

ASS_AnswerSimple::$points

protected

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

Referenced by ASS_AnswerImagemap\__construct(), ASS_AnswerTrueFalse\__construct(), __construct(), ASS_AnswerBinaryState\__construct(), assAnswerCloze\__construct(), ASS_AnswerMultipleResponse\__construct(), ASS_AnswerBinaryStateImage\__construct(), ASS_AnswerMultipleResponseImage\__construct(), getPoints(), setPoints(), and toNormalized().

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkPoints()

◆ fromNormalized()

◆ getAnswertext()

◆ getId()

◆ getOrder()

◆ getPoints()

◆ setAnswertext()

◆ setId()

◆ setOrder()

◆ setPoints()

◆ toNormalized()

Field Documentation

◆ $answertext

◆ $id

◆ $order

◆ $points