mirror of
https://github.com/moodle/moodle.git
synced 2025-08-07 01:46:45 +02:00
b8ff92b66b
1/ initial support for migration of old grade_items and categories (not tested) 2/ rewritten grade update and calculation logic 3/ initial support for calculation formulas 4/ minor API refactoring and cleanup 5/ various small bugfixes 6/ fixed use of grademax with scales 7/ fixed some unit tests TODO: * implement proper locking of grades - needs discussion * force recalculation of all formulas after adding/removing/changing of grade items * better delete flag support * support for NULLs n backup - Eloy already proposed a solution * support for NULLs in set_field() * speedup * more unit tests nd functional tests
381 lines
14 KiB
PHP
381 lines
14 KiB
PHP
<?php // $Id$
|
|
|
|
///////////////////////////////////////////////////////////////////////////
|
|
// //
|
|
// NOTICE OF COPYRIGHT //
|
|
// //
|
|
// Moodle - Modular Object-Oriented Dynamic Learning Environment //
|
|
// http://moodle.com //
|
|
// //
|
|
// Copyright (C) 2001-2003 Martin Dougiamas http://dougiamas.com //
|
|
// //
|
|
// This program is free software; you can redistribute it and/or modify //
|
|
// it under the terms of the GNU General Public License as published by //
|
|
// the Free Software Foundation; either version 2 of the License, or //
|
|
// (at your option) any later version. //
|
|
// //
|
|
// This program is distributed in the hope that it will be useful, //
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of //
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
|
|
// GNU General Public License for more details: //
|
|
// //
|
|
// http://www.gnu.org/copyleft/gpl.html //
|
|
// //
|
|
///////////////////////////////////////////////////////////////////////////
|
|
|
|
require_once('grade_object.php');
|
|
|
|
class grade_grades_raw extends grade_object {
|
|
|
|
/**
|
|
* The DB table.
|
|
* @var string $table
|
|
*/
|
|
var $table = 'grade_grades_raw';
|
|
|
|
/**
|
|
* Array of class variables that are not part of the DB table fields
|
|
* @var array $nonfields
|
|
*/
|
|
var $nonfields = array('table', 'nonfields', 'scale', 'grade_grades_text', 'grade_item', 'feedback', 'feedbackformat', 'information', 'informationformat');
|
|
|
|
/**
|
|
* The id of the grade_item this raw grade belongs to.
|
|
* @var int $itemid
|
|
*/
|
|
var $itemid;
|
|
|
|
/**
|
|
* The grade_item object referenced by $this->itemid.
|
|
* @var object $grade_item
|
|
*/
|
|
var $grade_item;
|
|
|
|
/**
|
|
* The id of the user this raw grade belongs to.
|
|
* @var int $userid
|
|
*/
|
|
var $userid;
|
|
|
|
/**
|
|
* The grade value of this raw grade, if such was provided by the module.
|
|
* @var float $gradevalue
|
|
*/
|
|
var $gradevalue;
|
|
|
|
/**
|
|
* The maximum allowable grade when this grade was created.
|
|
* @var float $grademax
|
|
*/
|
|
var $grademax;
|
|
|
|
/**
|
|
* The minimum allowable grade when this grade was created.
|
|
* @var float $grademin
|
|
*/
|
|
var $grademin;
|
|
|
|
/**
|
|
* id of the scale, if this grade is based on a scale.
|
|
* @var int $scaleid
|
|
*/
|
|
var $scaleid;
|
|
|
|
/**
|
|
* A grade_scale object (referenced by $this->scaleid).
|
|
* @var object $scale
|
|
*/
|
|
var $scale;
|
|
|
|
/**
|
|
* The userid of the person who last modified this grade.
|
|
* @var int $usermodified
|
|
*/
|
|
var $usermodified;
|
|
|
|
/**
|
|
* Additional textual information about this grade. It can be automatically generated
|
|
* from the module or entered manually by the teacher. This is kept in its own table
|
|
* for efficiency reasons, so it is encapsulated in its own object, and included in this raw grade object.
|
|
* @var object $grade_grades_text
|
|
*/
|
|
var $grade_grades_text;
|
|
|
|
/**
|
|
* Constructor. Extends the basic functionality defined in grade_object.
|
|
* @param array $params Can also be a standard object.
|
|
* @param boolean $fetch Wether or not to fetch the corresponding row from the DB.
|
|
*/
|
|
function grade_grades_raw($params=NULL, $fetch=true) {
|
|
$this->grade_object($params, $fetch);
|
|
}
|
|
|
|
/**
|
|
* Instantiates a grade_scale object whose data is retrieved from the DB,
|
|
* if this raw grade's scaleid variable is set.
|
|
* @return object grade_scale
|
|
*/
|
|
function load_scale() {
|
|
if (!empty($this->scaleid)) {
|
|
$this->scale = grade_scale::fetch('id', $this->scaleid);
|
|
$this->scale->load_items();
|
|
}
|
|
return $this->scale;
|
|
}
|
|
|
|
/**
|
|
* Loads the grade_grades_text object linked to this grade (through the intersection of itemid and userid), and
|
|
* saves it as a class variable for this final object.
|
|
* If not already set initializes $this->feedback, $this->feedbackformat, $this->inforamtion, $this->informationformat.
|
|
* @return object
|
|
*/
|
|
function load_text() {
|
|
if (empty($this->grade_grades_text)) {
|
|
if ($this->grade_grades_text = grade_grades_text::fetch('itemid', $this->itemid, 'userid', $this->userid)) {
|
|
// set defaul $this properties if not already there
|
|
if (!array_key_exists('feedback', $this)) {
|
|
$this->feedback = $this->grade_grades_text->feedback;
|
|
}
|
|
if (!array_key_exists('feedbackformat', $this)) {
|
|
$this->feedbackformat = $this->grade_grades_text->feedbackformat;
|
|
}
|
|
if (!array_key_exists('information', $this)) {
|
|
$this->information = $this->grade_grades_text->information;
|
|
}
|
|
if (!array_key_exists('informationformat', $this)) {
|
|
$this->informationformat = $this->grade_grades_text->informationformat;
|
|
}
|
|
|
|
} else {
|
|
// set defaul $this properties if not already there
|
|
if (!array_key_exists('feedback', $this)) {
|
|
$this->feedback = null;
|
|
}
|
|
if (!array_key_exists('feedbackformat', $this)) {
|
|
$this->feedbackformat = FORMAT_MOODLE;
|
|
}
|
|
if (!array_key_exists('information', $this)) {
|
|
$this->information = null;
|
|
}
|
|
if (!array_key_exists('informationformat', $this)) {
|
|
$this->informationformat = FORMAT_MOODLE;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $this->grade_grades_text;
|
|
}
|
|
|
|
/**
|
|
* Loads the grade_item object referenced by $this->itemid and saves it as $this->grade_item for easy access.
|
|
* @return object grade_item.
|
|
*/
|
|
function load_grade_item() {
|
|
if (empty($this->grade_item) && !empty($this->itemid)) {
|
|
$this->grade_item = grade_item::fetch('id', $this->itemid);
|
|
}
|
|
return $this->grade_item;
|
|
}
|
|
|
|
/**
|
|
* Finds and returns a grade_grades_raw object based on 1-3 field values.
|
|
* @static
|
|
* @param string $field1
|
|
* @param string $value1
|
|
* @param string $field2
|
|
* @param string $value2
|
|
* @param string $field3
|
|
* @param string $value3
|
|
* @param string $fields
|
|
* @return object grade_category object or false if none found.
|
|
*/
|
|
function fetch($field1, $value1, $field2='', $value2='', $field3='', $value3='', $fields="*") {
|
|
if ($object = get_record('grade_grades_raw', $field1, $value1, $field2, $value2, $field3, $value3, $fields)) {
|
|
if (isset($this) && get_class($this) == 'grade_grades_raw') {
|
|
foreach ($object as $param => $value) {
|
|
$this->$param = $value;
|
|
}
|
|
|
|
return $this;
|
|
} else {
|
|
$object = new grade_grades_raw($object);
|
|
return $object;
|
|
}
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Updates this grade with the given textual information. This will create a new grade_grades_text entry
|
|
* if none was previously in DB for this raw grade, or will update the existing one.
|
|
* @param string $information Manual information from the teacher. Could be a code like 'mi'
|
|
* @param int $informationformat Text format for the information
|
|
* @return boolean Success or Failure
|
|
*/
|
|
function update_information($information, $informationformat) {
|
|
$this->load_text();
|
|
|
|
if (empty($this->grade_grades_text)) {
|
|
$this->grade_grades_text = new grade_grades_text();
|
|
|
|
$this->grade_grades_text->itemid = $this->itemid;
|
|
$this->grade_grades_text->userid = $this->userid;
|
|
$this->grade_grades_text->information = $this->information = $information;
|
|
$this->grade_grades_text->informationformat = $this->informationformat = $informationformat;
|
|
|
|
return $this->grade_grades_text->insert();
|
|
|
|
} else {
|
|
if ($this->grade_grades_text->information != $information
|
|
or $this->grade_grades_text->informationformat != $informationformat) {
|
|
|
|
$this->grade_grades_text->information = $this->information = $information;
|
|
$this->grade_grades_text->informationformat = $this->informationformat = $informationformat;
|
|
return $this->grade_grades_text->update();
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Updates this grade with the given textual information. This will create a new grade_grades_text entry
|
|
* if none was previously in DB for this raw grade, or will update the existing one.
|
|
* @param string $feedback Manual feedback from the teacher. Could be a code like 'mi'
|
|
* @param int $feedbackformat Text format for the feedback
|
|
* @return boolean Success or Failure
|
|
*/
|
|
function update_feedback($feedback, $feedbackformat) {
|
|
$this->load_text();
|
|
|
|
if (empty($this->grade_grades_text)) {
|
|
$this->grade_grades_text = new grade_grades_text();
|
|
|
|
$this->grade_grades_text->itemid = $this->itemid;
|
|
$this->grade_grades_text->userid = $this->userid;
|
|
$this->grade_grades_text->feedback = $this->feedback = $feedback;
|
|
$this->grade_grades_text->feedbackformat = $this->feedbackformat = $feedbackformat;
|
|
|
|
return $this->grade_grades_text->insert();
|
|
|
|
} else {
|
|
if ($this->grade_grades_text->feedback != $feedback
|
|
or $this->grade_grades_text->feedbackformat != $feedbackformat) {
|
|
|
|
$this->grade_grades_text->feedback = $this->feedback = $feedback;
|
|
$this->grade_grades_text->feedbackformat = $this->feedbackformat = $feedbackformat;
|
|
return $this->grade_grades_text->update();
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* In addition to the normal updating set up in grade_object, this object also records
|
|
* its pre-update value and its new value in the grade_history table. The grade_item
|
|
* object is also flagged for update.
|
|
*
|
|
* @param float $newgrade The new gradevalue of this object, false if no change
|
|
* @param string $howmodified What caused the modification? manual/module/import/cron...
|
|
* @param string $note A note attached to this modification.
|
|
* @return boolean Success or Failure.
|
|
*/
|
|
function update($newgrade, $howmodified='manual', $note=NULL) {
|
|
global $USER;
|
|
|
|
if (!empty($this->scale->id)) {
|
|
$this->scaleid = $this->scale->id;
|
|
$this->grademin = 0;
|
|
$this->scale->load_items();
|
|
$this->grademax = count($this->scale->scale_items) - 1;
|
|
}
|
|
|
|
$trackhistory = false;
|
|
|
|
if ($newgrade != $this->gradevalue) {
|
|
$trackhistory = true;
|
|
$oldgrade = $this->gradevalue;
|
|
$this->gradevalue = $newgrade;
|
|
}
|
|
|
|
$result = parent::update();
|
|
|
|
// Update grade_grades_text if specified
|
|
if ($result) {
|
|
// we do this to prevent some db queries in load_text()
|
|
if (array_key_exists('feedback', $this) or array_key_exists('feedbackformat', $this)
|
|
or array_key_exists('information', $this) or array_key_exists('informationformat', $this)) {
|
|
$this->load_text();
|
|
$result = $this->update_feedback($this->feedback, $this->feedbackformat);
|
|
$result = $result && $this->update_information($this->information, $this->informationformat);
|
|
}
|
|
}
|
|
|
|
if ($result && $trackhistory) {
|
|
// TODO Handle history recording error, such as displaying a notice, but still return true
|
|
grade_history::insert_change($this, $oldgrade, $howmodified, $note);
|
|
|
|
// Notify parent grade_item of need to update
|
|
$this->load_grade_item();
|
|
$result = $this->grade_item->flag_for_update();
|
|
}
|
|
|
|
if ($result) {
|
|
return true;
|
|
} else {
|
|
debugging("Could not update a raw grade in the database.");
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* In addition to perform parent::insert(), this infers the grademax from the scale if such is given, and
|
|
* sets grademin to 0 if scale is given.
|
|
* @return int ID of the new grades_grade_raw record.
|
|
*/
|
|
function insert() {
|
|
// Retrieve scale and infer grademax from it
|
|
if (!empty($this->scaleid)) {
|
|
$this->load_scale();
|
|
$this->scale->load_items();
|
|
$this->grademax = count ($this->scale->scale_items) - 1;
|
|
$this->grademin = 0;
|
|
}
|
|
|
|
$result = parent::insert();
|
|
|
|
// Notify parent grade_item of need to update
|
|
$this->load_grade_item();
|
|
$result = $result && $this->grade_item->flag_for_update();
|
|
|
|
// Update grade_grades_text if specified
|
|
if ($result) {
|
|
// we do this to prevent some db queries in load_text()
|
|
if (array_key_exists('feedback', $this) or array_key_exists('feedbackformat', $this)
|
|
or array_key_exists('information', $this) or array_key_exists('informationformat', $this)) {
|
|
$this->load_text();
|
|
$result = $this->update_feedback($this->feedback, $this->feedbackformat);
|
|
$result = $result && $this->update_information($this->information, $this->informationformat);
|
|
}
|
|
}
|
|
|
|
return $result && $this->grade_item->flag_for_update();
|
|
}
|
|
|
|
/**
|
|
* If parent::delete() is successful, send flag_for_update message to parent grade_item.
|
|
* @return boolean Success or failure.
|
|
*/
|
|
function delete() {
|
|
$result = parent::delete();
|
|
if ($result) {
|
|
$this->load_grade_item();
|
|
return $this->grade_item->flag_for_update();
|
|
}
|
|
return $result;
|
|
}
|
|
}
|
|
|
|
?>
|