Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
gradingform_guide_generator Class Reference

Generator for the gradingforum_guide plugintype. More...

Inheritance diagram for gradingform_guide_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 marking guide.
 
 get_criterion_for_values (gradingform_controller $controller, string $shortname)
 Given a controller instance, fetch the level and criterion information for the specified values.
 
 get_submitted_form_data (gradingform_guide_controller $controller, int $itemid, array $values)
 Get submitted form data.
 
 get_test_form_data (gradingform_guide_controller $controller, int $itemid, float $spellingscore, string $spellingremark, float $picturescore, string $pictureremark)
 Fetch a set of sample data.
 
 get_test_guide (context_module $context, string $component='mod_assign', string $areaname='submission')
 Generate a guide controller with sample data required for testing of this class.
 
 reset ()
 To be called from data reset code only, do not use in tests.
 

Protected Member Functions

 get_criterion (string $shortname, string $description, string $descriptionmarkers, float $maxscore)
 Get a new criterion for use with a guide.
 
 get_guide (string $name, string $description)
 Get a new guide for use with the guide controller.
 
 insert_files (stdClass $instance, stdClass $record, string $table, context $context, string $component, string $filearea, int $targetitemid)
 Update the instance record, inserting any files that are referenced.
 
 set_user (?stdClass $user=null)
 Set the current user during data generation.
 

Protected Attributes

testing_data_generator $datagenerator
 

Detailed Description

Generator for the gradingforum_guide plugintype.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ create_instance()

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

Create an instance of a marking guide.

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

◆ get_criterion()

gradingform_guide_generator::get_criterion ( string $shortname,
string $description,
string $descriptionmarkers,
float $maxscore )
protected

Get a new criterion for use with a guide.

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

Parameters
string$shortnameThe shortname for the criterion
string$descriptionThe description for the criterion
string$descriptionmarkersThe description for the marker for this criterion
float$maxscoreThe maximum score possible for this criterion
Return values
criterion

◆ get_criterion_for_values()

gradingform_guide_generator::get_criterion_for_values ( gradingform_controller $controller,
string $shortname )

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

Parameters
gradingform_controller$controller
string$shortnameThe shortname to match the criterion on
Return values
stdClass

◆ get_guide()

gradingform_guide_generator::get_guide ( string $name,
string $description )
protected

Get a new guide for use with the guide 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
generator_guide

◆ get_submitted_form_data()

gradingform_guide_generator::get_submitted_form_data ( gradingform_guide_controller $controller,
int $itemid,
array $values )

Get submitted form data.

Parameters
gradingform_guide_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_guide_generator::get_test_form_data ( gradingform_guide_controller $controller,
int $itemid,
float $spellingscore,
string $spellingremark,
float $picturescore,
string $pictureremark )

Fetch a set of sample data.

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

◆ get_test_guide()

gradingform_guide_generator::get_test_guide ( context_module $context,
string $component = 'mod_assign',
string $areaname = 'submission' )

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

Parameters
context_module$context
Return values
gradingform_guide_controller

◆ insert_files()

component_generator_base::insert_files ( stdClass $instance,
stdClass $record,
string $table,
context $context,
string $component,
string $filearea,
int $targetitemid )
protectedinherited

Update the instance record, inserting any files that are referenced.

Parameters
stdClass$instanceThe instance record of the already-created record
stdClass$recordThe data passed in to create the instance
string$tableThe table that the data exists in
context$contextThe context of the instance
string$componentThe component of the owning plugin
string$fileareaThe name of the file area
int$targetitemidThe itemid to use when saving the files
Return values
stdClassThe updated instance record

◆ reset()

◆ 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: