Local repository data generator class.
More...
|
| create_instance ($record=null, array $options=null) |
| Create a test repository instance.
|
|
| create_type ($record=null, array $options=null) |
| Create the type of repository.
|
|
| get_typename () |
| Returns repository type 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.
|
|
| prepare_record (array $record) |
| Fill in record defaults.
|
|
| prepare_type_record (array $record) |
| Fill in type record defaults.
|
|
| set_user (?stdClass $user=null) |
| Set the current user during data generation.
|
|
|
testing_data_generator | $datagenerator |
|
int | $instancecount = 0 |
| Number of instances created.
|
|
Local repository data generator class.
- Copyright
- 2013 Frédéric Massart
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- Copyright
- 2013 Frédéric Massart
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ create_instance()
testing_repository_generator::create_instance |
( |
| $record = null, |
|
|
array | $options = null ) |
|
inherited |
Create a test repository instance.
- Parameters
-
array | stdClass | $record | |
array | $options | |
- Return values
-
stdClass | repository instance record |
◆ create_type()
testing_repository_generator::create_type |
( |
| $record = null, |
|
|
array | $options = null ) |
|
inherited |
Create the type of repository.
- Parameters
-
stdClass | array | $record | data to use to set up the type |
array | $options | options for the set up of the type |
- Return values
-
stdClass | repository type record |
◆ get_typename()
testing_repository_generator::get_typename |
( |
| ) |
|
|
inherited |
Returns repository type name.
- Return values
-
string | name of the type of repository |
- 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 |
◆ prepare_record()
testing_repository_generator::prepare_record |
( |
array | $record | ) |
|
|
protectedinherited |
◆ prepare_type_record()
testing_repository_generator::prepare_type_record |
( |
array | $record | ) |
|
|
protectedinherited |
◆ reset()
testing_repository_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:
- repository/local/tests/generator/lib.php