Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/backup/moodle2/ -> restore_section_task.class.php (source)

[Source view]

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

Defines 1 class

restore_section_task:: (11 methods):
  __construct()
  get_taskbasepath()
  set_sectionid()
  get_contextid()
  get_sectionid()
  build()
  execute()
  get_setting()
  define_decode_contents()
  define_decode_rules()
  define_settings()


Class: restore_section_task  - X-Ref

section task that provides all the properties and common steps to be performed
when one section is being restored

TODO: Finish phpdocs
__construct($name, $info, $plan = null)   X-Ref
Constructor - instantiates one object of this class


get_taskbasepath()   X-Ref
Section tasks have their own directory to read files


set_sectionid($sectionid)   X-Ref
No description

get_contextid()   X-Ref
No description

get_sectionid()   X-Ref
No description

build()   X-Ref
Create all the steps that will be part of this task


execute()   X-Ref
Exceptionally override the execute method, so, based in the section_included setting, we are able
to skip the execution of one task completely


get_setting($name)   X-Ref
Specialisation that, first of all, looks for the setting within
the task with the the prefix added and later, delegates to parent
without adding anything


define_decode_contents()   X-Ref
Define the contents in the course that must be
processed by the link decoder


define_decode_rules()   X-Ref
Define the decoding rules for links belonging
to the sections to be executed by the link decoder


define_settings()   X-Ref
Define the common setting that any restore section will have