weekly release 4.0dev
[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
e335eb09
VD
4=== 3.10 ===
5
6* Changes in external function mod_forum_external::get_discussion_posts_by_userid
7 Now returns the posts of a given user checking the current user capabilities ($USER, the user who is requesting the posts).
8 Previously, it returned the posts checking the capabilities of the user that created the posts.
9
c0375ba7
AA
10=== 3.8 ===
11
12* The following functions have been finally deprecated and can not be used anymore:
13 * forum_scale_used()
d21d6baa
MH
14* In order for the forum summary report to calculate word count and character count data, those details are now stored
15 for each post in the database when posts are created or updated. For posts that existed prior to a Moodle 3.8 upgrade, these
16 are calculated by the refresh_forum_post_counts ad-hoc task in chunks of 5000 posts by default. Site admins are able to modify this
17 default, by setting $CFG->forumpostcountchunksize to the required integer value.
c0375ba7 18
f30f46db
RW
19=== 3.7 ===
20 * Changed the forum discussion rendering to use templates rather than print functions.
21 * Added new forum entities, factories, exporters, renderers, and vaults in the local namespace to better encapsulate the forum data.
22 * Deprecated all of the forum_print_* functions in lib.php.
a79c2c92 23 * The forum_print_latest_discussions function has been deprecated and will not be replaced.
bc4c7337 24 * The get_forum_discussion_posts web service has been deprecated in favour of get_discussion_posts.
15dc885a
AN
25 * The forum_count_replies function has been deprecated in favour of get_reply_count_for_post_id_in_discussion_id in
26 the Post vault.
ff3c8c0e 27 * External function get_forums_by_courses now returns two additional fields "duedate" and "cutoffdate" containing the due date and the cutoff date for posting to the forums respectively.
6c344ff2 28 * External function get_forum_discussion_posts now returns an additional field "tags" returning the post tags.
1a9c60e9
MG
29 * New external function mod_forum_external::get_forum_discussions returns a list of forum discussions optionally sorted and paginated.
30 * External function mod_forum_external::get_forum_discussions_paginated has been deprecated.
31 Use mod_forum_external::get_forum_discussions instead.
117e4bd4 32 * External function mod_forum_external::add_discussion_post() has a new 'messageformat' param to be able to handle other formats different from FORMAT_HTML (that continues being the default one). Also a new 'topreferredformat' option enables the automatic conversion between any format and the preferred format (given the editor preference) before contents are saved.
f30f46db 33
2015327b 34=== 3.6 ===
bc4c7337 35
2015327b
DW
36 * 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.
37
b7ce46df
JL
38=== 3.4 ===
39 * External function get_forum_discussion_posts now returns an additional field "ratinginfo" containing rating information.
40
4669389d
PFO
41=== 3.3 ===
42 * External function get_forums_by_courses now returns and additional field "istracked" that indicates if the user
43 is tracking the related forum.
581e75bf 44 * The legacy forum.js file has been removed, this includes the js functions:
56882be6
DP
45 forum_produce_subscribe_link, forum_produce_tracking_link, lockoptions_timetoitems,
46 lockoptions_timefromitems, lockoptions, lockoption, unlockoption
581e75bf
JL
47 * External function can_add_discussion now returns two additional fields:
48 "canpindiscussions" that indicates if the user can add pinned discussions.
49 "cancreateattachment" that indicates if the user can add attachments to the discussion.
4669389d 50
d16185fd 51=== 3.2 ===
9715f61a 52 * The setting $CFG->forum_replytouser has been removed in favour of a centralized noreplyaddress setting.
253ae230 53 Please use $CFG->noreplyaddress setting instead.
d16185fd
AN
54 * The following functions have been finally deprecated and should no longer be used.
55 - forum_count_unrated_posts
56 - forum_tp_count_discussion_read_records
57 - forum_get_user_discussions
58 - forum_tp_count_forum_posts
59 - forum_tp_count_forum_read_records
60 - forum_get_open_modes
61 - forum_get_child_posts
62 - forum_get_discussion_posts
63 - forum_get_ratings
64 - forum_get_tracking_link
65 - forum_tp_count_discussion_unread_posts
66 - forum_convert_to_roles
67 - forum_tp_get_read_records
68 - forum_tp_get_discussion_read_records
69 - forum_user_enrolled
70 - forum_user_can_view_post
71 - forum_shorten_post
72 - forum_is_subscribed
73 - forum_subscribe
74 - forum_unsubscribe
75 - forum_subscribed_users
76 - forum_is_forcesubscribed
77 - forum_forcesubscribe
78 - forum_get_forcesubscribed
79 - forum_get_subscribed_forums
80 - forum_get_optional_subscribed_forums
81 - forum_get_potential_subscribers
14590070
JL
82 * External functions that were returning file information now return the following file fields:
83 filename, filepath, mimetype, filesize, timemodified and fileurl.
84 Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
d16185fd 85
54dceeed
BH
86=== 3.1 ===
87 * The inteface to forum_get_email_message_id() has changed and no longer needs the $host argument.
88
ea5b910b
JL
89=== 3.0 ===
90 * External function get_forums_by_courses now returns and additional field "cancreatediscussions" that indicates if the user
91 can create discussions in the forum.
4f3a2d21
JL
92 * A new optional parameter (groupid) has been added to get_forum_discussions.
93 This parameter can override the automatically calculated current group.
94 * 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 95
39de876c
AN
96=== 2.8 ===
97 * The following functions have all been marked as deprecated. Many of
df7a4d65 98 these have not been supported in many releases and should not be relied
39de876c
AN
99 upon:
100 forum_count_unrated_posts
101 forum_tp_count_discussion_read_records
102 forum_get_user_discussions
103 forum_tp_count_forum_posts
104 forum_tp_count_forum_read_records
105 forum_get_open_modes
106 forum_get_child_posts
107 forum_get_discussion_posts
108 forum_get_ratings
109 forum_get_tracking_link
110 forum_tp_count_discussion_unread_posts
111 forum_convert_to_roles
112 forum_tp_get_read_records
113 forum_tp_get_discussion_read_records
114 forum_user_enrolled
115 forum_user_can_view_post
59075a43
AN
116 * The following functions have been deprecated and replaced. Please see the phpdoc for each on the new function to use instead:
117 * forum_is_subscribed
118 * forum_subscribe
119 * forum_unsubscribe
120 * forum_subscribed_users
121 * forum_is_forcesubscribed
122 * forum_forcesubscribe
123 * forum_get_forcesubscribed
124 * forum_get_subscribed_forums
125 * forum_get_optional_subscribed_forums
126 * forum_get_potential_subscribers
b235aef0
JL
127 * External function mod_forum_external::get_forum_discussions has been deprecated.
128 Use mod_forum_external::get_forum_discussions_paginated instead.
39de876c 129
2ecd2847
FM
130=== 2.6 ===
131
132* The file post_form.php should not be included, the class it contained has
133 been moved so that it can benefit from autoloading.
02d10ca0
MR
134* The function forum_shorten_post() has been deprecated. It was doing a poor
135 job of shortening forum post text and the shorten_text() function does a
136 much better job.
90b735b1 137* The constant FORUM_TRACKING_ON has been deprecated and replaced by
bd8f5d45
EM
138 FORUM_TRACKING_FORCED. The value between them is maintained, so they are
139 interchangeable, but code should migrate to the new name.
2ecd2847 140
f5ad424b
MN
141=== 2.5 ===
142
143The 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
144'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
145as 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
146
147=== 2.3.5, 2.4.2 ===
f5ad424b 148
afd5e85c
RT
149* mod/forum:allowforcesubscribe capability will be forcefully assigned to frontpage role, as it was mistakenly missed off
150when the capability was initially created. If you don't want users with frontpage role to get forum (with forcesubscribe) emails,
2ecd2847 151then please remove this capability for frontpage role.