Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
Grade item storage for mod_forum. More...
Public Member Functions | |
check_grade_validity (?float $grade) | |
Check whether the supplied grade is valid and throw an exception if not. | |
create_empty_grade (stdClass $gradeduser, stdClass $grader) | |
Create an empty forum_grade for the specified user and grader. | |
get_advanced_grading_instance (stdClass $grader, stdClass $grade, int $instanceid=null) | |
Get the advanced grading instance for the specified grade entry. | |
get_advanced_grading_method () | |
Get the name of the advanced grading method. | |
get_all_grades () | |
Get grades for all users for the specified gradeitem. | |
get_formatted_grade_for_user (stdClass $gradeduser, stdClass $grader) | |
Returns the grade that should be displayed to the user. | |
get_grade (int $gradeid) | |
Get the grade record for the specified grade id. | |
get_grade_for_user (stdClass $gradeduser, stdClass $grader=null) | |
Get the grade for the specified user. | |
get_grade_instance_id () | |
Get the grade item instance id. | |
get_grade_item () | |
Get the core grade item from the current component grade item. | |
get_grade_itemid () | |
Get the itemid for the current gradeitem. | |
get_grade_menu () | |
Get the list of available grade items. | |
get_grading_component_name () | |
Get the name of the component responsible for grading this gradeitem. | |
get_grading_component_subtype () | |
Get the name of the component subtype responsible for grading this gradeitem. | |
is_grading_enabled () | |
Whether grading is enabled for this item. | |
is_using_advanced_grading () | |
Whether this grade item is configured to use advanced grading. | |
is_using_direct_grading () | |
Whether this grade item is configured to use direct grading. | |
is_using_scale () | |
Check whether a scale is being used for this grade item. | |
require_user_can_grade (stdClass $gradeduser, stdClass $grader) | |
Require that the user can grade, throwing an exception if not. | |
send_student_notification (stdClass $gradeduser, stdClass $grader) | |
Sends a notification about the item being graded for the student. | |
should_grade_only_active_users () | |
Defines whether only active users in the course should be gradeable. | |
store_grade_from_formdata (stdClass $gradeduser, stdClass $grader, stdClass $formdata) | |
Create or update the grade. | |
user_can_grade (stdClass $gradeduser, stdClass $grader) | |
Whether the grader can grade the gradee. | |
user_has_grade (stdClass $gradeduser) | |
Get the grade status for the specified user. | |
Static Public Member Functions | |
static | instance (string $component, context $context, string $itemname) |
Fetch an instance of a specific component_gradeitem. | |
static | load_from_context (context $context) |
Return an instance based on the context in which it is used. | |
static | load_from_forum_entity (forum_entity $forum) |
Return an instance using the forum_entity instance. | |
Protected Member Functions | |
allow_decimals () | |
Whether decimals are allowed. | |
get_advanced_grading_controller () | |
Get the advanced grading controller if advanced grading is enabled. | |
get_gradeitem_value () | |
Get the grade value for this instance. | |
get_grading_manager () | |
Get the grading manager for this advanced grading definition. | |
get_scale () | |
Get the scale if a scale is being used. | |
get_table_name () | |
The table name used for grading. | |
store_grade (stdClass $grade) | |
Create or update the grade. | |
Grade item storage for mod_forum.
|
protectedinherited |
Whether decimals are allowed.
bool |
|
inherited |
Check whether the supplied grade is valid and throw an exception if not.
float | $grade | The value being checked |
moodle_exception |
bool |
mod_forum\grades\forum_gradeitem::create_empty_grade | ( | stdClass | $gradeduser, |
stdClass | $grader ) |
Create an empty forum_grade for the specified user and grader.
stdClass | $gradeduser | The user being graded |
stdClass | $grader | The user who is grading |
stdClass | The newly created grade record |
dml_exception |
Reimplemented from core_grades\component_gradeitem.
|
protectedinherited |
Get the advanced grading controller if advanced grading is enabled.
gradingform_controller |
|
inherited |
Get the advanced grading instance for the specified grade entry.
stdClass | $grader | The user who is grading |
stdClass | $grade | The row from the grade table. |
int | $instanceid | The instanceid of the advanced grading form |
gradingform_instance |
|
inherited |
Get the name of the advanced grading method.
string |
mod_forum\grades\forum_gradeitem::get_all_grades | ( | ) |
Get grades for all users for the specified gradeitem.
stdClass[] | The grades |
dml_exception |
Reimplemented from core_grades\component_gradeitem.
|
inherited |
Returns the grade that should be displayed to the user.
The grade does not necessarily return a float value, this method takes grade settings into considering so the correct value be shown, eg. a float vs a letter.
stdClass | $gradeduser | |
stdClass | $grader |
stdClass|null |
|
inherited |
Get the grade record for the specified grade id.
int | $gradeid |
stdClass |
dml_exception |
mod_forum\grades\forum_gradeitem::get_grade_for_user | ( | stdClass | $gradeduser, |
stdClass | $grader = null ) |
Get the grade for the specified user.
stdClass | $gradeduser | The user being graded |
stdClass | $grader | The user who is grading |
stdClass | The grade value |
dml_exception |
Reimplemented from core_grades\component_gradeitem.
mod_forum\grades\forum_gradeitem::get_grade_instance_id | ( | ) |
Get the grade item instance id.
This is typically the cmid in the case of an activity, and relates to the iteminstance field in the grade_items table.
int |
Reimplemented from core_grades\component_gradeitem.
|
inherited |
Get the core grade item from the current component grade item.
This is mainly used to access the max grade for a gradeitem
grade_item | The grade item |
|
inherited |
Get the itemid for the current gradeitem.
int |
|
inherited |
Get the list of available grade items.
array |
|
protected |
Get the grade value for this instance.
The itemname is translated to the relevant grade field on the forum entity.
int |
Reimplemented from core_grades\component_gradeitem.
|
inherited |
Get the name of the component responsible for grading this gradeitem.
string |
|
inherited |
Get the name of the component subtype responsible for grading this gradeitem.
string |
|
protectedinherited |
Get the grading manager for this advanced grading definition.
grading_manager |
|
protectedinherited |
Get the scale if a scale is being used.
stdClass |
|
protected |
The table name used for grading.
string |
Reimplemented from core_grades\component_gradeitem.
|
staticinherited |
Fetch an instance of a specific component_gradeitem.
string | $component | |
context | $context | |
string | $itemname |
self |
mod_forum\grades\forum_gradeitem::is_grading_enabled | ( | ) |
Whether grading is enabled for this item.
bool |
Reimplemented from core_grades\component_gradeitem.
|
inherited |
Whether this grade item is configured to use advanced grading.
bool |
|
inherited |
Whether this grade item is configured to use direct grading.
bool |
|
inherited |
Check whether a scale is being used for this grade item.
bool |
|
static |
Return an instance based on the context in which it is used.
context | $context |
Reimplemented from core_grades\component_gradeitem.
|
static |
Return an instance using the forum_entity instance.
forum_entity | $forum |
forum_gradeitem |
mod_forum\grades\forum_gradeitem::require_user_can_grade | ( | stdClass | $gradeduser, |
stdClass | $grader ) |
Require that the user can grade, throwing an exception if not.
stdClass | $gradeduser | The user being graded |
stdClass | $grader | The user who is grading |
required_capability_exception |
Reimplemented from core_grades\component_gradeitem.
|
inherited |
Sends a notification about the item being graded for the student.
stdClass | $gradeduser | The user being graded |
stdClass | $grader | The user who is grading |
mod_forum\grades\forum_gradeitem::should_grade_only_active_users | ( | ) |
Defines whether only active users in the course should be gradeable.
bool | Whether only active users in the course should be gradeable. |
|
protected |
Create or update the grade.
stdClass | $grade |
bool | Success |
dml_exception | |
moodle_exception | |
coding_exception |
Reimplemented from core_grades\component_gradeitem.
|
inherited |
Create or update the grade.
stdClass | $gradeduser | The user being graded |
stdClass | $grader | The user who is grading |
stdClass | $formdata | The data submitted |
bool | Success |
mod_forum\grades\forum_gradeitem::user_can_grade | ( | stdClass | $gradeduser, |
stdClass | $grader ) |
Whether the grader can grade the gradee.
stdClass | $gradeduser | The user being graded |
stdClass | $grader | The user who is grading |
bool |
Reimplemented from core_grades\component_gradeitem.
mod_forum\grades\forum_gradeitem::user_has_grade | ( | stdClass | $gradeduser | ) |
Get the grade status for the specified user.
Check if a grade obj exists & $grade->grade !== null. If the user has a grade return true.
stdClass | $gradeduser | The user being graded |
bool | The grade exists |
dml_exception |
Reimplemented from core_grades\component_gradeitem.