mod_resource_generator Class Reference

Resource module data generator class. More...

Inheritance diagram for mod_resource_generator:

Public Member Functions
	create_content ($instance, $record=array())
	Generates a piece of content for the module. More...
	create_instance ($record=null, array $options=null)
	Creates new resource module instance. More...
	get_modulename ()
	Returns module name. More...
	reset ()
	To be called from data reset code only, do not use in tests. More...

Protected Member Functions
	post_add_instance ($id, $cmid)
	Called after *_add_instance() More...
	precreate_course_module ($courseid, array $options)
	Create course module and link it to course. More...
	prepare_moduleinfo_record ($record, $options)
	Merges together arguments $record and $options and fills default module fields that are shared by all module types. More...
	set_user (?stdClass $user=null)
	Set the current user during data generation. More...

Protected Attributes
testing_data_generator	$datagenerator
number	$instancecount = 0
	of created instances

Detailed Description

Resource module data generator class.

Copyright

2013 The Open University

License

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

Member Function Documentation

create_content()

testing_module_generator::create_content (   $instance,   $record = array()  )

inherited

Generates a piece of content for the module.

User is usually taken from global $USER variable.

Parameters

stdClass	$instance	object returned from create_instance() call
stdClass | array	$record

Return values

stdClass

generated object

Exceptions

coding_exception

if function is not implemented by module

Reimplemented in mod_h5pactivity_generator, mod_book_generator, mod_forum_generator, mod_lesson_generator, and mod_wiki_generator.

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

coding_exception

if class invalid

post_add_instance()

testing_module_generator::post_add_instance (   $id,   $cmid  )

protectedinherited

Called after *_add_instance()

Since 2.6 it is recommended to use function add_moduleinfo() to create a module.

Deprecated:

since 2.6

See also

testing_module_generator::create_instance()

Parameters

int	$id
int	$cmid

Return values

stdClass

module instance

precreate_course_module()

testing_module_generator::precreate_course_module (   $courseid, array  $options  )

protectedinherited

Create course module and link it to course.

Since 2.6 it is recommended to use function add_moduleinfo() to create a module.

Deprecated:

since 2.6

See also

testing_module_generator::create_instance()

Parameters

integer	$courseid
array	$options	section, visible

Return values

integer::$cm

instance id

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

coding_exception

if $record->course is not specified

reset()

testing_module_generator::reset ( )

inherited

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

Return values

void

Reimplemented from component_generator_base.

Reimplemented in mod_book_generator, mod_chat_generator, mod_data_generator, mod_forum_generator, mod_glossary_generator, mod_lesson_generator, mod_survey_generator, and mod_wiki_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:

• mod/resource/tests/generator/lib.php