Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
repository_upload_generator Class Reference

Upload repository data generator class. More...

Inheritance diagram for repository_upload_generator:
testing_repository_generator component_generator_base

Public Member Functions

 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.
 

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 (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.
 

Protected Attributes

testing_data_generator $datagenerator
 
int $instancecount = 0
 Number of instances created.
 

Detailed Description

Upload repository data generator class.

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

Member Function Documentation

◆ 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
stdClassrepository instance record

◆ create_type()

testing_repository_generator::create_type ( $record = null,
array $options = null )
inherited

Create the type of repository.

Parameters
stdClass | array$recorddata to use to set up the type
array$optionsoptions for the set up of the type
Return values
stdClassrepository type record

◆ get_typename()

testing_repository_generator::get_typename ( )
inherited

Returns repository type name.

Return values
stringname of the type of repository
Exceptions
coding_exceptionif class invalid

◆ 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_repository_generator::prepare_record ( array $record)
protectedinherited

Fill in record defaults.

Parameters
array$record
Return values
array

Reimplemented in repository_equella_generator, repository_filesystem_generator, repository_flickr_public_generator, and repository_webdav_generator.

◆ prepare_type_record()

testing_repository_generator::prepare_type_record ( array $record)
protectedinherited

◆ reset()

testing_repository_generator::reset ( )
inherited

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: