Merge branch 'wip-MDL-62411-master' of https://github.com/timhunt/moodle
[moodle.git] / blocks / upgrade.txt
CommitLineData
795a08ad 1This files describes API changes in /blocks/* - activity modules,
2information provided here is intended especially for developers.
3
1e44de35
RW
4=== 3.6 ===
5
6* The timeline view from block_myoverview has been split out into block_timeline.
0f8b2604 7* External function core_blocks::get_course_blocks now returns the block visible status and weight for ordering.
1e44de35 8
557554f9 9=== 3.4 ===
10
11* The block_instances table now contains fields timecreated and timemodified. If third-party code
12 creates or updates these rows (without using the standard API), it should be modified to set
13 these fields as appropriate.
a96faa49 14* Blocks can now be included in Moodle global search, with some limitations (at present, the search
15 works only for blocks located directly on course pages or site home page). See the HTML block for
16 an example.
f3a3e234 17* Block block_messages is no longer a part of core.
557554f9 18
a7fc1af1
DP
19=== 3.3 ===
20
21* block_manager::get_required_by_theme_block_types() is no longer static.
4671ae63
RW
22* The plugin block_course_overview has been removed from core and is being replaced by block_myoverview.
23 During the upgrade process the block_course_overview block will be uninstalled and all its settings will be deleted.
24 If you wish to keep the block_course_overview block and its settings, download it from moodle.org and put it back in
db3b7909 25 the blocks/ directory BEFORE UPGRADING.
a7fc1af1 26
6759dc35
SL
27=== 3.1 ===
28
29* The collapsed class was removed from the navigation block to make it compatible with aria.
30* New aria attributes were added on the navigation block [aria-expanded="false"].
31* The tree JS handling were moved from YUI to AMD module (Jquery).
32
2c2171bd
FM
33=== 2.9 ===
34
157e267f 35* The obsolete method preferred_width() was removed (it was not doing anything)
53c74b18 36* Deprecated block_base::config_save as is not called anywhere and should not be used.
ad5c3230
NL
37* Added instance_copy() function to the block_base class. This function allows for block
38 specific data to be copied when a block is copied.
2c2171bd 39
cbed1284
AN
40=== 2.8 ===
41
42* The instance_config_print() function was removed. It was deprecated in
43 Moodle 2.0, but without debugging notices. Since it was no longer a part
44 of the code path, debugging notices would not have been displayed.
45* Deprecated functions were removed from the block_base class:
46** _print_block()
47** _print_shadow()
48** _title_html()
49** _add_edit_controls()
50** config_print()
51
bde002b8
PS
52=== 2.6 ===
53
54* Deprecated /admin/block.php was removed, make sure blocks are using settings.php instead.
55
df7d171f
MN
56=== 2.4 ===
57
58Created new capability 'blocks/xxx:myaddinstance' that determines whether a user can add
59a specific block to their My Home page. This capability was only defined for blocks where
60the applicable_formats function does not include "'my' => false" in the returned array,
61allowing it be added to the My Home page.
62
957fc845
DM
63=== 2.3 ===
64
65required changes in code:
66* block_xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
67 contains additional options for the file serving. The array should be re-passed
68 to send_stored_file().
ee362526 69
795a08ad 70=== 2.0 ===
71
72required changes in code:
73* use new DML syntax everywhere
74* use new DDL syntax in db/upgrade.php
75* replace defaults.php by settings.php and db/install.php
76* replace STATEMENTS section in db/install.xml by db/install.php
77* move post instalation code from install() method into db/install.php
78* completely rewrite file handling
79* rewrite backup/restore
78946b9b
PS
80* theme changes: move plugin styles into blocks/xxx/styles.css and use new css markers for images,
81 move all images into new blocks/xxx/pix/ directory and use new outputlib api
cbcc9852 82 old global $THEME is fully replaced by $OUTPUT
19538d8c 83* remove '_utf8' from language pack names, use new {$a} syntax in language packs
ee362526 84* use 'pluginname' lang pack identifier instead of 'blockname'
8571833f 85* move cron and version number into standard version.php
dbf9e4ba 86* removed support for old config_global.html, use settings.php
795a08ad 87