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

A class defining marks for assessment test objects. More...

+ Collaboration diagram for ASS_Mark:

Public Member Functions

 ASS_Mark ($short_name="", $official_name="", $minimum_level=0, $passed=0)
 ASS_Mark constructor.
 getShortName ()
 Returns the short name of the mark.
 getPassed ()
 Returns passed status of the mark.
 getOfficialName ()
 Returns the official name of the mark.
 getMinimumLevel ()
 Returns the minimum level reaching the mark.
 setShortName ($short_name="")
 Sets the short name of the mark.
 setPassed ($passed=0)
 Sets the passed status the mark.
 setOfficialName ($official_name="")
 Sets the official name of the mark.
 setMinimumLevel ($minimum_level)
 Sets the minimum level reaching the mark.

Data Fields

 $short_name
 $official_name
 $minimum_level = 0
 $passed

Detailed Description

A class defining marks for assessment test objects.

A class defining marks for assessment test objects

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$

Definition at line 35 of file class.assMark.php.

Member Function Documentation

ASS_Mark::ASS_Mark (   $short_name = "",
  $official_name = "",
  $minimum_level = 0,
  $passed = 0 
)

ASS_Mark constructor.

The constructor takes possible arguments an creates an instance of the ASS_Mark object.

Parameters
string$short_nameThe short name of the mark
string$official_nameThe official name of the mark
double$minimum_levelThe minimum percentage level reaching the mark public

Definition at line 82 of file class.assMark.php.

References $minimum_level, $official_name, $passed, $short_name, setMinimumLevel(), setOfficialName(), setPassed(), and setShortName().

+ Here is the call graph for this function:

ASS_Mark::getMinimumLevel ( )

Returns the minimum level reaching the mark.

Returns the minimum level reaching the mark

Returns
double The minimum level reaching the mark public
See Also
$minimum_level

Definition at line 144 of file class.assMark.php.

References $minimum_level.

{
}
ASS_Mark::getOfficialName ( )

Returns the official name of the mark.

Returns the official name of the mark

Returns
string The official name of the mark public
See Also
$official_name

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

References $official_name.

{
}
ASS_Mark::getPassed ( )

Returns passed status of the mark.

Returns the passed status of the mark

Returns
string The passed status of the mark public
See Also
$passed

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

References $passed.

{
return $this->passed;
}
ASS_Mark::getShortName ( )

Returns the short name of the mark.

Returns the short name of the mark

Returns
string The short name of the mark public
See Also
$short_name

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

References $short_name.

{
}
ASS_Mark::setMinimumLevel (   $minimum_level)

Sets the minimum level reaching the mark.

Sets the minimum level reaching the mark

Parameters
string$minimum_levelThe minimum level reaching the mark public
See Also
$minimum_level

Definition at line 196 of file class.assMark.php.

References $minimum_level.

Referenced by ASS_Mark().

{
if (!is_numeric($minimum_level))
{
throw new Exception ('Markstep: minimum level must be numeric.');
}
else if (($minimum_level >= 0) && ($minimum_level <= 100))
{
$this->minimum_level = $minimum_level;
}
else
{
throw new Exception ('Markstep: minimum level must be between 0 and 100');
}
}

+ Here is the caller graph for this function:

ASS_Mark::setOfficialName (   $official_name = "")

Sets the official name of the mark.

Sets the official name of the mark

Parameters
string$official_nameThe official name of the mark public
See Also
$official_name

Definition at line 183 of file class.assMark.php.

References $official_name.

Referenced by ASS_Mark().

{
$this->official_name = $official_name;
}

+ Here is the caller graph for this function:

ASS_Mark::setPassed (   $passed = 0)

Sets the passed status the mark.

Sets the passed status of the mark

Parameters
integer$passedThe passed status of the mark public
See Also
$passed

Definition at line 170 of file class.assMark.php.

References $passed.

Referenced by ASS_Mark().

{
$this->passed = $passed;
}

+ Here is the caller graph for this function:

ASS_Mark::setShortName (   $short_name = "")

Sets the short name of the mark.

Sets the short name of the mark

Parameters
string$short_nameThe short name of the mark public
See Also
$short_name

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

References $short_name.

Referenced by ASS_Mark().

{
$this->short_name = $short_name;
}

+ Here is the caller graph for this function:

Field Documentation

ASS_Mark::$minimum_level = 0

Definition at line 61 of file class.assMark.php.

Referenced by ASS_Mark(), getMinimumLevel(), and setMinimumLevel().

ASS_Mark::$official_name

Definition at line 52 of file class.assMark.php.

Referenced by ASS_Mark(), getOfficialName(), and setOfficialName().

ASS_Mark::$passed

Definition at line 70 of file class.assMark.php.

Referenced by ASS_Mark(), getPassed(), and setPassed().

ASS_Mark::$short_name

Definition at line 43 of file class.assMark.php.

Referenced by ASS_Mark(), getShortName(), and setShortName().


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