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

[Source view]

Defines restore_block_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: 213 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

restore_block_task:: (17 methods):
  __construct()
  get_taskbasepath()
  build()
  set_blockname()
  get_blockname()
  set_blockid()
  get_blockid()
  set_old_blockid()
  get_old_blockid()
  set_contextid()
  get_contextid()
  set_old_contextid()
  get_old_contextid()
  decode_configdata()
  define_decode_contents()
  define_decode_rules()
  define_settings()


Class: restore_block_task  - X-Ref

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

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


get_taskbasepath()   X-Ref
Block tasks have their own directory to write files


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


set_blockname($blockname)   X-Ref
No description

get_blockname()   X-Ref
No description

set_blockid($blockid)   X-Ref
No description

get_blockid()   X-Ref
No description

set_old_blockid($blockid)   X-Ref
No description

get_old_blockid()   X-Ref
No description

set_contextid($contextid)   X-Ref
No description

get_contextid()   X-Ref
No description

set_old_contextid($contextid)   X-Ref
No description

get_old_contextid()   X-Ref
No description

decode_configdata(string $configdata)   X-Ref
Helper method to safely unserialize block configuration during restore

param: string $configdata The original base64 encoded block config, as retrieved from the block_instances table
return: stdClass

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


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


define_settings()   X-Ref
Define the common setting that any backup block will have