Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
testing_block_generator Class Reference

Block generator base class. More...

Inheritance diagram for testing_block_generator:

Public Member Functions

 create_instance ($record=null, $options=array())
 Create a test block instance.
 
 get_blockname ()
 Returns block name.
 
 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.
 
 prepare_record (stdClass $record)
 Fill in record defaults.
 
 preprocess_record (stdClass $record, array $options)
 Can be overridden to do block-specific processing.
 
 set_user (?stdClass $user=null)
 Set the current user during data generation.
 

Protected Attributes

testing_data_generator $datagenerator
 
int $instancecount = 0
 number of created instances
 

Detailed Description

Block generator base class.

Extend in blocks/xxxx/tests/generator/lib.php as class block_xxxx_generator.

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

Member Function Documentation

◆ create_instance()

testing_block_generator::create_instance ( $record = null,
$options = array() )

Create a test block instance.

The $record passed in becomes the basis for the new row added to the block_instances table. You only need to supply the values of interest. Any missing values have sensible defaults filled in.

The $options array provides additional data, not directly related to what will be inserted in the block_instance table, which may affect the block that is created. The meanings of any data passed here depends on the particular type of block being created.

Parameters
array | stdClass$recordforms the basis for the entry to be inserted in the block_instances table.
array$optionsfurther, block-specific options to control how the block is created.
Return values
stdClassthe block_instance record that has just been created.

◆ get_blockname()

testing_block_generator::get_blockname ( )

Returns block name.

Return values
stringname of block that this class describes
Exceptions
coding_exceptionif class invalid

Reimplemented in default_block_generator.

◆ 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

◆ prepare_record()

testing_block_generator::prepare_record ( stdClass $record)
protected

Fill in record defaults.

Parameters
stdClass$record
Return values
stdClass

◆ preprocess_record()

testing_block_generator::preprocess_record ( stdClass $record,
array $options )
protected

Can be overridden to do block-specific processing.

$record can be modified in-place.

Parameters
stdClass$recordthe data, before defaults are filled in.
array$optionsfurther, block-specific options, as passed to create_instance().

◆ reset()

testing_block_generator::reset ( )

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

Return values
void

Reimplemented from component_generator_base.

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