Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mod_wiki_generator Class Reference
Inheritance diagram for mod_wiki_generator:
testing_module_generator component_generator_base

Public Member Functions

 create_content ($wiki, $record=array())
 Generates a piece of content for the module. More...
 
 create_first_page ($wiki, $record=array())
 
 create_instance ($record=null, array $options=null)
 Creates an instance of the module for testing purposes. More...
 
 create_page ($wiki, $record=array())
 Generates a page in wiki. More...
 
 get_modulename ()
 Returns module name. More...
 
 get_subwiki ($wiki, $subwikiid=null, $group=null, $userid=null)
 Retrieves or generates a subwiki and returns its id. 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...
 

Protected Attributes

testing_data_generator $datagenerator
 
number $instancecount = 0
 of created instances
 
int $pagecount = 0
 keep track of how many pages have been created.
 

Member Function Documentation

◆ create_content()

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

Generates a piece of content for the module.

User is usually taken from global $USER variable.

Parameters
stdClass$instanceobject returned from create_instance() call
stdClass | array$record
Return values
stdClassgenerated object
Exceptions
coding_exceptionif function is not implemented by module

Reimplemented from testing_module_generator.

◆ create_instance()

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

Creates an instance of the module for testing purposes.

Module type will be taken from the class name. Each module type may overwrite this function to add other default values used by it.

Parameters
array | stdClass$recorddata for module being generated. Requires 'course' key (an id or the full object). Also can have any fields from add module form.
null | array$optionsgeneral options for course module. Since 2.6 it is possible to omit this argument by merging options into $record
Return values
stdClassrecord from module-defined table with additional field cmid (corresponding id in course_modules table)

Reimplemented from testing_module_generator.

◆ create_page()

mod_wiki_generator::create_page (   $wiki,
  $record = array() 
)

Generates a page in wiki.

Parameters
stdClasswiki object returned from create_instance (if known)
stdClass | array$recorddata to insert as wiki entry.
Return values
stdClass
Exceptions
coding_exceptionif neither $record->wikiid nor $wiki->id is specified

◆ get_modulename()

testing_module_generator::get_modulename ( )
inherited

Returns module name.

Return values
stringname of module that this class describes
Exceptions
coding_exceptionif class invalid

◆ get_subwiki()

mod_wiki_generator::get_subwiki (   $wiki,
  $subwikiid = null,
  $group = null,
  $userid = null 
)

Retrieves or generates a subwiki and returns its id.

Parameters
stdClass$wiki
int$subwikiid
int$group
int$userid
Return values
int

◆ 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
stdClassmodule 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$optionssection, visible
Return values
integer::$cminstance 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$recordfields (different from defaults) for this module
null | array$optionsfor backward-compatibility this may include fields from course_modules table. They are merged into $record
Exceptions
coding_exceptionif $record->course is not specified

◆ reset()

mod_wiki_generator::reset ( )

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

Return values
void

Reimplemented from testing_module_generator.


The documentation for this class was generated from the following file: