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/moodle2/ -> backup_subplugin.class.php (source)

[Source view]

Defines backup_subplugin class

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: 101 lines (4 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 1 class

backup_subplugin:: (5 methods):
  __construct()
  define_subplugin_structure()
  get_setting_value()
  get_subplugin_element()
  get_recommended_name()


Class: backup_subplugin  - X-Ref

Class implementing the subplugins support for moodle2 backups

TODO: Finish phpdocs
TODO: Make this subclass of backup_plugin
__construct($subplugintype, $subpluginname, $optigroup, $step)   X-Ref
No description

define_subplugin_structure($connectionpoint)   X-Ref
No description

get_setting_value($name)   X-Ref
Returns the value of one (task/plan) setting


get_subplugin_element($final_elements = null, $conditionparam = null, $conditionvalue = null)   X-Ref
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)


get_recommended_name()   X-Ref
Simple helper function that suggests one name for the main nested element in subplugins
It's not mandatory to use it but recommended ;-)