Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
restore_subplugin Class Reference

Class implementing the subplugins support for moodle2 restore. More...

Inheritance diagram for restore_subplugin:
restore_assignfeedback_comments_subplugin restore_assignfeedback_editpdf_subplugin restore_assignfeedback_file_subplugin restore_assignment_offline_subplugin restore_assignsubmission_file_subplugin restore_assignsubmission_onlinetext_subplugin restore_ltiservice_gradebookservices_subplugin restore_mod_quiz_access_subplugin restore_tool_log_logstore_subplugin restore_workshopeval_best_subplugin restore_workshopform_accumulative_subplugin restore_workshopform_comments_subplugin restore_workshopform_numerrors_subplugin restore_workshopform_rubric_subplugin

Public Member Functions

 __construct ($subplugintype, $subpluginname, $step)
 
 define_subplugin_structure ($connectionpoint)
 
 launch_after_execute_methods ()
 after_execute dispatcher for any restore_subplugin class More...
 
 launch_after_restore_methods ()
 The after_restore dispatcher for any restore_subplugin class. More...
 
 log ($message, $level, $a=null, $depth=null, $display=false)
 Call the log function from the step.
 

Protected Member Functions

 add_related_files ($component, $filearea, $mappingitemname, $filesctxid=null, $olditemid=null)
 Add all the existing file, given their component and filearea and one backup_ids itemname to match with.
 
 apply_date_offset ($value)
 Apply course startdate offset based in original course startdate and course_offset_startdate setting Note we are using one static cache here, but by restoreid, so it's ok for concurrence/multiple executions in the same request.
 
 get_mapping ($itemname, $oldid)
 Return the complete mapping from the given itemname, itemid.
 
 get_mappingid ($itemname, $oldid, $ifnotfound=false)
 Return the new id of a mapping for the given itemname. More...
 
 get_namefor ($name='')
 Simple helper function that returns the name for the restore_path_element It's not mandatory to use it but recommended ;-)
 
 get_new_parentid ($itemname)
 Returns the latest (parent) new id mapped by one pathelement.
 
 get_old_parentid ($itemname)
 Returns the latest (parent) old id mapped by one pathelement.
 
 get_pathfor ($path='')
 Simple helper function that returns the base (prefix) of the path for the restore_path_element Useful if we used get_recommended_name() in backup. More...
 
 get_restoreid ()
 
 get_setting_value ($name)
 Returns the value of one (task/plan) setting.
 
 set_mapping ($itemname, $oldid, $newid, $restorefiles=false, $filesctxid=null, $parentid=null)
 To send ids pairs to backup_ids_table and to store them into paths. More...
 

Protected Attributes

 $connectionpoint
 
 $step
 
 $subpluginname
 
 $subplugintype
 
 $task
 

Detailed Description

Class implementing the subplugins support for moodle2 restore.

TODO: Finish phpdocs TODO: Make this subclass of restore_plugin TODO: Add support for declaring decode_contents (not decode_rules)

Constructor & Destructor Documentation

◆ __construct()

restore_subplugin::__construct (   $subplugintype,
  $subpluginname,
  $step 
)

Member Function Documentation

◆ get_mappingid()

restore_subplugin::get_mappingid (   $itemname,
  $oldid,
  $ifnotfound = false 
)
protected

Return the new id of a mapping for the given itemname.

Parameters
string$itemnamethe type of item
int$oldidthe item ID from the backup
mixed$ifnotfoundwhat to return if $oldid wasnt found. Defaults to false

◆ get_pathfor()

restore_subplugin::get_pathfor (   $path = '')
protected

Simple helper function that returns the base (prefix) of the path for the restore_path_element Useful if we used get_recommended_name() in backup.

It's not mandatory to use it but recommended ;-)

◆ launch_after_execute_methods()

restore_subplugin::launch_after_execute_methods ( )

after_execute dispatcher for any restore_subplugin class

This method will dispatch execution to the corresponding after_execute_xxx() method when available, with xxx being the connection point of the instance, so subplugin classes with multiple connection points will support multiple after_execute methods, one for each connection point

◆ launch_after_restore_methods()

restore_subplugin::launch_after_restore_methods ( )

The after_restore dispatcher for any restore_subplugin class.

This method will dispatch execution to the corresponding after_restore_xxx() method when available, with xxx being the connection point of the instance, so subplugin classes with multiple connection points will support multiple after_restore methods, one for each connection point.

◆ set_mapping()

restore_subplugin::set_mapping (   $itemname,
  $oldid,
  $newid,
  $restorefiles = false,
  $filesctxid = null,
  $parentid = null 
)
protected

To send ids pairs to backup_ids_table and to store them into paths.

This method will send the given itemname and old/new ids to the backup_ids_temp table, and, at the same time, will save the new id into the corresponding restore_path_element for easier access by children. Also will inject the known old context id for the task in case it's going to be used for restoring files later


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