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