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