weekly release 4.2dev
[moodle.git] / backup / upgrade.txt
1 This files describes API changes in /backup/*,
2 information provided here is intended especially for developers.
4 === 4.1 ===
6 * The class core_backup\copy\copy in backup/util/ui/classes/copy.php has been deprecated, please use copy_helper
7   from backup/util/helper/copy_helper.class.php instead.
8 * The method set_copy() in backup/controller/base_controller.class.php has been deprecated, please use a restore
9   controller for storing copy information instead.
10 * The method get_copy() in backup/controller/base_controller.class.php has been deprecated, please use get_copy()
11   from backup/controller/restore_controller.class.php instead.
13 === 4.0 ===
15 * Backup UI labels now accept empty/whitespace-only contents.
17 === 3.11 ===
19  * New setting called "Include permission overrides" has been implemented. The default
20    settings is OFF for import, and ON for restore.
22 === 3.10 ===
24  * Local plugins can now hook into a backup and restore process of grade items by
25    using define_grade_item_plugin_structure method (See MDL-69418).
27 === 3.1 ===
29 * New close() method added to loggers so they can close any open resource. Previously
30   any backup and restore operation using the file logger may be leaving unclosed files.
31 * New destroy() method added to loggers, normally called from backup and restore controllers
32   own destroy() method to ensure that all references in the chained loggers are deleted
33   and any open resource within them is closed properly.
35 === 3.0 ===
37 * The backup_auto_keep setting, in automated backups configuration, is now
38   renamed to backup_auto_max_kept as part of a rationalise of naming (see MDL-50602)
40 === 2.6 ===
42 * The backup_controller_dbops::create_temptable_from_real_table()
43   method is not available anymore. Temp tables must be created
44   inline always.
46 * Using the info field from backup_ids_temp or backup_files_temp
47   must now go via backup_controller_dbops::decode_backup_temp_info() and
48   backup_controller_dbops::encode_backup_temp_info(). The implementation
49   of the encoding has changed.  These new functions encapsulate any future
50   changes to the encoding.
52 === 2.5 ===
54 * New optional param $sortby in backup set_source_table() allows to
55     specify the ORDER BY clause to be used. Previously it was required
56     to use the set_source_sql() more complex alternative in places
57     requiring ordering.
58 * The old 1.9 files backuplib.php, lib.php and restorelib.php and the bb directory,
59     (all under /backup) have been deleted and no code should rely on them anymore.
61 === 2.4 ===
63 * Since 2.3.1+ the backup file name schema has changed. The ID of the course will always be part of
64     the filename regardless of the setting 'backup_shortname'. See MDL-33812.
66 === 2.3 ===
68 * Since 2.3.1+ the backup file name schema has changed. The ID of the course will always be part of
69     the filename regardless of the setting 'backup_shortname'. See MDL-33812.
71 === 2.2 ===
73 * Since 2.2.4+ the backup file name schema has changed. The ID of the course will always be part of
74     the filename regardless of the setting 'backup_shortname'. See MDL-33812.