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

Public Member Functions

 access_protected ($object, string $property)
 Helper method to access to a protected property.
 
 create_preset (array $data=[])
 Create a preset.
 
 get_admin_preset_setting (string $category, string $settingname)
 Given a tree category and setting name, it gets the adminpresets_setting class.
 
 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

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

Member Function Documentation

◆ access_protected()

core_adminpresets_generator::access_protected ( $object,
string $property )

Helper method to access to a protected property.

Parameters
string | object$objectThe class.
string$propertyThe private/protected property in $object to access.
Return values
mixedThe current value of the property.

◆ create_preset()

core_adminpresets_generator::create_preset ( array $data = [])

Create a preset.

This preset will have only 3 settings and 3 plugins. Settings:

  • none.enablebadges = 0
  • none.allowemojipicker = 1
  • mod_lesson.mediawidth = 900
  • mod_lesson.maxanswers = 2 with advanced disabled. Plugins:

enrol_guest = 0

Parameters
array$dataPreset data. Supported values:
  • name. To define the preset name.
  • comments. To change the comments field.
  • author. To set the author.
  • applypreset. Whether the preset should be applied too or not.
Return values
intIdentifier of the preset created.

◆ get_admin_preset_setting()

core_adminpresets_generator::get_admin_preset_setting ( string $category,
string $settingname )

Given a tree category and setting name, it gets the adminpresets_setting class.

Parameters
string$categoryTree category name where the setting is located.
string$settingnameSetting name to get the class.
Return values
adminpresets_setting

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