Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/lib/testing/generator/ -> component_generator_base.php (source)

[Source view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403]

Component generator base class.

Copyright: 2013 The Open University
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 180 lines (6 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

component_generator_base:: (4 methods):
  __construct()
  reset()
  set_user()
  insert_files()


Class: component_generator_base  - X-Ref

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.

__construct(testing_data_generator $datagenerator)   X-Ref
Constructor.

param: testing_data_generator $datagenerator

reset()   X-Ref
To be called from data reset code only,
do not use in tests.

return: void

set_user(?stdClass $user = null)   X-Ref
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.

param: stdClass $user

insert_files(stdClass $instance,stdClass $record,string $table,context $context,string $component,string $filearea,int $targetitemid)   X-Ref
Update the instance record, inserting any files that are referenced.

param: stdClass $instance The instance record of the already-created record
param: stdClass $record The data passed in to create the instance
param: string $table The table that the data exists in
param: context $context The context of the instance
param: string $component The component of the owning plugin
param: string $filearea The name of the file area
param: int $targetitemid The itemid to use when saving the files
return: stdClass The updated instance record