gradingform_guide_generator Class Reference

Generator for the gradingforum_guide plugintype. More...

Inheritance diagram for gradingform_guide_generator:

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.

Copyright

2019 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

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	$criteria	The 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	$shortname	The shortname for the criterion
string	$description	The description for the criterion
string	$descriptionmarkers	The description for the marker for this criterion
float	$maxscore	The 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	$shortname	The 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	$values	A 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	$instance	The instance record of the already-created record
stdClass	$record	The data passed in to create the instance
string	$table	The table that the data exists in
context	$context	The context of the instance
string	$component	The component of the owning plugin
string	$filearea	The name of the file area
int	$targetitemid	The itemid to use when saving the files

Return values

stdClass

The updated instance record

reset()

component_generator_base::reset ( )

inherited

To be called from data reset code only, do not use in tests.

Return values

void

Reimplemented in core_competency_generator, core_notes_generator, core_question_generator, mod_book_generator, mod_chat_generator, mod_data_generator, mod_forum_generator, mod_glossary_generator, mod_lesson_generator, mod_survey_generator, mod_wiki_generator, testing_block_generator, testing_module_generator, testing_repository_generator, and tool_dataprivacy_generator.

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:

• grade/grading/form/guide/tests/generator/lib.php