Merge branch 'MDL-57550-master' of git://github.com/danpoltawski/moodle
[moodle.git] / mod / forum / upgrade.txt
1 This files describes API changes in /mod/forum/*,
2 information provided here is intended especially for developers.
4 === 3.3 ===
5   * External function get_forums_by_courses now returns and additional field "istracked" that indicates if the user
6    is tracking the related forum.
7 * The legacy forum.js file has been removed, this includes the js functions:
8     forum_produce_subscribe_link, forum_produce_tracking_link, lockoptions_timetoitems,
9     lockoptions_timefromitems, lockoptions, lockoption, unlockoption
11 === 3.2 ===
12  * The setting $CFG->forum_replytouser has been removed in favour of a centralized noreplyaddress setting.
13    Please use $CFG->noreplyaddress setting instead.
14  * The following functions have been finally deprecated and should no longer be used.
15   - forum_count_unrated_posts
16   - forum_tp_count_discussion_read_records
17   - forum_get_user_discussions
18   - forum_tp_count_forum_posts
19   - forum_tp_count_forum_read_records
20   - forum_get_open_modes
21   - forum_get_child_posts
22   - forum_get_discussion_posts
23   - forum_get_ratings
24   - forum_get_tracking_link
25   - forum_tp_count_discussion_unread_posts
26   - forum_convert_to_roles
27   - forum_tp_get_read_records
28   - forum_tp_get_discussion_read_records
29   - forum_user_enrolled
30   - forum_user_can_view_post
31   - forum_shorten_post
32   - forum_is_subscribed
33   - forum_subscribe
34   - forum_unsubscribe
35   - forum_subscribed_users
36   - forum_is_forcesubscribed
37   - forum_forcesubscribe
38   - forum_get_forcesubscribed
39   - forum_get_subscribed_forums
40   - forum_get_optional_subscribed_forums
41   - forum_get_potential_subscribers
42  * External functions that were returning file information now return the following file fields:
43    filename, filepath, mimetype, filesize, timemodified and fileurl.
44    Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
46 === 3.1 ===
47  * The inteface to forum_get_email_message_id() has changed and no longer needs the $host argument.
49 === 3.0 ===
50  * External function get_forums_by_courses now returns and additional field "cancreatediscussions" that indicates if the user
51    can create discussions in the forum.
52  * A new optional parameter (groupid) has been added to get_forum_discussions.
53    This parameter can override the automatically calculated current group.
54  * New constant FORUM_POSTS_ALL_USER_GROUPS, to be used as parameter in functions where we'd need to retrieve all the user posts.
56 === 2.8 ===
57  * The following functions have all been marked as deprecated. Many of
58    these have not been supported in many releases and should not be relied
59    upon:
60      forum_count_unrated_posts
61      forum_tp_count_discussion_read_records
62      forum_get_user_discussions
63      forum_tp_count_forum_posts
64      forum_tp_count_forum_read_records
65      forum_get_open_modes
66      forum_get_child_posts
67      forum_get_discussion_posts
68      forum_get_ratings
69      forum_get_tracking_link
70      forum_tp_count_discussion_unread_posts
71      forum_convert_to_roles
72      forum_tp_get_read_records
73      forum_tp_get_discussion_read_records
74      forum_user_enrolled
75      forum_user_can_view_post
76  * The following functions have been deprecated and replaced. Please see the phpdoc for each on the new function to use instead:
77    * forum_is_subscribed
78    * forum_subscribe
79    * forum_unsubscribe
80    * forum_subscribed_users
81    * forum_is_forcesubscribed
82    * forum_forcesubscribe
83    * forum_get_forcesubscribed
84    * forum_get_subscribed_forums
85    * forum_get_optional_subscribed_forums
86    * forum_get_potential_subscribers
87  * External function mod_forum_external::get_forum_discussions has been deprecated.
88    Use mod_forum_external::get_forum_discussions_paginated instead.
90 === 2.6 ===
92 * The file post_form.php should not be included, the class it contained has
93   been moved so that it can benefit from autoloading.
94 * The function forum_shorten_post() has been deprecated. It was doing a poor
95   job of shortening forum post text and the shorten_text() function does a
96   much better job.
97 * The constant FORUM_TRACKING_ON has been depreciated and replaced by
98   FORUM_TRACKING_FORCED. The value between them is maintained, so they are
99   interchangeable, but code should migrate to the new name.
101 === 2.5 ===
103 The 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
104 '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
105 as 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.
107 === 2.3.5, 2.4.2 ===
109 * mod/forum:allowforcesubscribe capability will be forcefully assigned to frontpage role, as it was mistakenly missed off
110 when the capability was initially created. If you don't want users with frontpage role to get forum (with forcesubscribe) emails,
111 then please remove this capability for frontpage role.