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.
/mod/book/backup/moodle1/ -> lib.php (source)

[Source view]

Provides support for the conversion of moodle1 backup to the moodle2 format

Copyright: 2011 Tõnis Tartes <t6nis20@gmail.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 166 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

moodle1_mod_book_handler:: (6 methods):
  get_paths()
  process_book()
  process_book_chapters()
  on_book_chapters_start()
  on_book_chapters_end()
  on_book_end()


Class: moodle1_mod_book_handler  - X-Ref

Book conversion handler

get_paths()   X-Ref
Declare the paths in moodle.xml we are able to convert

The method returns list of {@link convert_path} instances. For each path returned,
at least one of on_xxx_start(), process_xxx() and on_xxx_end() methods must be
defined. The method process_xxx() is not executed if the associated path element is
empty (i.e. it contains none elements or sub-paths only).

Note that the path /MOODLE_BACKUP/COURSE/MODULES/MOD/BOOK does not
actually exist in the file. The last element with the module name was
appended by the moodle1_converter class.

return: array of {@link convert_path} instances

process_book($data)   X-Ref
This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/BOOK
data available

param: array $data

process_book_chapters($data)   X-Ref
This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/BOOK/CHAPTERS/CHAPTER
data available

param: array $data

on_book_chapters_start()   X-Ref
This is executed when the parser reaches the <CHAPTERS> opening element


on_book_chapters_end()   X-Ref
This is executed when the parser reaches the closing </CHAPTERS> element


on_book_end()   X-Ref
This is executed when we reach the closing </MOD> tag of our 'book' path