ILIAS  trunk Revision v11.0_alpha-1715-g7fc467680fb
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ASS_AnswerBinaryState Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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...
 
- 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...
 

Private Attributes

bool $checked
 

Additional Inherited Members

- Protected Attributes inherited from ASS_AnswerSimple
string $answertext
 
 $points
 
 $order
 
 $id
 

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

Rename class to something that matches the filename properly.

Todo:
Rework class to use a true binary state (boolean) instead of integer
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 38 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$answertextA string defining the answer text
double$pointsThe number of points given for the selected answer
integer$orderA nonnegative value representing a possible display or sort order
integer$stateA integer value indicating the state of the answer
integer$idThe database id of the answer

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

References ASS_AnswerSimple\$answertext, $checked, 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

◆ getState()

ASS_AnswerBinaryState::getState ( )

Gets the state.

Returns the state of the answer

Returns
boolean state
See also
$state

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

References $checked.

65  : bool
66  {
67  return $this->checked;
68  }

◆ isStateChecked()

ASS_AnswerBinaryState::isStateChecked ( )

Gets the state.

Returns the answer state

Returns
boolean state
See also
$state

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

References $checked.

78  : bool
79  {
80  return $this->checked;
81  }

◆ isStateSet()

ASS_AnswerBinaryState::isStateSet ( )

Gets the state.

Returns the answer state

Returns
boolean state
See also
$state

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

References $checked.

91  : bool
92  {
93  return $this->checked;
94  }

◆ isStateUnchecked()

ASS_AnswerBinaryState::isStateUnchecked ( )

Gets the state.

Returns the answer state

Returns
boolean state
See also
$state

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

References $checked.

117  : bool
118  {
119  return !$this->checked;
120  }

◆ isStateUnset()

ASS_AnswerBinaryState::isStateUnset ( )

Gets the state.

Returns the answer state

Returns
boolean state
See also
$state

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

References $checked.

104  : bool
105  {
106  return !$this->checked;
107  }

◆ 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 143 of file class.assAnswerBinaryState.php.

143  : void
144  {
145  $this->checked = true;
146  }

◆ 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 155 of file class.assAnswerBinaryState.php.

155  : void
156  {
157  $this->checked = true;
158  }

◆ 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$stateA integer value indicating the state of the answer
See also
$state

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

131  : void
132  {
133  $this->checked = $state;
134  }

◆ 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 179 of file class.assAnswerBinaryState.php.

179  : void
180  {
181  $this->checked = false;
182  }

◆ 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 167 of file class.assAnswerBinaryState.php.

167  : void
168  {
169  $this->checked = false;
170  }

Field Documentation

◆ $checked

bool ASS_AnswerBinaryState::$checked
private

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