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

Instantiable class defining the process of backup structures. More...

Inheritance diagram for backup_structure_processor:
base_processor

Public Member Functions

 __construct (xml_writer $writer, core\progress\base $progress=null)
 Constructor.
 
 get_var ($key)
 
 post_process_nested_element (base_nested_element $nested)
 
 pre_process_nested_element (base_nested_element $nested)
 
 process_attribute (base_attribute $attribute)
 
 process_final_element (base_final_element $final)
 
 process_nested_element (base_nested_element $nested)
 
 set_var ($key, $value)
 

Protected Attributes

core progress base $progress
 Progress tracker (null if none)
 
 $vars
 
 $writer
 

Detailed Description

Instantiable class defining the process of backup structures.

This class will process the given backup structure (nested/final/attribute) based on its definition, triggering as many actions as necessary (pre/post triggers, ids annotations, deciding based on settings, xml output...). Somehow one visitor pattern to allow backup structures to work with nice decoupling

Constructor & Destructor Documentation

◆ __construct()

backup_structure_processor::__construct ( xml_writer $writer,
core\progress\base $progress = null )

Constructor.

Parameters
xml_writer$writerXML writer to save data
c\core\progress\base$progressProgress tracker (optional)

Member Function Documentation

◆ post_process_nested_element()

backup_structure_processor::post_process_nested_element ( base_nested_element $nested)

Reimplemented from base_processor.

◆ pre_process_nested_element()

backup_structure_processor::pre_process_nested_element ( base_nested_element $nested)

Reimplemented from base_processor.

◆ process_attribute()

backup_structure_processor::process_attribute ( base_attribute $attribute)

Reimplemented from base_processor.

◆ process_final_element()

backup_structure_processor::process_final_element ( base_final_element $final)

Reimplemented from base_processor.

◆ process_nested_element()

backup_structure_processor::process_nested_element ( base_nested_element $nested)

Reimplemented from base_processor.


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