ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ASS_AnswerSimple Class Reference

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

Protected Attributes

 $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
Version
$Id$

Definition at line 18 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$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$idThe database id of the answer
Returns
ASS_AnswerSimple

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

69 {
70 $this->answertext = $answertext;
71 $this->setPoints($points);
72 $this->order = $order;
73 $this->id = $id;
74 }
setPoints($points=0.0)
Sets the points.

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_pointsdouble 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 129 of file class.assAnswerSimple.php.

130 {
131 return is_numeric($a_points);
132 }

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

+ Here is the caller 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 99 of file class.assAnswerSimple.php.

100 {
101 return $this->answertext;
102 }

References $answertext.

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

+ 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 85 of file class.assAnswerSimple.php.

86 {
87 return $this->id;
88 }

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

144 {
145 return $this->order;
146 }

References $order.

◆ getPoints()

ASS_AnswerSimple::getPoints ( )

Gets the points.

Returns the points

Returns
double points
See also
$points

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

114 {
115 return $this->points;
116 }

References $points.

Referenced by ASS_AnswerMultipleResponse\getPointsChecked().

+ Here is the caller graph for this function:

◆ setAnswertext()

ASS_AnswerSimple::setAnswertext (   $answertext = "")

Sets the answer text.

Sets the answer text

Parameters
string$answertextThe answer text
See also
$answertext

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

189 {
190 $this->answertext = $answertext;
191 }

References $answertext.

◆ setId()

ASS_AnswerSimple::setId (   $id = -1)

Sets the answer id.

Parameters
integer$idanswer id
See also
$id

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

175 {
176 $this->id = $id;
177 }

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$orderA 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 159 of file class.assAnswerSimple.php.

160 {
161 if ($order >= 0)
162 {
163 $this->order = $order;
164 }
165 }

References $order.

◆ 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$pointsThe 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 204 of file class.assAnswerSimple.php.

205 {
206 $new_points = str_replace(",", ".", $points);
207 if ($this->checkPoints($new_points))
208 {
209 $this->points = $new_points;
210 }
211 else
212 {
213 $this->points = 0.0;
214 }
215 }
checkPoints($a_points)
Checks, if the point value is numeric.

References $points, and checkPoints().

Referenced by __construct(), and ASS_AnswerMultipleResponse\setPointsChecked().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $answertext

◆ $id

◆ $order

◆ $points


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