Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_reportbuilder_generator Class Reference
Inheritance diagram for core_reportbuilder_generator:
component_generator_base

Public Member Functions

 create_audience ($record)
 Create report audience.
 
 create_column ($record)
 Create report column.
 
 create_condition ($record)
 Create report condition.
 
 create_filter ($record)
 Create report filter.
 
 create_report ($record)
 Create report.
 
 create_schedule ($record)
 Create report schedule.
 
 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
 

Member Function Documentation

◆ create_audience()

core_reportbuilder_generator::create_audience ( $record)

Create report audience.

Parameters
array | stdClass$record
Return values
audience_base
Exceptions
coding_exception

◆ create_column()

core_reportbuilder_generator::create_column ( $record)

Create report column.

Parameters
array | stdClass$record
Return values
column
Exceptions
coding_exception

◆ create_condition()

core_reportbuilder_generator::create_condition ( $record)

Create report condition.

Parameters
array | stdClass$record
Return values
filter
Exceptions
coding_exception

◆ create_filter()

core_reportbuilder_generator::create_filter ( $record)

Create report filter.

Parameters
array | stdClass$record
Return values
filter
Exceptions
coding_exception

◆ create_report()

core_reportbuilder_generator::create_report ( $record)

Create report.

Parameters
array | stdClass$record
Return values
report
Exceptions
coding_exception

◆ create_schedule()

core_reportbuilder_generator::create_schedule ( $record)

Create report schedule.

Parameters
array | stdClass$record
Return values
schedule
Exceptions
coding_exception

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