core_contentbank_generator Class Reference

Generator for the core_contentbank subsystem. More...

Inheritance diagram for core_contentbank_generator:

Public Member Functions
	generate_contentbank_data (?string $contenttype, int $itemstocreate=1, int $userid=0, ?\context $context=null, bool $convert2class=true, string $filepath='contentfile.h5p', string $contentname='Test content ', int $visibility=content::VISIBILITY_PUBLIC)
	Populate contentbank database tables with relevant data to simulate the process of adding items to the content bank.
	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.
	set_user (?stdClass $user=null)
	Set the current user during data generation.

Protected Attributes
testing_data_generator	$datagenerator

Detailed Description

Generator for the core_contentbank subsystem.

Copyright

2020 Sara Arjona sara@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

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

Member Function Documentation

generate_contentbank_data()

core_contentbank_generator::generate_contentbank_data	(	?string	$contenttype,
		int	$itemstocreate = 1,
		int	$userid = 0,
		?\context	$context = null,
		bool	$convert2class = true,
		string	$filepath = 'contentfile.h5p',
		string	$contentname = 'Test content ',
		int	$visibility = content::VISIBILITY_PUBLIC )

Populate contentbank database tables with relevant data to simulate the process of adding items to the content bank.

Parameters

string	$contenttype	Content bank plugin type to add. If none is defined, contenttype_testable is used.
int	$itemstocreate	Number of items to add to the content bank.
int	$userid	The user identifier creating the content.
context	$context	The context where the content will be created.
bool	$convert2class	Whether the class should return stdClass or plugin instance.
string	$filepath	The filepath of the file associated to the content to create.
string	$contentname	The name of the content that will be created.
int	$visibility	The visibility of the content that will be created.

Return values

array

An array with all the records added to the content bank.

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

reset()

component_generator_base::reset ( )

inherited

To be called from data reset code only, do not use in tests.

Return values

void

Reimplemented in core_competency_generator, core_notes_generator, core_question_generator, mod_book_generator, mod_chat_generator, mod_data_generator, mod_forum_generator, mod_glossary_generator, mod_lesson_generator, mod_survey_generator, mod_wiki_generator, testing_block_generator, testing_module_generator, testing_repository_generator, and tool_dataprivacy_generator.

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:

• repository/contentbank/tests/generator/lib.php