Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
backup_tool_log_logstore_subplugin Class Reference

Parent class of all the logstore subplugin implementations. More...

Inheritance diagram for backup_tool_log_logstore_subplugin:
backup_subplugin backup_logstore_database_subplugin backup_logstore_standard_subplugin

Public Member Functions

 define_subplugin_structure ($connectionpoint)
 

Protected Member Functions

 get_recommended_name ()
 Simple helper function that suggests one name for the main nested element in subplugins It's not mandatory to use it but recommended ;-)
 
 get_setting_value ($name)
 Returns the value of one (task/plan) setting.
 
 get_subplugin_element ($final_elements=null, $conditionparam=null, $conditionvalue=null)
 Factory method that will return one backup_subplugin_element (backup_optigroup_element) with its name automatically calculated, based one the subplugin being handled (type, name)
 

Protected Attributes

 $connectionpoint
 
 $optigroup
 
 $step
 
 $subpluginname
 
 $subplugintype
 
 $task
 

Detailed Description

Parent class of all the logstore subplugin implementations.

Note: While this intermediate class is not strictly required and all the subplugin implementations can extend directly backup_subplugin, it is always recommended to have it, both for better testing and also for sharing code between all subplugins.


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