backup/upgrade.txt

   1 This files describes API changes in /backup/*,
   2 information provided here is intended especially for developers.
   3
   4 === 4.4 ===
   5
   6 * New \core_backup\hook\before_course_modified_check hook which can be used to exclude events from automated backup has been implemented (See MDL-73926 and MDL-81044).
   7
   8 === 4.3 ===
   9
  10 * The function get_async_backup_links_backup has a new param of $backupid and is part of a fix to
  11   async backups (See MDL-69983).
  12 * During restore the function create_included_users has been updated to convert backups containing
  13   legacy MD5 hashed passwords to the new password hashing scheme (See MDL-79134).
  14
  15 === 4.1 ===
  16
  17 * The class core_backup\copy\copy in backup/util/ui/classes/copy.php has been deprecated, please use copy_helper
  18   from backup/util/helper/copy_helper.class.php instead.
  19 * The method set_copy() in backup/controller/base_controller.class.php has been deprecated, please use a restore
  20   controller for storing copy information instead.
  21 * The method get_copy() in backup/controller/base_controller.class.php has been deprecated, please use get_copy()
  22   from backup/controller/restore_controller.class.php instead.
  23
  24 === 4.0 ===
  25
  26 * Backup UI labels now accept empty/whitespace-only contents.
  27
  28 === 3.11 ===
  29
  30  * New setting called "Include permission overrides" has been implemented. The default
  31    settings is OFF for import, and ON for restore.
  32
  33 === 3.10 ===
  34
  35  * Local plugins can now hook into a backup and restore process of grade items by
  36    using define_grade_item_plugin_structure method (See MDL-69418).
  37
  38 === 3.1 ===
  39
  40 * New close() method added to loggers so they can close any open resource. Previously
  41   any backup and restore operation using the file logger may be leaving unclosed files.
  42 * New destroy() method added to loggers, normally called from backup and restore controllers
  43   own destroy() method to ensure that all references in the chained loggers are deleted
  44   and any open resource within them is closed properly.
  45
  46 === 3.0 ===
  47
  48 * The backup_auto_keep setting, in automated backups configuration, is now
  49   renamed to backup_auto_max_kept as part of a rationalise of naming (see MDL-50602)
  50
  51 === 2.6 ===
  52
  53 * The backup_controller_dbops::create_temptable_from_real_table()
  54   method is not available anymore. Temp tables must be created
  55   inline always.
  56
  57 * Using the info field from backup_ids_temp or backup_files_temp
  58   must now go via backup_controller_dbops::decode_backup_temp_info() and
  59   backup_controller_dbops::encode_backup_temp_info(). The implementation
  60   of the encoding has changed.  These new functions encapsulate any future
  61   changes to the encoding.
  62
  63 === 2.5 ===
  64
  65 * New optional param $sortby in backup set_source_table() allows to
  66     specify the ORDER BY clause to be used. Previously it was required
  67     to use the set_source_sql() more complex alternative in places
  68     requiring ordering.
  69 * The old 1.9 files backuplib.php, lib.php and restorelib.php and the bb directory,
  70     (all under /backup) have been deleted and no code should rely on them anymore.
  71
  72 === 2.4 ===
  73
  74 * Since 2.3.1+ the backup file name schema has changed. The ID of the course will always be part of
  75     the filename regardless of the setting 'backup_shortname'. See MDL-33812.
  76
  77 === 2.3 ===
  78
  79 * Since 2.3.1+ the backup file name schema has changed. The ID of the course will always be part of
  80     the filename regardless of the setting 'backup_shortname'. See MDL-33812.
  81
  82 === 2.2 ===
  83
  84 * Since 2.2.4+ the backup file name schema has changed. The ID of the course will always be part of
  85     the filename regardless of the setting 'backup_shortname'. See MDL-33812.