core_notes_generator Class Reference

core_notes data generator class. More...

Inheritance diagram for core_notes_generator:

Public Member Functions
	create_instance ($record=null)
	Create a new note.
	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
number	$instancecount = 0
	of created instances

Detailed Description

core_notes data generator class.

Copyright

2013 Ankit Agarwal

License

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

Member Function Documentation

create_instance()

core_notes_generator::create_instance

(

$record = null

)

Create a new note.

Parameters

array | stdClass

$record

Exceptions

coding_exception

Return values

stdClass

activity record with extra cmid field

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

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

• notes/tests/generator/lib.php