mirror of
https://github.com/moodle/moodle.git
synced 2025-08-07 01:46:45 +02:00
61c33818d5
MDL-10233 fixed grade_*::fetch() - does not modify $this anymore, we can now use it from normal methods to fetch other objects of the same class.
326 lines
11 KiB
PHP
326 lines
11 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 extends grade_object {
|
|
|
|
/**
|
|
* The DB table.
|
|
* @var string $table
|
|
*/
|
|
var $table = 'grade_grades';
|
|
|
|
/**
|
|
* Array of class variables that are not part of the DB table fields
|
|
* @var array $nonfields
|
|
*/
|
|
var $nonfields = array('table', 'nonfields', 'grade_grades_text', 'grade_item');
|
|
|
|
/**
|
|
* The id of the grade_item this 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 grade belongs to.
|
|
* @var int $userid
|
|
*/
|
|
var $userid;
|
|
|
|
/**
|
|
* The grade value of this raw grade, if such was provided by the module.
|
|
* @var float $rawgrade
|
|
*/
|
|
var $rawgrade;
|
|
|
|
/**
|
|
* The maximum allowable grade when this grade was created.
|
|
* @var float $rawgrademax
|
|
*/
|
|
var $rawgrademax;
|
|
|
|
/**
|
|
* The minimum allowable grade when this grade was created.
|
|
* @var float $rawgrademin
|
|
*/
|
|
var $rawgrademin;
|
|
|
|
/**
|
|
* id of the scale, if this grade is based on a scale.
|
|
* @var int $rawscaleid
|
|
*/
|
|
var $rawscaleid;
|
|
|
|
/**
|
|
* 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 grade object.
|
|
* @var object $grade_grades_text
|
|
*/
|
|
var $grade_grades_text;
|
|
|
|
/**
|
|
* The final value of this grade.
|
|
* @var float $finalgrade
|
|
*/
|
|
var $finalgrade;
|
|
|
|
/**
|
|
* 0 if visible, 1 always hidden or date not visible until
|
|
* @var float $hidden
|
|
*/
|
|
var $hidden;
|
|
|
|
/**
|
|
* 0 not locked, date when the item was locked
|
|
* @var float locked
|
|
*/
|
|
var $locked;
|
|
|
|
/**
|
|
* 0 no automatic locking, date when to lock the grade automatically
|
|
* @var float $locktime
|
|
*/
|
|
var $locktime;
|
|
|
|
/**
|
|
* Exported flag
|
|
* @var boolean $exported
|
|
*/
|
|
var $exported;
|
|
|
|
/**
|
|
* 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($params=NULL, $fetch=true) {
|
|
$this->grade_object($params, $fetch);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
* @return object
|
|
*/
|
|
function load_text() {
|
|
if (empty($this->grade_grades_text->id)) {
|
|
$this->grade_grades_text = grade_grades_text::fetch('itemid', $this->itemid, 'userid', $this->userid);
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Check grade lock status. Uses both grade item lock and grade lock.
|
|
* Internally any date in locked field (including future ones) means locked,
|
|
* the date is stored for logging purposes only.
|
|
*
|
|
* @return boolean true if locked, false if not
|
|
*/
|
|
function is_locked() {
|
|
$this->load_grade_item();
|
|
|
|
return $this->grade_item->is_locked() or !empty($this->locked);
|
|
}
|
|
|
|
/**
|
|
* Lock/unlopck this grade.
|
|
*
|
|
* @param boolean $lockstate true means lock, false unlock grade
|
|
* @return boolean true if sucessful, false if can not set new lock state for grade
|
|
*/
|
|
function set_locked($lockedstate) {
|
|
$this->load_grade_item();
|
|
|
|
if ($lockedstate) {
|
|
if (!empty($this->locked)) {
|
|
return true; // already locked
|
|
}
|
|
|
|
if ($this->grade_item->needsupdate) {
|
|
//can not lock grade if final not calculated!
|
|
return false;
|
|
}
|
|
|
|
$this->locked = time();
|
|
$this->update();
|
|
|
|
return true;
|
|
|
|
} else {
|
|
if (empty($this->locked)) {
|
|
return true; // not locked
|
|
}
|
|
|
|
if ($this->grade_item->is_locked()) {
|
|
return false;
|
|
}
|
|
|
|
// remove the locked flag
|
|
$this->locked = 0;
|
|
|
|
$this->update();
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Finds and returns a grade_grades 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', $field1, $value1, $field2, $value2, $field3, $value3, $fields)) {
|
|
$object = new grade_grades($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->id)) {
|
|
$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->id)) {
|
|
$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;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Given a float value situated between a source minimum and a source maximum, converts it to the
|
|
* corresponding value situated between a target minimum and a target maximum. Thanks to Darlene
|
|
* for the formula :-)
|
|
*
|
|
* @static
|
|
* @param float $rawgrade
|
|
* @param float $source_min
|
|
* @param float $source_max
|
|
* @param float $target_min
|
|
* @param float $target_max
|
|
* @return float Converted value
|
|
*/
|
|
function standardise_score($rawgrade, $source_min, $source_max, $target_min, $target_max) {
|
|
$factor = ($rawgrade - $source_min) / ($source_max - $source_min);
|
|
$diff = $target_max - $target_min;
|
|
$standardised_value = $factor * $diff + $target_min;
|
|
return $standardised_value;
|
|
}
|
|
}
|
|
|
|
?>
|