Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gradingform_rubric_generator Class Reference
Inheritance diagram for gradingform_rubric_generator:
component_generator_base

Public Member Functions

 create_instance (context $context, string $component, string $area, string $name, string $description, array $criteria)
 Create an instance of a rubric. More...
 
 get_level_and_criterion_for_values (gradingform_controller $controller, string $description, float $score)
 Given a controller instance, fetch the level and criterion information for the specified values. More...
 
 get_submitted_form_data (gradingform_rubric_controller $controller, int $itemid, array $values)
 Get submitted form data for the supplied controller, itemid, and values. More...
 
 get_test_form_data (gradingform_rubric_controller $controller, int $itemid, float $spellingscore, string $spellingremark, float $picturescore, string $pictureremark)
 Fetch a set of sample data. More...
 
 get_test_rubric (context $context, string $component, string $area)
 Generate a rubric controller with sample data required for testing of this class. More...
 
 reset ()
 To be called from data reset code only, do not use in tests. More...
 

Protected Member Functions

 get_criterion (string $description, array $levels=[])
 Get a new rubric for use with a gradingform_rubric_generator_rubric. More...
 
 get_rubric (string $name, string $description)
 Get a new rubric for use with the rubric controller. More...
 
 set_user (?stdClass $user=null)
 Set the current user during data generation. More...
 

Protected Attributes

testing_data_generator $datagenerator
 

Member Function Documentation

◆ create_instance()

gradingform_rubric_generator::create_instance ( context  $context,
string  $component,
string  $area,
string  $name,
string  $description,
array  $criteria 
)

Create an instance of a rubric.

Parameters
context$context
string$component
string$area
string$name
string$description
array$criteriaThe list of criteria to add to the generated rubric
Return values
gradingform_rubric_controller

◆ get_criterion()

gradingform_rubric_generator::get_criterion ( string  $description,
array  $levels = [] 
)
protected

Get a new rubric for use with a gradingform_rubric_generator_rubric.

Note: This is just a helper class used to build a new definition. It does not persist the data.

Parameters
string$description
array$levelsSet of levels in the form definition => score
Return values
gradingform_rubric_generator_criterion

◆ get_level_and_criterion_for_values()

gradingform_rubric_generator::get_level_and_criterion_for_values ( gradingform_controller  $controller,
string  $description,
float  $score 
)

Given a controller instance, fetch the level and criterion information for the specified values.

Parameters
gradingform_controller$controller
string$descriptionThe description to match the criterion on
float$scoreThe value to match the level on
Return values
array

◆ get_rubric()

gradingform_rubric_generator::get_rubric ( string  $name,
string  $description 
)
protected

Get a new rubric for use with the rubric controller.

Note: This is just a helper class used to build a new definition. It does not persist the data.

Parameters
string$name
string$description
Return values
rubric

◆ get_submitted_form_data()

gradingform_rubric_generator::get_submitted_form_data ( gradingform_rubric_controller  $controller,
int  $itemid,
array  $values 
)

Get submitted form data for the supplied controller, itemid, and values.

The returned data is in the format used by rubric when handling form submission.

Parameters
gradingform_rubric_controller$controller
int$itemid
array$valuesA set of array values where the array key is the name of the criterion, and the value is an array with the desired score, and any remark.

◆ get_test_form_data()

gradingform_rubric_generator::get_test_form_data ( gradingform_rubric_controller  $controller,
int  $itemid,
float  $spellingscore,
string  $spellingremark,
float  $picturescore,
string  $pictureremark 
)

Fetch a set of sample data.

Parameters
gradingform_rubric_controller$controller
int$itemid
float$spellingscore
string$spellingremark
float$picturescore
string$pictureremark
Return values
array

◆ get_test_rubric()

gradingform_rubric_generator::get_test_rubric ( context  $context,
string  $component,
string  $area 
)

Generate a rubric controller with sample data required for testing of this class.

Parameters
context$context
string$component
string$area
Return values
gradingform_rubric_controller

◆ reset()

component_generator_base::reset ( )
inherited

◆ set_user()

component_generator_base::set_user ( ?stdClass  $user = null)
protectedinherited

Set the current user during data generation.

This should be avoided wherever possible, but in some situations underlying code will insert data as the current user.

Parameters
stdClass$user

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