Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
testing_repository_generator Class Reference
Inheritance diagram for testing_repository_generator:
component_generator_base repository_boxnet_generator repository_contentbank_generator repository_coursefiles_generator repository_dropbox_generator repository_equella_generator repository_filesystem_generator repository_flickr_generator repository_flickr_public_generator repository_googledocs_generator repository_local_generator repository_merlot_generator repository_nextcloud_generator repository_picasa_generator repository_recent_generator repository_s3_generator repository_upload_generator repository_url_generator repository_user_generator repository_webdav_generator repository_wikimedia_generator repository_youtube_generator

Public Member Functions

 create_instance ($record=null, array $options=null)
 Create a test repository instance. More...
 
 create_type ($record=null, array $options=null)
 Create the type of repository. More...
 
 get_typename ()
 Returns repository type name. More...
 
 reset ()
 To be called from data reset code only, do not use in tests. More...
 

Protected Member Functions

 prepare_record (array $record)
 Fill in record defaults. More...
 
 prepare_type_record (array $record)
 Fill in type record defaults. More...
 
 set_user (?stdClass $user=null)
 Set the current user during data generation. More...
 

Protected Attributes

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

Member Function Documentation

◆ create_instance()

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

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 
)

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

Returns repository type name.

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

◆ prepare_record()

testing_repository_generator::prepare_record ( array  $record)
protected

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)
protected

◆ reset()

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