Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/backup/util/structure/ -> backup_structure_processor.class.php (source)

[Source view]

(no description)

Copyright: 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 143 lines (6 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 2 classes

backup_structure_processor:: (8 methods):
  __construct()
  set_var()
  get_var()
  pre_process_nested_element()
  process_nested_element()
  post_process_nested_element()
  process_final_element()
  process_attribute()

backup_processor_exception:: (1 method):
  __construct()


Class: backup_structure_processor  - X-Ref

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
__construct(xml_writer $writer, \core\progress\base $progress = null)   X-Ref
Constructor.

param: xml_writer $writer XML writer to save data
param: c\core\progress\base$progress Progress tracker (optional)

set_var($key, $value)   X-Ref
No description

get_var($key)   X-Ref
No description

pre_process_nested_element(base_nested_element $nested)   X-Ref
No description

process_nested_element(base_nested_element $nested)   X-Ref
No description

post_process_nested_element(base_nested_element $nested)   X-Ref
No description

process_final_element(base_final_element $final)   X-Ref
No description

process_attribute(base_attribute $attribute)   X-Ref
No description

Class: backup_processor_exception  - X-Ref

backup_processor exception to control all the errors while working with backup_processors

This exception will be thrown each time the backup_processors detects some
inconsistency related with the elements to process or its configuration
__construct($errorcode, $a = null, $debuginfo = null)   X-Ref
Constructor - instantiates one backup_processor_exception

param: string $errorcode key for the corresponding error string
param: object $a extra words and phrases that might be required in the error string
param: string $debuginfo optional debugging information