Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/mod/assignment/backup/moodle1/ -> lib.php (source)

[Source view]

Provides support for the conversion of moodle1 backup to the moodle2 format Based off of a template @ http://docs.moodle.org/dev/Backup_1.9_conversion_for_developers

Copyright: 2011 Aparup Banerjee <aparup@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 253 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 3 classes

moodle1_mod_assignment_handler:: (6 methods):
  get_paths()
  process_assignment()
  process_assignment_submission()
  handle_assignment_subplugin()
  on_assignment_end()
  get_subplugin_handler()

moodle1_assignment_subplugin_handler:: (3 methods):
  __construct()
  use_xml_writer()
  append_subplugin_data()

moodle1_assignment_unsupported_subplugin_handler:: (0 methods):


Class: moodle1_mod_assignment_handler  - X-Ref

Assignment 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, the corresponding conversion method must be
defined.

Note that the path /MOODLE_BACKUP/COURSE/MODULES/MOD/ASSIGNMENT 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_assignment($data)   X-Ref
This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/ASSIGNMENT
data available


process_assignment_submission($data)   X-Ref
This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/ASSIGNMENT/SUBMISSIONS/SUBMISSION
data available


handle_assignment_subplugin($data)   X-Ref
This handles calls to subplugin conversion classes.
called from <ASSIGNMENTTYPE> within process_assignment()


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


get_subplugin_handler($subplugin)   X-Ref
Factory method returning the handler of the given assignment subplugin

param: string $subplugin the name of the subplugin
return: moodle1_assignment_subplugin_handler the instance of the handler

Class: moodle1_assignment_subplugin_handler  - X-Ref

Base class for the assignment subplugin handler
Extend this for your own subplugin conversion handling purposes.

__construct(moodle1_mod_handler $assignmenthandler, $subpluginname)   X-Ref

param: moodle1_mod_handler $assignmenthandler the handler of a module we are subplugin of
param: string $subpluginname the name of the subplugin

use_xml_writer(xml_writer $xmlwriter)   X-Ref
Provides a xml_writer instance to this assignment subplugin type handler

param: xml_writer $xmlwriter

append_subplugin_data($data)   X-Ref
a call back (entry point) to the subplugin conversion handler class.
$data are the elements of <assignment>, any (@todo sub paths containing subplugindata isn't handed through).


Class: moodle1_assignment_unsupported_subplugin_handler  - X-Ref

This class handles subplugins that do not exist or that are not supported