Resource module data generator class.
More...
|
| create_content ($instance, $record=array()) |
| Generates a piece of content for the module.
|
|
| create_instance ($record=null, array $options=null) |
| Creates new resource module instance.
|
|
| get_modulename () |
| Returns module name.
|
|
| reset () |
| To be called from data reset code only, do not use in tests.
|
|
|
| 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.
|
|
| post_add_instance ($id, $cmid) |
| Called after *_add_instance()
|
|
| precreate_course_module ($courseid, array $options) |
| Create course module and link it to course.
|
|
| prepare_moduleinfo_record ($record, $options) |
| Merges together arguments $record and $options and fills default module fields that are shared by all module types.
|
|
| set_user (?stdClass $user=null) |
| Set the current user during data generation.
|
|
|
testing_data_generator | $datagenerator |
|
int | $instancecount = 0 |
| number of created instances
|
|
Resource module data generator class.
- Copyright
- 2013 The Open University
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ create_content()
testing_module_generator::create_content |
( |
| $instance, |
|
|
| $record = array() ) |
|
inherited |
◆ create_instance()
mod_resource_generator::create_instance |
( |
| $record = null, |
|
|
array | $options = null ) |
Creates new resource module instance.
By default it contains a short text file.
- Parameters
-
array | stdClass | $record | data for module being generated. Requires 'course' key (an id or the full object). Also can have any fields from add module form, and a 'defaultfilename' to set the name of the file created if no draft ID is supplied. |
null | array | $options | general options for course module. Since 2.6 it is possible to omit this argument by merging options into $record |
- Return values
-
stdClass | record from module-defined table with additional field cmid (corresponding id in course_modules table) |
Reimplemented from testing_module_generator.
◆ get_modulename()
testing_module_generator::get_modulename |
( |
| ) |
|
|
inherited |
Returns module name.
- Return values
-
string | name of module that this class describes |
- Exceptions
-
◆ 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 | $instance | The instance record of the already-created record |
stdClass | $record | The data passed in to create the instance |
string | $table | The table that the data exists in |
context | $context | The context of the instance |
string | $component | The component of the owning plugin |
string | $filearea | The name of the file area |
int | $targetitemid | The itemid to use when saving the files |
- Return values
-
stdClass | The updated instance record |
◆ post_add_instance()
testing_module_generator::post_add_instance |
( |
| $id, |
|
|
| $cmid ) |
|
protectedinherited |
◆ precreate_course_module()
testing_module_generator::precreate_course_module |
( |
| $courseid, |
|
|
array | $options ) |
|
protectedinherited |
◆ prepare_moduleinfo_record()
testing_module_generator::prepare_moduleinfo_record |
( |
| $record, |
|
|
| $options ) |
|
protectedinherited |
Merges together arguments $record and $options and fills default module fields that are shared by all module types.
- Parameters
-
object | array | $record | fields (different from defaults) for this module |
null | array | $options | for backward-compatibility this may include fields from course_modules table. They are merged into $record |
- Exceptions
-
◆ reset()
testing_module_generator::reset |
( |
| ) |
|
|
inherited |
◆ 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
-
The documentation for this class was generated from the following file:
- mod/resource/tests/generator/lib.php