Merge branch 'MDL-59096-master' of https://github.com/sammarshallou/moodle
[moodle.git] / blocks / upgrade.txt
blob0fa83c71d5ca256f020123820b7af2f89a68558d
1 This files describes API changes in /blocks/* - activity modules,
2 information provided here is intended especially for developers.
4 === 3.3 ===
6 * block_manager::get_required_by_theme_block_types() is no longer static.
7 * The plugin block_course_overview has been removed from core and is being replaced by block_myoverview.
8   During the upgrade process the block_course_overview block will be uninstalled and all its settings will be deleted.
9   If you wish to keep the block_course_overview block and its settings, download it from moodle.org and put it back in
10   the blocks/ directory BEFORE UPGRADING.
12 === 3.1 ===
14 * The collapsed class was removed from the navigation block to make it compatible with aria.
15 * New aria attributes were added on the navigation block [aria-expanded="false"].
16 * The tree JS handling were moved from YUI to AMD module (Jquery).
18 === 2.9 ===
20 * The obsolete method preferred_width() was removed (it was not doing anything)
21 * Deprecated block_base::config_save as is not called anywhere and should not be used.
22 * Added instance_copy() function to the block_base class. This function allows for block
23   specific data to be copied when a block is copied.
25 === 2.8 ===
27 * The instance_config_print() function was removed. It was deprecated in
28   Moodle 2.0, but without debugging notices. Since it was no longer a part
29   of the code path, debugging notices would not have been displayed.
30 * Deprecated functions were removed from the block_base class:
31 ** _print_block()
32 ** _print_shadow()
33 ** _title_html()
34 ** _add_edit_controls()
35 ** config_print()
37 === 2.6 ===
39 * Deprecated /admin/block.php was removed, make sure blocks are using settings.php instead.
41 === 2.4 ===
43 Created new capability 'blocks/xxx:myaddinstance' that determines whether a user can add
44 a specific block to their My Home page. This capability was only defined for blocks where
45 the applicable_formats function does not include "'my' => false" in the returned array,
46 allowing it be added to the My Home page.
48 === 2.3 ===
50 required changes in code:
51 * block_xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
52   contains additional options for the file serving. The array should be re-passed
53   to send_stored_file().
55 === 2.0 ===
57 required changes in code:
58 * use new DML syntax everywhere
59 * use new DDL syntax in db/upgrade.php
60 * replace defaults.php by settings.php and db/install.php
61 * replace STATEMENTS section in db/install.xml by db/install.php
62 * move post instalation code from install() method into db/install.php
63 * completely rewrite file handling
64 * rewrite backup/restore
65 * theme changes: move plugin styles into blocks/xxx/styles.css and use new css markers for images,
66                  move all images into new blocks/xxx/pix/ directory and use new outputlib api
67                  old global $THEME is fully replaced by $OUTPUT
68 * remove '_utf8' from language pack names, use new {$a} syntax in language packs
69 * use 'pluginname' lang pack identifier instead of 'blockname'
70 * move cron and version number into standard version.php
71 * removed support for old config_global.html, use settings.php