Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
component_generator_base Class Reference

Component generator base class. More...

Inheritance diagram for component_generator_base:
core_adminpresets_generator core_badges_generator core_blog_generator core_comment_generator core_competency_generator core_completion_generator core_contentbank_generator core_customfield_generator core_grading_generator core_h5p_generator core_notes_generator core_payment_generator core_question_generator core_reportbuilder_generator core_search_generator core_webservice_generator enrol_lti_generator gradingform_guide_generator gradingform_rubric_generator quizaccess_seb_generator testing_block_generator testing_module_generator testing_repository_generator tool_dataprivacy_generator tool_mfa_generator

Public Member Functions

 __construct (testing_data_generator $datagenerator)
 Constructor.
 
 reset ()
 To be called from data reset code only, do not use in tests.
 

Protected Member Functions

 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

Component generator base class.

Extend in path/to/component/tests/generator/lib.php as class type_plugin_generator extends component_generator_base Note that there are more specific classes to extend for mods and blocks.

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

Constructor & Destructor Documentation

◆ __construct()

component_generator_base::__construct ( testing_data_generator $datagenerator)

Constructor.

Parameters
testing_data_generator$datagenerator

Member Function Documentation

◆ insert_files()

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

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)
protected

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: