Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
core_customfield_generator Class Reference

Customfield data generator class. More...

Inheritance diagram for core_customfield_generator:
component_generator_base

Public Member Functions

 add_instance_data (field_controller $field, int $instanceid, $value)
 Adds instance data for one field.
 
 create_category ($record=null)
 Create a new category.
 
 create_field ($record)
 Create a new field.
 
 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

int $categorycount = 0
 Number of created categories.
 
testing_data_generator $datagenerator
 
int $fieldcount = 0
 Number of created fields.
 

Detailed Description

Customfield data generator class.

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

Member Function Documentation

◆ add_instance_data()

core_customfield_generator::add_instance_data ( field_controller $field,
int $instanceid,
$value )

Adds instance data for one field.

Parameters
field_controller$field
int$instanceid
mixed$value
Return values
core_customfield\data_controller

◆ create_category()

core_customfield_generator::create_category ( $record = null)

Create a new category.

Parameters
array | stdClass$record
Return values
category_controller

◆ create_field()

core_customfield_generator::create_field ( $record)

Create a new field.

Parameters
array | stdClass$record
Return values
field_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: