Class for true/false or yes/no answers. More...

Inheritance diagram for ASS_AnswerBinaryState:

Collaboration diagram for ASS_AnswerBinaryState:

Public Member Functions
	__construct (string $answertext="", float $points=0.0, int $order=0, bool $checked=false, int $id=-1)
	ASS_AnswerBinaryState constructor The constructor takes possible arguments and creates an instance of the ASS_AnswerBinaryState object. More...

	getState ()
	Gets the state. More...

	isStateChecked ()
	Gets the state. More...

	isStateSet ()
	Gets the state. More...

	isStateUnset ()
	Gets the state. More...

	isStateUnchecked ()
	Gets the state. More...

	setState (bool $state=false)
	Sets the state. More...

	setChecked ()
	Sets the answer as a checked answer. More...

	setSet ()
	Sets the answer as a set answer. More...

	setUnset ()
	Sets the answer as a unset answer. More...

	setUnchecked ()
	Sets the answer as a unchecked answer. 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...

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

Private Attributes
bool	$checked

Additional Inherited Members
Protected Attributes inherited from ASS_AnswerSimple
string	$answertext

	$points

	$order

	$id

Detailed Description

Class for true/false or yes/no answers.

ASS_AnswerBinaryState is a class for answers with a binary state indicator (checked/unchecked, set/unset)

Todo:

Get rid of duplicate methods (hiding behind different names.

Rework class to use a true binary state (boolean) instead of integer

Rename class to something that matches the filename properly.

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_AnswerSimple

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

Constructor & Destructor Documentation

◆ __construct()

ASS_AnswerBinaryState::__construct	(	string	$answertext = `""`,
		float	$points = `0.0`,
		int	$order = `0`,
		bool	$checked = `false`,
		int	$id = `-1`
	)

ASS_AnswerBinaryState constructor The constructor takes possible arguments and creates an instance of the ASS_AnswerBinaryState 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	$state	A integer value indicating the state of the answer
integer	$id	The database id of the answer

Definition at line 53 of file class.assAnswerBinaryState.php.

    {
        parent::__construct($answertext, $points, $order, $id);
        $this->checked = $checked;
    }

References ASS_AnswerSimple\$answertext, $checked, ASS_AnswerSimple\$id, ASS_AnswerSimple\$order, ASS_AnswerSimple\$points, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

Here is the call graph for this function:

Member Function Documentation

◆ fromNormalized()

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

Restore the object from its normalized representation.

Parameters

array<array-key,mixed> $normalized

Reimplemented from ASS_AnswerSimple.

Reimplemented in ASS_AnswerBinaryStateImage, and ASS_AnswerImagemap.

Definition at line 199 of file class.assAnswerBinaryState.php.

     : static
    {
        $clone = parent::fromNormalized($normalized, $transformations);
        $clone->setState($transformations->bool($normalized['checked']));
        return $clone;
    }

References ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\bool().

Here is the call graph for this function:

◆ getState()

ASS_AnswerBinaryState::getState ( )

Gets the state.

Returns the state of the answer

Returns: boolean state

See also: $state

Definition at line 67 of file class.assAnswerBinaryState.php.

                              : bool
    {
        return $this->checked;
    }

References $checked.

◆ isStateChecked()

ASS_AnswerBinaryState::isStateChecked ( )

Gets the state.

Returns the answer state

Returns: boolean state

See also: $state

Definition at line 80 of file class.assAnswerBinaryState.php.

                                    : bool
    {
        return $this->checked;
    }

References $checked.

◆ isStateSet()

ASS_AnswerBinaryState::isStateSet ( )

Gets the state.

Returns the answer state

Returns: boolean state

See also: $state

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

                                : bool
    {
        return $this->checked;
    }

References $checked.

◆ isStateUnchecked()

ASS_AnswerBinaryState::isStateUnchecked ( )

Gets the state.

Returns the answer state

Returns: boolean state

See also: $state

Definition at line 119 of file class.assAnswerBinaryState.php.

                                      : bool
    {
        return !$this->checked;
    }

References $checked.

◆ isStateUnset()

ASS_AnswerBinaryState::isStateUnset ( )

Gets the state.

Returns the answer state

Returns: boolean state

See also: $state

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

                                  : bool
    {
        return !$this->checked;
    }

References $checked.

◆ setChecked()

ASS_AnswerBinaryState::setChecked ( )

Sets the answer as a checked answer.

Sets the state value of the answer to 1

See also: $state

Definition at line 145 of file class.assAnswerBinaryState.php.

                                : void
    {
        $this->checked = true;
    }

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

Here is the call graph for this function:

◆ setSet()

ASS_AnswerBinaryState::setSet ( )

Sets the answer as a set answer.

Sets the state value of the answer to 1

See also: $state

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

                            : void
    {
        $this->checked = true;
    }

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

Here is the call graph for this function:

◆ setState()

ASS_AnswerBinaryState::setState ( bool $state = false )

Sets the state.

Sets the state of the answer using 1 or 0 as indicator

Parameters

bool | int $state A integer value indicating the state of the answer

See also: $state

Definition at line 133 of file class.assAnswerBinaryState.php.

                                                 : void
    {
        $this->checked = $state;
    }

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

Here is the call graph for this function:

◆ setUnchecked()

ASS_AnswerBinaryState::setUnchecked ( )

Sets the answer as a unchecked answer.

Sets the state value of the answer to 0

See also: $state

Definition at line 181 of file class.assAnswerBinaryState.php.

                                  : void
    {
        $this->checked = false;
    }

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

Here is the call graph for this function:

◆ setUnset()

ASS_AnswerBinaryState::setUnset ( )

Sets the answer as a unset answer.

Sets the state value of the answer to 0

See also: $state

Definition at line 169 of file class.assAnswerBinaryState.php.

                              : void
    {
        $this->checked = false;
    }

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

Here is the call graph for this function:

◆ toNormalized()

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

Reimplemented in ASS_AnswerBinaryStateImage, and ASS_AnswerImagemap.

Definition at line 187 of file class.assAnswerBinaryState.php.

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

References $checked.

Field Documentation

◆ $checked

bool ASS_AnswerBinaryState::$checked

private

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

Referenced by __construct(), getState(), isStateChecked(), isStateSet(), isStateUnchecked(), isStateUnset(), and toNormalized().

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fromNormalized()

◆ getState()

◆ isStateChecked()

◆ isStateSet()

◆ isStateUnchecked()

◆ isStateUnset()

◆ setChecked()

◆ setSet()

◆ setState()

◆ setUnchecked()

◆ setUnset()

◆ toNormalized()

Field Documentation

◆ $checked