ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
ASS_AnswerBinaryState Class Reference

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

+ Inheritance diagram for ASS_AnswerBinaryState:
+ Collaboration diagram for ASS_AnswerBinaryState:

Public Member Functions

 ASS_AnswerBinaryState ($answertext="", $points=0.0, $order=0, $state=0, $id=-1)
 ASS_AnswerBinaryState constructor.
 getState ()
 Gets the state.
 isStateChecked ()
 Gets the state.
 isStateSet ()
 Gets the state.
 isStateUnset ()
 Gets the state.
 isStateUnchecked ()
 Gets the state.
 setState ($state=0)
 Sets the state.
 setChecked ()
 Sets the answer as a checked answer.
 setSet ()
 Sets the answer as a set answer.
 setUnset ()
 Sets the answer as a unset answer.
 setUnchecked ()
 Sets the answer as a unchecked answer.
- Public Member Functions inherited from ASS_AnswerSimple
 ASS_AnswerSimple ($answertext="", $points=0.0, $order=0, $id=-1)
 ASS_AnswerSimple constructor.
 getId ()
 Gets the answer id.
 getAnswertext ()
 Gets the answer text.
 getPoints ()
 Gets the points.
 checkPoints ($a_points)
 Checks, if the point value is numeric.
 getOrder ()
 Gets the sort/display order.
 setOrder ($order=0)
 Sets the order.
 setId ($id=-1)
 Sets the answer id.
 setAnswertext ($answertext="")
 Sets the answer text.
 setPoints ($points=0.0)
 Sets the points.

Data Fields

 $state
- Data Fields inherited from ASS_AnswerSimple
 $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
Version
$Id$
See Also
ASS_AnswerSimple

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

Member Function Documentation

ASS_AnswerBinaryState::ASS_AnswerBinaryState (   $answertext = "",
  $points = 0.0,
  $order = 0,
  $state = 0,
  $id = -1 
)

ASS_AnswerBinaryState constructor.

The constructor takes possible arguments an 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$stateA integer value indicating the state of the answer
integer$orderA nonnegative value representing a possible display or sort order public

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

References ASS_AnswerSimple\$answertext, ASS_AnswerSimple\$id, ASS_AnswerSimple\$order, ASS_AnswerSimple\$points, $state, and ASS_AnswerSimple\ASS_AnswerSimple().

Referenced by ASS_AnswerBinaryStateImage\ASS_AnswerBinaryStateImage(), and ASS_AnswerImagemap\ASS_AnswerImagemap().

{
$this->state = $state;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ASS_AnswerBinaryState::getState ( )

Gets the state.

Returns the state of the answer

Returns
boolean state public
See Also
$state

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

References $state.

{
return $this->state;
}
ASS_AnswerBinaryState::isStateChecked ( )

Gets the state.

Returns the answer state

Returns
boolean state public
See Also
$state

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

References $state.

{
return $this->state;
}
ASS_AnswerBinaryState::isStateSet ( )

Gets the state.

Returns the answer state

Returns
boolean state public
See Also
$state

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

References $state.

{
return $this->state;
}
ASS_AnswerBinaryState::isStateUnchecked ( )

Gets the state.

Returns the answer state

Returns
boolean state public
See Also
$state

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

References $state.

{
return !$this->state;
}
ASS_AnswerBinaryState::isStateUnset ( )

Gets the state.

Returns the answer state

Returns
boolean state public
See Also
$state

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

References $state.

{
return !$this->state;
}
ASS_AnswerBinaryState::setChecked ( )

Sets the answer as a checked answer.

Sets the state value of the answer to 1

public

See Also
$state

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

{
$this->state = 1;
}
ASS_AnswerBinaryState::setSet ( )

Sets the answer as a set answer.

Sets the state value of the answer to 1

public

See Also
$state

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

{
$this->state = 1;
}
ASS_AnswerBinaryState::setState (   $state = 0)

Sets the state.

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

Parameters
boolean$stateA integer value indicating the state of the answer public
See Also
$state

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

References $state.

{
$this->state = $state;
}
ASS_AnswerBinaryState::setUnchecked ( )

Sets the answer as a unchecked answer.

Sets the state value of the answer to 0

public

See Also
$state

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

{
$this->state = 0;
}
ASS_AnswerBinaryState::setUnset ( )

Sets the answer as a unset answer.

Sets the state value of the answer to 0

public

See Also
$state

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

{
$this->state = 0;
}

Field Documentation


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