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