MDL-64820 forum: fix behat tests
[moodle.git] / mod / forum / upgrade.txt
CommitLineData
afd5e85c
RT
1This files describes API changes in /mod/forum/*,
2information provided here is intended especially for developers.
3
2015327b
DW
4=== 3.6 ===
5 * forum_print_post should be surrounded with calls to forum_print_post_start and forum_print_post_end to create the proper HTML structure for the post.
6
b7ce46df
JL
7=== 3.4 ===
8 * External function get_forum_discussion_posts now returns an additional field "ratinginfo" containing rating information.
9
4669389d
PFO
10=== 3.3 ===
11 * External function get_forums_by_courses now returns and additional field "istracked" that indicates if the user
12 is tracking the related forum.
581e75bf 13 * The legacy forum.js file has been removed, this includes the js functions:
56882be6
DP
14 forum_produce_subscribe_link, forum_produce_tracking_link, lockoptions_timetoitems,
15 lockoptions_timefromitems, lockoptions, lockoption, unlockoption
581e75bf
JL
16 * External function can_add_discussion now returns two additional fields:
17 "canpindiscussions" that indicates if the user can add pinned discussions.
18 "cancreateattachment" that indicates if the user can add attachments to the discussion.
4669389d 19
d16185fd 20=== 3.2 ===
9715f61a 21 * The setting $CFG->forum_replytouser has been removed in favour of a centralized noreplyaddress setting.
253ae230 22 Please use $CFG->noreplyaddress setting instead.
d16185fd
AN
23 * The following functions have been finally deprecated and should no longer be used.
24 - forum_count_unrated_posts
25 - forum_tp_count_discussion_read_records
26 - forum_get_user_discussions
27 - forum_tp_count_forum_posts
28 - forum_tp_count_forum_read_records
29 - forum_get_open_modes
30 - forum_get_child_posts
31 - forum_get_discussion_posts
32 - forum_get_ratings
33 - forum_get_tracking_link
34 - forum_tp_count_discussion_unread_posts
35 - forum_convert_to_roles
36 - forum_tp_get_read_records
37 - forum_tp_get_discussion_read_records
38 - forum_user_enrolled
39 - forum_user_can_view_post
40 - forum_shorten_post
41 - forum_is_subscribed
42 - forum_subscribe
43 - forum_unsubscribe
44 - forum_subscribed_users
45 - forum_is_forcesubscribed
46 - forum_forcesubscribe
47 - forum_get_forcesubscribed
48 - forum_get_subscribed_forums
49 - forum_get_optional_subscribed_forums
50 - forum_get_potential_subscribers
14590070
JL
51 * External functions that were returning file information now return the following file fields:
52 filename, filepath, mimetype, filesize, timemodified and fileurl.
53 Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
d16185fd 54
54dceeed
BH
55=== 3.1 ===
56 * The inteface to forum_get_email_message_id() has changed and no longer needs the $host argument.
57
ea5b910b
JL
58=== 3.0 ===
59 * External function get_forums_by_courses now returns and additional field "cancreatediscussions" that indicates if the user
60 can create discussions in the forum.
4f3a2d21
JL
61 * A new optional parameter (groupid) has been added to get_forum_discussions.
62 This parameter can override the automatically calculated current group.
63 * New constant FORUM_POSTS_ALL_USER_GROUPS, to be used as parameter in functions where we'd need to retrieve all the user posts.
ea5b910b 64
39de876c
AN
65=== 2.8 ===
66 * The following functions have all been marked as deprecated. Many of
df7a4d65 67 these have not been supported in many releases and should not be relied
39de876c
AN
68 upon:
69 forum_count_unrated_posts
70 forum_tp_count_discussion_read_records
71 forum_get_user_discussions
72 forum_tp_count_forum_posts
73 forum_tp_count_forum_read_records
74 forum_get_open_modes
75 forum_get_child_posts
76 forum_get_discussion_posts
77 forum_get_ratings
78 forum_get_tracking_link
79 forum_tp_count_discussion_unread_posts
80 forum_convert_to_roles
81 forum_tp_get_read_records
82 forum_tp_get_discussion_read_records
83 forum_user_enrolled
84 forum_user_can_view_post
59075a43
AN
85 * The following functions have been deprecated and replaced. Please see the phpdoc for each on the new function to use instead:
86 * forum_is_subscribed
87 * forum_subscribe
88 * forum_unsubscribe
89 * forum_subscribed_users
90 * forum_is_forcesubscribed
91 * forum_forcesubscribe
92 * forum_get_forcesubscribed
93 * forum_get_subscribed_forums
94 * forum_get_optional_subscribed_forums
95 * forum_get_potential_subscribers
b235aef0
JL
96 * External function mod_forum_external::get_forum_discussions has been deprecated.
97 Use mod_forum_external::get_forum_discussions_paginated instead.
39de876c 98
2ecd2847
FM
99=== 2.6 ===
100
101* The file post_form.php should not be included, the class it contained has
102 been moved so that it can benefit from autoloading.
02d10ca0
MR
103* The function forum_shorten_post() has been deprecated. It was doing a poor
104 job of shortening forum post text and the shorten_text() function does a
105 much better job.
90b735b1 106* The constant FORUM_TRACKING_ON has been deprecated and replaced by
bd8f5d45
EM
107 FORUM_TRACKING_FORCED. The value between them is maintained, so they are
108 interchangeable, but code should migrate to the new name.
2ecd2847 109
f5ad424b
MN
110=== 2.5 ===
111
112The function forum_check_throttling has been changed so that a warning object is returned when a user has reached the 'Post threshold for warning' or
113'Post threshold for blocking' setting, rather than echoing this on screen. This allows the warning to be moved inside the post form as it can be added
114as a HTML element, where it is more noticeable. False is returned if there is no need to warn, or restrict the user from posting - see MDL-39182.
afd5e85c
RT
115
116=== 2.3.5, 2.4.2 ===
f5ad424b 117
afd5e85c
RT
118* mod/forum:allowforcesubscribe capability will be forcefully assigned to frontpage role, as it was mistakenly missed off
119when the capability was initially created. If you don't want users with frontpage role to get forum (with forcesubscribe) emails,
2ecd2847 120then please remove this capability for frontpage role.