Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
enrol_lti_generator Class Reference
Inheritance diagram for enrol_lti_generator:
component_generator_base

Public Member Functions

 create_application_registration (array $data)
 Test method to generate an application registration (and optionally a deployment) for a platform.
 
 create_published_resource (array $data)
 Test method to generate a published resource for a course.
 
 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

Member Function Documentation

◆ create_application_registration()

enrol_lti_generator::create_application_registration ( array $data)

Test method to generate an application registration (and optionally a deployment) for a platform.

Parameters
array$datathe application registration data, with optional deployment data.
Return values
application_registration

◆ create_published_resource()

enrol_lti_generator::create_published_resource ( array $data)

Test method to generate a published resource for a course.

Parameters
array$datathe data required to publish the resource.
Return values
stdClassthe enrol_lti_tools record, representing the published resource.

◆ 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$instanceThe instance record of the already-created record
stdClass$recordThe data passed in to create the instance
string$tableThe table that the data exists in
context$contextThe context of the instance
string$componentThe component of the owning plugin
string$fileareaThe name of the file area
int$targetitemidThe itemid to use when saving the files
Return values
stdClassThe updated instance record

◆ reset()

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