ASS_MarkSchema Class Reference

A class defining mark schemas for assessment test objects. More...

Collaboration diagram for ASS_MarkSchema:

Public Member Functions
	__construct ()
	ASS_MarkSchema constructor. More...
	createSimpleSchema ( $txt_failed_short="failed", $txt_failed_official="failed", $percentage_failed=0, $failed_passed=0, $txt_passed_short="passed", $txt_passed_official="passed", $percentage_passed=50, $passed_passed=1)
	Creates a simple mark schema for two mark steps: failed and passed. More...
	addMarkStep ( $txt_short="", $txt_official="", $percentage=0, $passed=0)
	Adds a mark step to the mark schema. More...
	saveToDb ($test_id)
	Saves an ASS_MarkSchema object to a database. More...
	loadFromDb ($test_id)
	Loads an ASS_MarkSchema object from a database. More...
	flush ()
	Empties the mark schema and removes all mark steps. More...
	sort ()
	Sorts the mark schema using the minimum level values. More...
	deleteMarkStep ($index=0)
	Deletes the mark step with a given index. More...
	deleteMarkSteps ($indexes)
	Deletes multiple mark steps using their index positions. More...
	getMatchingMark ($percentage)
	Returns the matching mark for a given percentage. More...
	_getMatchingMark ($test_id, $percentage)
	Returns the matching mark for a given percentage. More...
	_getMatchingMarkFromObjId ($a_obj_id, $percentage)
	Returns the matching mark for a given percentage. More...
	checkMarks ()
	Check the marks for consistency. More...
	getMarkSteps ()
	setMarkSteps ($mark_steps)

Data Fields
	$mark_steps

Detailed Description

A class defining mark schemas 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

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 16 of file class.assMarkSchema.php.

Constructor & Destructor Documentation

__construct()

ASS_MarkSchema::__construct

(

)

ASS_MarkSchema constructor.

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

Returns

ASS_MarkSchema

Definition at line 28 of file class.assMarkSchema.php.

        {
                $this->mark_steps = array();
        }

Member Function Documentation

_getMatchingMark()

ASS_MarkSchema::_getMatchingMark	(		$test_id,
			$percentage
	)

Returns the matching mark for a given percentage.

See also

$mark_steps

Parameters

integer	$test_id	The database id of the test.
double	$percentage	A percentage value between 0 and 100.

Returns

mixed The mark object, if a matching mark was found, false otherwise.

@noinspection PhpAssignmentInConditionInspection

Definition at line 326 of file class.assMarkSchema.php.

        {
                global $ilDB;
                $result = $ilDB->queryF("SELECT * FROM tst_mark WHERE test_fi = %s ORDER BY minimum_level DESC",
                        array('integer'),
                        array($test_id)
                );
 
                while ($row = $ilDB->fetchAssoc($result))
                {
                        if ($percentage >= $row["minimum_level"])
                        {
                                return $row;
                        }
                }
                return FALSE;
        }

References $ilDB, $result, and $row.

_getMatchingMarkFromObjId()

ASS_MarkSchema::_getMatchingMarkFromObjId	(		$a_obj_id,
			$percentage
	)

Returns the matching mark for a given percentage.

See also

$mark_steps

Parameters

integer	$a_obj_id	The database id of the test.
double	$percentage	A percentage value between 0 and 100.

Returns

mixed The mark object, if a matching mark was found, false otherwise.

Definition at line 355 of file class.assMarkSchema.php.

        {
                global $ilDB;
                $result = $ilDB->queryF("SELECT tst_mark.* FROM tst_mark, tst_tests WHERE tst_mark.test_fi = tst_tests.test_id AND tst_tests.obj_fi = %s ORDER BY minimum_level DESC",
                        array('integer'),
                        array($a_obj_id)
                );
                while ($row = $ilDB->fetchAssoc($result))
                {
                        if ($percentage >= $row["minimum_level"])
                        {
                                return $row;
                        }
                }
                return FALSE;
        }

References $ilDB, $result, and $row.

Referenced by ilObjTestAccess\_isPassed(), and ilObjTestAccess\isFailed().

Here is the caller graph for this function:

addMarkStep()

ASS_MarkSchema::addMarkStep	(		$txt_short = "",
			$txt_official = "",
			$percentage = 0,
			$passed = 0
	)

Adds a mark step to the mark schema.

A new ASS_Mark object will be created and stored in the $mark_steps array.

See also

$mark_steps

Parameters

string	$txt_short	The short text of the mark.
string	$txt_official	The official text of the mark.
float | integer	$percentage	The minimum percentage level reaching the mark.
integer	$passed	The passed status of the mark (0 = failed, 1 = passed).

Definition at line 75 of file class.assMarkSchema.php.

        {
                require_once './Modules/Test/classes/class.assMark.php';
                $mark = new ASS_Mark($txt_short, $txt_official, $percentage, $passed);
                array_push($this->mark_steps, $mark);
        }

Referenced by createSimpleSchema(), and loadFromDb().

Here is the caller graph for this function:

checkMarks()

ASS_MarkSchema::checkMarks

(

)

Check the marks for consistency.

See also

$mark_steps

Returns

bool|string true if the check succeeds, als a text string containing a language string for an error message

Definition at line 409 of file class.assMarkSchema.php.

        {
                $minimum_percentage = 100;
                $passed = 0;
                for ($i = 0; $i < count($this->mark_steps); $i++) 
                {
                        if ($this->mark_steps[$i]->getMinimumLevel() < $minimum_percentage)
                        {
                                $minimum_percentage = $this->mark_steps[$i]->getMinimumLevel();
                        }
                        if ($this->mark_steps[$i]->getPassed())
                        {
                                $passed++;
                        }
                }
                
                if ($minimum_percentage != 0)
                {
                        return "min_percentage_ne_0";
                }
                
                if ($passed == 0)
                {
                        return "no_passed_mark";
                }
                return true;
        }

createSimpleSchema()

ASS_MarkSchema::createSimpleSchema	(		$txt_failed_short = "failed",
			$txt_failed_official = "failed",
			$percentage_failed = 0,
			$failed_passed = 0,
			$txt_passed_short = "passed",
			$txt_passed_official = "passed",
			$percentage_passed = 50,
			$passed_passed = 1
	)

Creates a simple mark schema for two mark steps: failed and passed.

See also

$mark_steps

Parameters

string	$txt_failed_short	The short text of the failed mark.
string	$txt_failed_official	The official text of the failed mark.
float | int	$percentage_failed	The minimum percentage level reaching the failed mark.
integer	$failed_passed	Indicates the passed status of the failed mark (0 = failed, 1 = passed).
string	$txt_passed_short	The short text of the passed mark.
string	$txt_passed_official	The official text of the passed mark.
float | int	$percentage_passed	The minimum percentage level reaching the passed mark.
integer	$passed_passed	Indicates the passed status of the passed mark (0 = failed, 1 = passed).

Definition at line 48 of file class.assMarkSchema.php.

  {
    $this->flush();
    $this->addMarkStep($txt_failed_short, $txt_failed_official, $percentage_failed, $failed_passed);
    $this->addMarkStep($txt_passed_short, $txt_passed_official, $percentage_passed, $passed_passed);
  }

References addMarkStep(), and flush().

Here is the call graph for this function:

deleteMarkStep()

ASS_MarkSchema::deleteMarkStep

(

$index = 0

)

Deletes the mark step with a given index.

See also

$mark_steps

Parameters

integer

$index

The index of the mark step to delete.

Definition at line 265 of file class.assMarkSchema.php.

        {
                if ($index < 0) return;
                if (count($this->mark_steps) < 1) return;
                if ($index >= count($this->mark_steps)) return;
                unset($this->mark_steps[$index]);
                $this->mark_steps = array_values($this->mark_steps);
        }

deleteMarkSteps()

ASS_MarkSchema::deleteMarkSteps

(

$indexes

)

Deletes multiple mark steps using their index positions.

See also

$mark_steps

Parameters

array

$indexes

An array with all the index positions to delete.

Definition at line 281 of file class.assMarkSchema.php.

        {
                foreach ($indexes as $key => $index) 
                {
                        if (!(($index < 0) or (count($this->mark_steps) < 1))) 
                        {
                                unset($this->mark_steps[$index]);
                        }
                }
                $this->mark_steps = array_values($this->mark_steps);
        }

flush()

ASS_MarkSchema::flush

(

)

Empties the mark schema and removes all mark steps.

See also

$mark_steps

Definition at line 227 of file class.assMarkSchema.php.

        {
                $this->mark_steps = array();
        }

Referenced by createSimpleSchema().

Here is the caller graph for this function:

getMarkSteps()

ASS_MarkSchema::getMarkSteps

(

)

Returns

ASS_Mark[]

Definition at line 440 of file class.assMarkSchema.php.

        {
                return $this->mark_steps;
        }

References $mark_steps.

getMatchingMark()

ASS_MarkSchema::getMatchingMark

(

$percentage

)

Returns the matching mark for a given percentage.

See also

$mark_steps

Parameters

double

$percentage

A percentage value between 0 and 100.

Returns

ASS_Mark|bool The mark object, if a matching mark was found, false otherwise.

Definition at line 302 of file class.assMarkSchema.php.

        {
                for ($i = count($this->mark_steps) - 1; $i >= 0; $i--) 
                {
                        $curMinLevel = $this->mark_steps[$i]->getMinimumLevel();
 
                        if( $percentage > $curMinLevel || (string)$percentage == (string)$curMinLevel )
                        { // >= does NOT work since PHP is a fucking female float pig !!!!
                                return $this->mark_steps[$i];
                        }
                }
                return false;
        }

loadFromDb()

ASS_MarkSchema::loadFromDb

(

$test_id

)

Loads an ASS_MarkSchema object from a database.

Parameters

integer

$test_id

A unique key which defines the test in the database.

@noinspection PhpAssignmentInConditionInspection

Definition at line 203 of file class.assMarkSchema.php.

        {
                global $ilDB;
                
                if (!$test_id) return;
                $result = $ilDB->queryF("SELECT * FROM tst_mark WHERE test_fi = %s ORDER BY minimum_level",
                        array('integer'),
                        array($test_id)
                );
                if ($result->numRows() > 0)
                {
                        while ($data = $ilDB->fetchAssoc($result)) 
                        {
                                $this->addMarkStep($data["short_name"], $data["official_name"], $data["minimum_level"], $data["passed"]);
                        }
                }
        }

References $data, $ilDB, $result, and addMarkStep().

Here is the call graph for this function:

saveToDb()

ASS_MarkSchema::saveToDb

(

$test_id

)

Saves an ASS_MarkSchema object to a database.

Parameters

integer

$test_id

The database id of the related test.

@noinspection PhpAssignmentInConditionInspection

@noinspection PhpAssignmentInConditionInspection

Definition at line 87 of file class.assMarkSchema.php.

        {
                global $lng;
                global $ilDB;
 
                $oldmarks = array();
                include_once "./Modules/Test/classes/class.ilObjAssessmentFolder.php";
                if (ilObjAssessmentFolder::_enabledAssessmentLogging())
                {
                        $result = $ilDB->queryF("SELECT * FROM tst_mark WHERE test_fi = %s ORDER BY minimum_level",
                                array('integer'),
                                array($test_id)
                        );
                        if ($result->numRows())
                        {
                                while ($row = $ilDB->fetchAssoc($result))
                                {
                                        $oldmarks[$row["minimum_level"]] = $row;
                                }
                        }
                }
                
                if (!$test_id) return;
                // Delete all entries
                $ilDB->manipulateF("DELETE FROM tst_mark WHERE test_fi = %s",
                        array('integer'),
                        array($test_id)
                );
                if (count($this->mark_steps) == 0) return;
    
                // Write new datasets
                foreach ($this->mark_steps as $key => $value) 
                {
                        $next_id = $ilDB->nextId('tst_mark');
                        $ilDB->manipulateF("INSERT INTO tst_mark (mark_id, test_fi, short_name, official_name, minimum_level, passed, tstamp) VALUES (%s, %s, %s, %s, %s, %s, %s)",
                                array('integer','integer','text','text','float','text','integer'),
                                array(
                                        $next_id,
                                        $test_id,
                                        $value->getShortName(), 
                                        $value->getOfficialName(), 
                                        $value->getMinimumLevel(),
                                        $value->getPassed(),
                                        time()
                                )
                        );
                }
                if (ilObjAssessmentFolder::_enabledAssessmentLogging())
                {
                        $result = $ilDB->queryF("SELECT * FROM tst_mark WHERE test_fi = %s ORDER BY minimum_level",
                                array('integer'),
                                array($test_id)
                        );
                        $newmarks = array();
                        if ($result->numRows())
                        {
                                while ($row = $ilDB->fetchAssoc($result))
                                {
                                        $newmarks[$row["minimum_level"]] = $row;
                                }
                        }
                        foreach ($oldmarks as $level => $row)
                        {
                                if (array_key_exists($level, $newmarks))
                                {
                                        $difffields = array();
                                        foreach ($row as $key => $value)
                                        {
                                                if (strcmp($value, $newmarks[$level][$key]) != 0)
                                                {
                                                        switch ($key)
                                                        {
                                                                case "mark_id":
                                                                case "tstamp":
                                                                        break;
                                                                default:
                                                                        array_push($difffields, "$key: $value => " .$newmarks[$level][$key]); 
                                                                        break;
                                                        }
                                                }
                                        }
                                        if (count($difffields))
                                        {
                                                $this->logAction($test_id, $lng->txtlng("assessment", "log_mark_changed", ilObjAssessmentFolder::_getLogLanguage()) . ": " . join($difffields, ", "));
                                        }
                                }
                                else
                                {
                                        $this->logAction($test_id, $lng->txtlng("assessment", "log_mark_removed", ilObjAssessmentFolder::_getLogLanguage()) . ": " . 
                                                $lng->txtlng("assessment", "tst_mark_minimum_level", ilObjAssessmentFolder::_getLogLanguage()) . " = " . $row["minimum_level"] . ", " .
                                                $lng->txtlng("assessment", "tst_mark_short_form", ilObjAssessmentFolder::_getLogLanguage()) . " = " . $row["short_name"] . ", " .
                                                $lng->txtlng("assessment", "tst_mark_official_form", ilObjAssessmentFolder::_getLogLanguage()) . " = " . $row["official_name"] . ", " .
                                                $lng->txtlng("assessment", "tst_mark_passed", ilObjAssessmentFolder::_getLogLanguage()) . " = " . $row["passed"]);                                              
                                }
                        }
                        foreach ($newmarks as $level => $row)
                        {
                                if (!array_key_exists($level, $oldmarks))
                                {
                                        $this->logAction($test_id, $lng->txtlng("assessment", "log_mark_added", ilObjAssessmentFolder::_getLogLanguage()) . ": " . 
                                                $lng->txtlng("assessment", "tst_mark_minimum_level", ilObjAssessmentFolder::_getLogLanguage()) . " = " . $row["minimum_level"] . ", " .
                                                $lng->txtlng("assessment", "tst_mark_short_form", ilObjAssessmentFolder::_getLogLanguage()) . " = " . $row["short_name"] . ", " .
                                                $lng->txtlng("assessment", "tst_mark_official_form", ilObjAssessmentFolder::_getLogLanguage()) . " = " . $row["official_name"] . ", " .
                                                $lng->txtlng("assessment", "tst_mark_passed", ilObjAssessmentFolder::_getLogLanguage()) . " = " . $row["passed"]);
                                }
                        }
                }
        }

References $ilDB, $lng, $result, $row, ilObjAssessmentFolder\_enabledAssessmentLogging(), and ilObjAssessmentFolder\_getLogLanguage().

Here is the call graph for this function:

setMarkSteps()

ASS_MarkSchema::setMarkSteps

(

$mark_steps

)

Parameters

ASS_Mark[]

$mark_steps

Definition at line 448 of file class.assMarkSchema.php.

        {
                $this->mark_steps = $mark_steps;
        }

References $mark_steps.

sort()

ASS_MarkSchema::sort

(

)

Sorts the mark schema using the minimum level values.

See also

$mark_steps

Definition at line 237 of file class.assMarkSchema.php.

        {
                function level_sort($a, $b) 
                {
                        if ($a->getMinimumLevel() == $b->getMinimumLevel()) 
                        {
                                $res = strcmp($a->getShortName(), $b->getShortName());
                                if ($res == 0) 
                                {
                                        return strcmp($a->getOfficialName(), $b->getOfficialName());
                                }
                                else 
                                {
                                        return $res;
                                }
                        }
                        return ($a->getMinimumLevel() < $b->getMinimumLevel()) ? -1 : 1;
                }
                usort($this->mark_steps, 'level_sort');
        }

References $res.

Field Documentation

$mark_steps

ASS_MarkSchema::$mark_steps

Definition at line 19 of file class.assMarkSchema.php.

Referenced by getMarkSteps(), and setMarkSteps().

---

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

• Modules/Test/classes/class.assMarkSchema.php