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