|
| static | fetch_helper ($table, $classname, $params) |
| | Factory method which uses the parameters to retrieve matching instances from the database. More...
|
| |
◆ add_feedback_files()
| grade_object::add_feedback_files |
( |
int |
$historyid = null | ) |
|
|
protectedinherited |
Handles adding feedback files in the gradebook.
- Parameters
-
Reimplemented in grade_grade.
◆ can_control_visibility()
| grade_object::can_control_visibility |
( |
| ) |
|
|
inherited |
Returns whether the grade object can control the visibility of the grades.
- Return values
-
Reimplemented in grade_item.
◆ can_delete()
| grade_outcome::can_delete |
( |
| ) |
|
Checks if outcome can be deleted.
- Return values
-
◆ delete()
| grade_outcome::delete |
( |
|
$source = null | ) |
|
Deletes this outcome from the database.
- Parameters
-
| string | $source | from where was the object deleted (mod/forum, manual, etc.) |
- Return values
-
Reimplemented from grade_object.
◆ delete_feedback_files()
| grade_object::delete_feedback_files |
( |
| ) |
|
|
protectedinherited |
Handles deleting feedback files in the gradebook.
Reimplemented in grade_grade.
◆ fetch()
| static grade_outcome::fetch |
( |
|
$params | ) |
|
|
static |
Finds and returns a grade_outcome instance based on params.
- Parameters
-
| array | $params | associative arrays varname=>value |
- Return values
-
Reimplemented from grade_object.
◆ fetch_all()
| static grade_outcome::fetch_all |
( |
|
$params | ) |
|
|
static |
Finds and returns all grade_outcome instances based on params.
- Parameters
-
| array | $params | associative arrays varname=>value |
- Return values
-
Reimplemented from grade_object.
◆ fetch_all_available()
| static grade_outcome::fetch_all_available |
( |
|
$courseid | ) |
|
|
static |
Static method that returns all outcomes available in course.
- Parameters
-
- Return values
-
◆ fetch_all_global()
| static grade_outcome::fetch_all_global |
( |
| ) |
|
|
static |
Static function returning all global outcomes.
- Return values
-
◆ fetch_all_helper()
| static grade_object::fetch_all_helper |
( |
|
$table, |
|
|
|
$classname, |
|
|
|
$params |
|
) |
| |
|
staticinherited |
Factory method which uses the parameters to retrieve all matching instances from the database.
- Parameters
-
| string | $table | The table to retrieve from |
| string | $classname | The name of the class to instantiate |
| array | $params | An array of conditions like $fieldname => $fieldvalue |
- Return values
-
| array|bool | Array of object instances or false if not found |
◆ fetch_all_local()
| static grade_outcome::fetch_all_local |
( |
|
$courseid | ) |
|
|
static |
Static function returning all local course outcomes.
- Parameters
-
- Return values
-
◆ fetch_helper()
| static grade_object::fetch_helper |
( |
|
$table, |
|
|
|
$classname, |
|
|
|
$params |
|
) |
| |
|
staticprotectedinherited |
Factory method which uses the parameters to retrieve matching instances from the database.
- Parameters
-
| string | $table | The table to retrieve from |
| string | $classname | The name of the class to instantiate |
| array | $params | An array of conditions like $fieldname => $fieldvalue |
- Return values
-
| mixed | An object instance or false if not found |
◆ get_course_uses_count()
| grade_outcome::get_course_uses_count |
( |
| ) |
|
Returns the number of places where outcome is used.
- Return values
-
◆ get_description()
| grade_outcome::get_description |
( |
| ) |
|
Returns the formatted grade description with URLs converted.
- Return values
-
◆ get_grade_info()
| grade_outcome::get_grade_info |
( |
|
$courseid = null, |
|
|
|
$average = true, |
|
|
|
$items = false |
|
) |
| |
Computes then returns extra information about this outcome and other objects that are linked to it.
The average of all grades that use this outcome, for all courses (or 1 course if courseid is given) can be requested, and is returned as a float if requested alone. If the list of items that use this outcome is also requested, then a single array is returned, which contains the grade_items AND the average grade if such is still requested (array('items' => array(...), 'avg' => 2.30)). This combining of two methods into one is to save on DB queries, since both queries are similar and can be performed together.
- Parameters
-
| int | $courseid | An optional courseid to narrow down the average to 1 course only |
| bool | $average | Whether or not to return the average grade for this outcome |
| bool | $items | Whether or not to return the list of items using this outcome |
- Return values
-
◆ get_hidden()
| grade_object::get_hidden |
( |
| ) |
|
|
inherited |
Check a grade item hidden status.
- Return values
-
| int | 0 means visible, 1 hidden always, a timestamp means "hidden until" |
Reimplemented in grade_grade.
◆ get_item_uses_count()
| grade_outcome::get_item_uses_count |
( |
| ) |
|
Returns the number of grade items that use this grade outcome.
- Return values
-
◆ get_name()
| grade_outcome::get_name |
( |
| ) |
|
Returns the most descriptive field for this object.
This is a standard method used when we do not know the exact type of an object.
- Return values
-
◆ get_record_data()
| grade_object::get_record_data |
( |
| ) |
|
|
inherited |
Returns object with fields and values that are defined in database.
- Return values
-
◆ get_shortname()
| grade_outcome::get_shortname |
( |
| ) |
|
Returns unique outcome short name.
- Return values
-
◆ insert()
| grade_outcome::insert |
( |
|
$source = null | ) |
|
Records this object in the Database, sets its id to the returned value, and returns that value.
If successful this function also fetches the new object data from database and stores it in object properties.
- Parameters
-
| string | $source | from where was the object inserted (mod/forum, manual, etc.) |
- Return values
-
| int | PK ID if successful, false otherwise |
Reimplemented from grade_object.
◆ is_hidden()
| grade_object::is_hidden |
( |
| ) |
|
|
inherited |
Returns the current hidden state of this grade_item.
This depends on the grade object hidden setting and the current time if hidden is set to a "hidden until" timestamp
- Return values
-
Reimplemented in grade_grade.
◆ is_hiddenuntil()
| grade_object::is_hiddenuntil |
( |
| ) |
|
|
inherited |
Check grade object hidden status.
- Return values
-
| bool | True if a "hidden until" timestamp is set, false if grade object is set to always visible or always hidden. |
Reimplemented in grade_grade.
◆ load_optional_fields()
| grade_object::load_optional_fields |
( |
| ) |
|
|
inherited |
Makes sure all the optional fields are loaded.
If id present, meaning the instance exists in the database, then data will be fetched from the database. Defaults are used for new instances.
◆ load_scale()
| grade_outcome::load_scale |
( |
| ) |
|
Instantiates a grade_scale object whose data is retrieved from the database.
- Return values
-
◆ notify_changed()
| grade_object::notify_changed |
( |
|
$deleted | ) |
|
|
protectedinherited |
Called immediately after the object data has been inserted, updated, or deleted in the database.
Default does nothing, can be overridden to hook in special behaviour.
- Parameters
-
Reimplemented in grade_category, grade_grade, and grade_item.
◆ set_hidden()
| grade_object::set_hidden |
( |
|
$hidden, |
|
|
|
$cascade = false |
|
) |
| |
|
inherited |
Set a grade object hidden status.
- Parameters
-
| int | $hidden | 0 means visiable, 1 means hidden always, a timestamp means "hidden until" |
| bool | $cascade | Ignored |
Reimplemented in grade_category, grade_grade, and grade_item.
◆ set_properties()
| static grade_object::set_properties |
( |
& |
$instance, |
|
|
|
$params |
|
) |
| |
|
staticinherited |
Given an associated array or object, cycles through each key/variable and assigns the value to the corresponding variable in this object.
- Parameters
-
| stdClass | $instance | The object to set the properties on |
| array | $params | An array of properties to set like $propertyname => $propertyvalue |
- Return values
-
| array|stdClass | Either an associative array or an object containing property name, property value pairs |
Reimplemented in grade_category.
◆ update()
| grade_outcome::update |
( |
|
$source = null | ) |
|
In addition to update() it also updates grade_outcomes_courses if needed.
- Parameters
-
| string | $source | from where was the object inserted |
- Return values
-
Reimplemented from grade_object.
◆ update_feedback_files()
| grade_object::update_feedback_files |
( |
int |
$historyid = null | ) |
|
|
protectedinherited |
Handles updating feedback files in the gradebook.
- Parameters
-
Reimplemented in grade_grade.
◆ update_from_db()
| grade_object::update_from_db |
( |
| ) |
|
|
inherited |
Using this object's id field, fetches the matching record in the DB, and looks at each variable in turn.
If the DB has different data, the db's data is used to update the object. This is different from the update() function, which acts on the DB record based on the object.
- Return values
-
◆ use_in()
| grade_outcome::use_in |
( |
|
$courseid | ) |
|
Mark outcome as used in a course.
- Parameters
-
- Return values
-
| False | if invalid courseid requested |
◆ $courseid
| int grade_outcome::$courseid |
The course this outcome belongs to.
$courseid
◆ $description
| string grade_outcome::$description |
The description of this outcome - FORMAT_MOODLE.
$description
◆ $fullname
| string grade_outcome::$fullname |
The fullname of the outcome.
$fullname
◆ $id
◆ $optional_fields
| array grade_object::$optional_fields = array() |
|
inherited |
Array of optional fields with default values - usually long text information that is not always needed.
If you want to create an instance without optional fields use: new grade_object($only_required_fields, false); $optional_fields
◆ $required_fields
| array grade_outcome::$required_fields |
Initial value:= array('id', 'courseid', 'shortname', 'fullname', 'scaleid','description',
'descriptionformat', 'timecreated', 'timemodified', 'usermodified')
Array of required table fields, must start with 'id'.
$required_fields
◆ $scale
| object grade_outcome::$scale |
A full grade_scale object referenced by $this->scaleid.
$scale
◆ $scaleid
| int grade_outcome::$scaleid |
The id of the scale referenced by this outcome.
$scaleid
◆ $shortname
| string grade_outcome::$shortname |
The shortname of the outcome.
$shortname
◆ $table
| string grade_outcome::$table = 'grade_outcomes' |
◆ $timecreated
| int grade_object::$timecreated |
|
inherited |
◆ $timemodified
| int grade_object::$timemodified |
|
inherited |
◆ $usermodified
| int grade_outcome::$usermodified |
The userid of the person who last modified this outcome.
$usermodified
The documentation for this class was generated from the following file:
1.9.3