· 6 years ago · Nov 01, 2019, 09:48 AM
1This files describes API changes in core libraries and APIs,
2information provided here is intended especially for developers.
3
4=== 3.5.2 ===
5
6* Custom AJAX handlers for the form autocomplete fields can now optionally return string in their processResults()
7 callback. If a string is returned, it is displayed instead of the list if suggested items. This can be used, for
8 example, to inform the user that there are too many items matching the current search criteria.
9* coursecat::get() now has optional $user parameter.
10* coursecat::is_uservisible() now has optional $user parameter.
11
12=== 3.5 ===
13
14* There is a new privacy API that every subsystem and plugin has to implement so that the site can become GDPR
15 compliant. Plugins use this API to report what information they store or process regarding users, and provide ability
16 to export and delete personal data. See https://docs.moodle.org/dev/Privacy_API for guidelines on how to implement the
17 privacy API in your plugin.
18* The cron runner now sets up a fresh PAGE and OUTPUT between each task.
19* The core_renderer methods notify_problem(), notify_success(), notify_message() and notify_redirect() that were
20 deprecated in Moodle 3.1 have been removed. Use \core\notification::add(), or \core\output\notification as required.
21* The maximum supported precision (the total number of digits) for XMLDB_TYPE_NUMBER ("number") fields raised from 20 to
22 38 digits. Additionally, the whole number part (precision minus scale) must not be longer than the maximum length of
23 integer fields (20 digits). Note that PHP floats commonly support precision of roughly 15 digits only (MDL-32113).
24* Event triggering and event handlers:
25 - The following events, deprecated since moodle 2.6, have been finally removed: groups_members_removed,
26 groups_groupings_groups_removed, groups_groups_deleted, groups_groupings_deleted.
27* The following functions have been finally deprecated and can not be used any more:
28 - notify()
29* XMLDB now validates the PATH attribute on every install.xml file. Both the XMLDB editor and installation will fail
30 when a problem is detected with it. Please ensure your plugins contain correct directory relative paths.
31* Add recaptchalib_v2.php for support of reCAPTCHA v2.
32* Plugins can define class 'PLUGINNAME\privacy\local\sitepolicy\handler' if they implement an alternative mechanisms for
33 site policies managements and agreements. Administrators can define which component is to be used for handling site
34 policies and agreements. See https://docs.moodle.org/dev/Site_policy_handler
35* Scripts can define a constant NO_SITEPOLICY_CHECK and set it to true before requiring the main config.php file. It
36 will make the require_login() skipping the test for the user's policyagreed status. This is useful for plugins that
37 act as a site policy handler.
38* There is a new is_fulltext_search_supported() DML function. The default implementation returns false. This function
39 is used by 'Simple search' global search engine to determine if the database full-text search capabilities can be used.
40* The following have been removed from the list of core subsystems:
41 - core_register
42 - core_publish
43 Following this change, \core_register_renderer and \core_publish_renderer have been removed and their methods have been
44 moved to \core_admin_renderer and \core_course_renderer respectively.
45
46=== 3.4 ===
47
48* oauth2_client::request method has an extra parameter to specify the accept header for the response (MDL-60733)
49* The following functions, previously used (exclusively) by upgrade steps are not available
50 anymore because of the upgrade cleanup performed for this version. See MDL-57432 for more info:
51 - upgrade_mimetypes()
52 - upgrade_fix_missing_root_folders_draft()
53 - upgrade_minmaxgrade()
54 - upgrade_course_tags()
55
56* Added new moodleform element 'filetypes' and new admin setting widget 'admin_setting_filetypes'. These new widgets
57 allow users to define a list of file types; either by typing them manually or selecting them from a list. The widgets
58 directly support the syntax used to feed the 'accepted_types' option of the filemanager and filepicker elements. File
59 types can be specified as extensions (.jpg or just jpg), mime types (text/plain) or groups (image).
60* Removed accesslib private functions: load_course_context(), load_role_access_by_context(), dedupe_user_access() (MDL-49398).
61* Internal "accessdata" structure format has changed to improve ability to perform role definition caching (MDL-49398).
62* Role definitions are no longer cached in user session (MDL-49398).
63* External function core_group_external::get_activity_allowed_groups now returns an additional field: canaccessallgroups.
64 It indicates whether the user will be able to access all the activity groups.
65* file_get_draft_area_info does not sum the root folder anymore when calculating the foldercount.
66* The moodleform element classes can now optionally provide a public function validateSubmitValue(). This method can be
67 used to perform implicit validation of submitted values - without the need to explicitly add the validation rules to
68 every form. The method should accept a single parameter with the submitted value. It should return a string with the
69 eventual validation error, or an empty value if the validation passes.
70* New user_picture attribute $includefullname to determine whether to include the user's full name with the user's picture.
71* Enrol plugins which provide enrolment actions can now declare the following "data-action" attributes in their implementation of
72 enrol_plugin::get_user_enrolment_actions() whenever applicable:
73 * "editenrolment" - For editing a user'e enrolment details. Defined by constant ENROL_ACTION_EDIT.
74 * "unenrol" - For unenrolling a student. Defined by constant ENROL_ACTION_UNENROL.
75 These attributes enable enrol actions to be rendered via modals. If not added, clicking on the enrolment action buttons will still
76 redirect the user to the appropriate enrolment action page. Though optional, it is recommended to add these attributes for a
77 better user experience when performing enrol actions.
78* The enrol_plugin::get_user_enrolment_actions() implementations for core enrol plugins have been removed and moved to
79 the parent method itself. New enrol plugins don't have to implement get_user_enrolment_actions(), but just need to
80 make sure that they override:
81 - enrol_plugin::allow_manage(), and/or
82 - enrol_plugin::allow_unenrol_user() or enrol_plugin::allow_unenrol()
83 Existing enrol plugins that override enrol_plugin::get_user_enrolment_actions() don't have to do anything, but can
84 also opt to remove their own implementation of the method if they basically have the same logic as the parent method.
85* New optional parameter $enrolid for the following functions:
86 - get_enrolled_join()
87 - get_enrolled_sql()
88 - get_enrolled_with_capabilities_join()
89 Setting this parameter to a non-zero value will add a condition to the query such that only users that were enrolled
90 with this enrolment method will be returned.
91* New optional parameter 'closeSuggestionsOnSelect' for the enhance() function for form-autocomplete. Setting this to true will
92 close the suggestions popup immediately after an option has been selected. If not specified, it defaults to true for single-select
93 elements and false for multiple-select elements.
94* user_can_view_profile() now also checks the moodle/user:viewalldetails capability.
95* The core/modal_confirm dialogue has been deprecated. Please use the core/modal_save_cancel dialogue instead. Please ensure you
96 update to use the ModalEvents.save and ModalEvents.cancel events instead of their yes/no counterparts.
97* Instead of checking the 'moodle/course:viewparticipants' and 'moodle/site:viewparticipants' capabilities use the
98 new functions course_can_view_participants() and course_require_view_participants().
99* $stored_file->add_to_curl_request() now adds the filename to the curl request.
100* The option for Login HTTPS (authentication-only SSL) has been removed
101* $CFG->loginhttps is now deprecated, do not use it.
102* $PAGE->https_required and $PAGE->verify_https_required() are now deprecated. They are no longer used and will throw a coding_exception.
103* $CFG->httpswwwroot is now deprecated and will always result in the same value as wwwroot.
104* Added function core_role_set_view_allowed() to check if a user should be able to see a given role.
105 This should be checked whenever displaying a list of roles to a user, however, core_role_set_assign_allowed may need to override it
106 in some cases.
107* Deprecated allow_override, allow_assign and allow_switch and replaced with core_role_set_*_allowed to avoid function names conflicting.
108
109=== 3.3.1 ===
110
111* ldap_get_entries_moodle() now always returns lower-cased attribute names in the returned entries.
112 It was suppposed to do so before, but it actually didn't.
113
114=== 3.3 ===
115
116* Behat compatibility changes are now being documented at
117 https://docs.moodle.org/dev/Acceptance_testing/Compatibility_changes
118* PHPUnit's bootstrap has been changed to use HTTPS wwwroot (https://www.example.com/moodle) from previous HTTP version. Any
119 existing test expecting the old HTTP URLs will need to be switched to the new HTTPS value (reference: MDL-54901).
120* The information returned by the idp list has changed. This is usually only rendered by the login page and login block.
121 The icon attribute is removed and an iconurl attribute has been added.
122* Support added for a new type of external file: FILE_CONTROLLED_LINK. This is an external file that Moodle can control
123 the permissions. Moodle makes files read-only but can grant temporary write access.
124 When accessing a URL, the info from file_browser::get_file_info will be checked to determine if the user has write access,
125 if they do - the remote file will have access controls set to allow editing.
126* The method moodleform::after_definition() has been added and can now be used to add some logic
127 to be performed after the form's definition was set. This is useful for intermediate subclasses.
128* Moodle has support for font-awesome icons. Plugins should use the xxx_get_fontawesome_icon_map callback
129 to map their custom icons to one from font-awesome.
130* $OUTPUT->pix_url() has been deprecated because it is was used mostly to manually generate image tags for icons.
131 We now distinguish between icons and "small images". The difference is that an icon does not have to be rendered as an image tag
132 with a source. It is OK to still have "small images" - if this desired use $OUTPUT->image_icon() and $OUTPUT->image_url(). For
133 other uses - use $OUTPUT->pix_icon() or the pix helper in mustache templates {{#pix}}...{{/pix}}
134 For other valid use cases use $OUTPUT->image_url().
135* Activity icons have been split from standard icons. Use $OUTPUT->image_icon instead of $OUTPUT->pix_icon for these
136 type of icons (the coloured main icon for each activity).
137* YUI module moodle-core-formautosubmit has been removed, use jquery .change() instead (see lib/templates/url_select.mustache for
138 an example)
139* $mform->init_javascript_enhancement() is deprecated and no longer does anything. Existing uses of smartselect enhancement
140 should be switched to the searchableselector form element or other solutions.
141* Return value of the validate_email() is now proper boolean as documented. Previously the function could return 1, 0 or false.
142* The mcore YUI rollup which included various YUI modules such as moodle-core-notification is no longer included on every
143 page. Missing YUI depdencies may be exposed by this change (e.g. missing a requirement on moodle-core-notification when
144 using M.core.dialogue).
145* Various legacy javascript functions have been removed:
146 * M.util.focus_login_form and M.util.focus_login_error no longer do anything. Please use jquery instead. See
147 lib/templates/login.mustache for an example.
148 * Some outdated global JS functions have been removed and should be replaced with calls to jquery
149 or alternative approaches:
150 checkall, checknone, select_all_in_element_with_id, select_all_in, deselect_all_in, confirm_if, findParentNode,
151 filterByParent, stripHTML
152 * M.util.init_toggle_class_on_click has been removed.
153* The following functions have been deprecated and should not be used any more:
154 - file_storage::try_content_recovery - See MDL-46375 for more information
155 - file_storage::content_exists - See MDL-46375 for more information
156 - file_storage::deleted_file_cleanup - See MDL-46375 for more information
157 - file_storage::get_converted_document
158 - file_storage::is_format_supported_by_unoconv
159 - file_storage::can_convert_documents
160 - file_storage::send_test_pdf
161 - file_storage::test_unoconv_path
162* Following behat steps have been removed from core:
163 - I click on "<element_string>" "<selector_string>" in the "<row_text_string>" table row
164 - I go to notifications page
165 - I add "<filename_string>" file from recent files to "<filepicker_field_string>" filepicker
166 - I upload "<filepath_string>" file to "<filepicker_field_string>" filepicker
167 - I create "<foldername_string>" folder in "<filepicker_field_string>" filepicker
168 - I open "<foldername_string>" folder from "<filepicker_field_string>" filepicker
169 - I unzip "<filename_string>" file from "<filepicker_field_string>" filepicker
170 - I zip "<filename_string>" folder from "<filepicker_field_string>" filepicker
171 - I delete "<file_or_folder_name_string>" from "<filepicker_field_string>" filepicker
172 - I send "<message_contents_string>" message to "<username_string>"
173 - I add "<user_username_string>" user to "<cohort_idnumber_string>" cohort
174 - I add "<username_string>" user to "<group_name_string>" group
175 - I fill in "<field_string>" with "<value_string>"
176 - I select "<option_string>" from "<select_string>"
177 - I select "<radio_button_string>" radio button
178 - I check "<option_string>"
179 - I uncheck "<option_string>"
180 - the "<field_string>" field should match "<value_string>" value
181 - the "<checkbox_string>" checkbox should be checked
182 - the "<checkbox_string>" checkbox should not be checked
183 - I fill the moodle form with:
184 - "<element_string>" "<selector_string>" should exists
185 - "<element_string>" "<selector_string>" should not exists
186 - the following "<element_string>" exists:
187* get_user_capability_course() now has an additional parameter 'limit'. This can be used to return a set number of records with
188 the submitted capability. The parameter 'fieldsexceptid' will now accept context fields which can be used for preloading.
189* The caching option 'immutable' has been added to send_stored_file() and send_file().
190* New adhoc task refresh_mod_calendar_events_task that updates existing calendar events of modules.
191* New 'priority' column for the event table to determine which event to show in case of events with user and group overrides.
192* Webservices core_course_search_courses and core_course_get_courses_by_field will always return the sortorder field.
193* core_course_external::get_activities_overview has been deprecated. Please do not call this function any more.
194* Changed the pix mustache template helper to accept context variables for the key, component and alt text.
195* New auth_plugin_base helper methods:
196 - get_identity_providers() - Retrieves available auth identity providers.
197 - prepare_identity_providers_for_output() - Prepares auth identity provider data for output (e.g. to templates, WS, etc.).
198
199=== 3.2 ===
200
201* Custom roles with access to any part of site administration that do not use the manager archetype will need
202 moodle/site:configview capability added.
203* Admin setting "Show My courses expanded on Dashboard" has been removed.
204* Some backwards and forwards compatibility has been added for different bootstrap versions.
205 This is to allow the same markup to work in "clean" and "boost" themes alot of the time. It is also to allow user text
206 with bootstrap classes to keep working in the new theme. See MDL-56004 for the list of supported classes.
207* MForms element 'submitlink' has been deprecated.
208* Searchable selector form element is now a wrapper for autocomplete. A "No selection" option is automatically
209 added to the options list for best backwards compatibility - if you were manually adding a "no selection" option you will need
210 to remove it.
211* Node.js versions >=4 are now required to run grunt.
212* JQuery has been updated to 3.1.0. JQuery migrate plugins are no longer shipped - please read
213 https://jquery.com/upgrade-guide/3.0/ and update your javascript.
214* New option 'blanktarget' added to format_text. This option adds target="_blank" to links
215* A new webservice structure `external_files` has been created which provides a standardised view of files in Moodle and
216 should be used for all file return descriptions.
217 Files matching this format can be retrieved via the new `external_util::get_area_files` method.
218 See MDL-54951 for further information.
219* The parameter $usepost of the following functions has been deprecated and is not used any more:
220 - get_max_upload_file_size()
221 - get_user_max_upload_file_size()
222* The following classes have been removed and should not be used any more:
223 - boxclient - See MDL-49599 for more information.
224* The following functions have been removed and should not be used any more:
225 - file_modify_html_header() - See MDL-29738 for more information.
226* core_grades_external::get_grades has been deprecated. Please do not call this function any more.
227 External function gradereport_user_external::get_grade_items can be used for retrieving the course grades information.
228* New option 'escape' added to format_string. When true (default), escapes HTML entities from the string
229* The following functions have been deprecated and are not used any more:
230 - get_records_csv() Please use csv_import_reader::load_csv_content() instead.
231 - put_records_csv() Please use download_as_dataformat (lib/dataformatlib.php) instead.
232 - zip_files() - See MDL-24343 for more information.
233 - unzip_file() - See MDL-24343 for more information.
234 - print_log() - See MDL-43681 for more information
235 - print_log_csv() - See MDL-43681 for more information
236 - print_log_ods() - See MDL-43681 for more information
237 - print_log_xls() - See MDL-43681 for more information
238 - print_mnet_log() - See MDL-43681 for more information
239 - build_logs_array() - See MDL-43681 for more information
240 - get_logs() - See MDL-43681 for more information
241 - get_logs_usercourse() - See MDL-43681 for more information
242 - get_logs_userday() - See MDL-43681 for more information
243 - prevent_form_autofill_password() Please do not use anymore.
244* The password_compat library was removed as it is no longer required.
245* Phpunit has been upgraded to 5.4.x and following has been deprecated and is not used any more:
246 - setExpectedException(), use @expectedException or $this->expectException() and $this->expectExceptionMessage()
247 - getMock(), use createMock() or getMockBuilder()->getMock()
248 - UnitTestCase class is removed.
249* The following methods have been finally deprecated and should no longer be used:
250 - course_modinfo::build_section_cache()
251 - cm_info::get_deprecated_group_members_only()
252 - cm_info::is_user_access_restricted_by_group()
253* The following methods in cm_info::standardmethods have also been finally deprecated and should no longer be used:
254 - cm_info::get_after_edit_icons()
255 - cm_info::get_after_link()
256 - cm_info::get_content()
257 - cm_info::get_custom_data()
258 - cm_info::get_extra_classes()
259 - cm_info::get_on_click()
260 - cm_info::get_url()
261 - cm_info::obtain_dynamic_data()
262 Calling them through the magic method __call() will throw a coding exception.
263* The alfresco library has been removed from core. It was an old version of
264 the library which was not compatible with newer versions of Alfresco.
265* Added down arrow: $OUTPUT->darrow.
266* All file_packer implementations now accept an additional parameter to allow a simple boolean return value instead of
267 an array of individual file statuses.
268* "I set the field "field_string" to multiline:" now end with colon (:), as PyStrings is supposed to end with ":"
269* New functions to support deprecation of events have been added to the base event. See MDL-46214 for further details.
270* A new function `get_name_with_info` has been added to the base event. This function adds information about event
271 deprecations and should be used where this information is relevant.
272* Following api's have been deprecated in behat_config_manager, please use behat_config_util instead.
273 - get_features_with_tags
274 - get_components_steps_definitions
275 - get_config_file_contents
276 - merge_behat_config
277 - get_behat_profile
278 - profile_guided_allocate
279 - merge_config
280 - clean_path
281 - get_behat_tests_path
282* behat_util::start_test_mode() accepts 3 options now:
283 - 1. Theme sute with all features: If behat should initialise theme suite with all core features.
284 - 2. Parallel runs: How many parallel runs will be running.
285 - 3. Run: Which process behat should be initialise for.
286* behat_context_helper::set_session() has been deprecated, please use behat_context_helper::set_environment() instead.
287* data-fieldtype="type" attribute has been added to form field default template.
288* form elements extending MoodleQuickForm_group must call $this->createFormElement() instead of
289 @MoodleQuickForm::createElement() in order to be compatible with PHP 7.1
290* Relative paths in $CFG->alternateloginurl will be resolved to absolute path within moodle site. Previously they
291 were resolved to absolute path within the server. That means:
292 - $CFG->wwwroot: http://example.com/moodle
293 - $CFG->alternateloginurl : /my/super/login.php
294 - Login url will be: http://example.com/moodle/my/super/login.php (moodle root based)
295* Database (DML) layer:
296 - new sql_equal() method available for places where case sensitive/insensitive varchar comparisons are required.
297* PostgreSQL connections now use advanced options to reduce connection overhead. These options are not compatible
298 with some connection poolers. The dbhandlesoptions parameter has been added to allow the database to configure the
299 required defaults. The parameters that are required in the database are;
300 ALTER DATABASE moodle SET client_encoding = UTF8;
301 ALTER DATABASE moodle SET standard_conforming_strings = on;
302 ALTER DATABASE moodle SET search_path = 'moodle,public'; -- Optional, if you wish to use a custom schema.
303 You can set these options against the database or the moodle user who connects.
304* Some form elements have been refined to better support right-to-left languages. In RTL,
305 most fields should not have their direction flipped, a URL, a path to a file, a number, ...
306 are always displayed LTR. Input fields and text areas now will best guess whether they
307 should be forced to be displayed in LTR based on the PARAM type associated with it. You
308 can call $mform->setForceLtr($elementName, true/false) on some form fields to manually
309 set the value.
310* Action menus do_not_enhance() is deprecated, use a list of action_icon instead.
311* The user_not_fully_set_up() function has a new $strict parameter (defaulting to true) in order to decide when
312 custom fields (and other checks) should be evaluated to determine if the user has been completely setup.
313* profile_field_base class has new methods: get_field_config_for_external() and get_field_properties().
314 This two new methods should be implemented by profile field plugins to make them compatible with Web Services.
315* The minifier library used by core_minify has been switched to https://github.com/matthiasmullie/minify - there are minor differences
316 in minifier output.
317* context_header additional buttons can now have a class attribute provided in the link attributes.
318* The return signature for the antivirus::scan_file() function has changed.
319 The calling function will now handle removal of infected files from Moodle based on the new integer return value.
320* The first parameter $eventdata of both message_send() and \core\message\manager::send_message() should
321 be \core\message\message. Use of stdClass is deprecated.
322* The message_sent event now expects other[courseid] to be always set, exception otherwise. For BC with contrib code,
323 message_sent::create_from_ids() will show a debugging notice if the \core\message\message being sent is missing
324 the courseid property, defaulting to SITEID automatically. In Moodle 3.6 (MDL-55449) courseid will be fully mandatory
325 for all messages sent.
326* The send_confirmation_email() function has a new optional parameter $confirmationurl to provide a different confirmation URL.
327* Introduced a new hook for plugin developers:
328 - <component>_course_module_background_deletion_recommended()
329 This hook should be used in conjunction with the existing '<component>_pre_course_module_delete($mod)'. It must
330 return a boolean and is called by core to check whether a plugin's implementation of
331 <component>_pre_course_module_deleted($mod) will take a long time. A plugin should therefore only implement this
332 function if it also implements <component>_pre_course_module_delete($mod).
333 An example in current use is recyclebin, which performs what can be a lengthy backup process in
334 tool_recyclebin_pre_course_module_delete. The recyclebin, if enabled, now returns true in its implementation of
335 tool_recyclebin_course_module_background_deletion_recommended(), to indicate to core that the deletion (and
336 execution of tool_recyclebin_pre_course_module_delete) should be handled with an adhoc task, meaning it will not
337 occur in real time.
338
339=== 3.1 ===
340
341* Webservice function core_course_search_courses accepts a new parameter 'limittoenrolled' to filter the results
342 only to courses the user is enrolled in, and are visible to them.
343* External functions that are not calling external_api::validate_context are buggy and will now generate
344 exceptions. Previously they were only generating warnings in the webserver error log.
345 See https://docs.moodle.org/dev/External_functions_API#Security
346* The moodle/blog:associatecourse and moodle/blog:associatemodule capabilities has been removed.
347* The following functions has been finally deprecated and can not be used any more:
348 - profile_display_badges()
349 - useredit_shared_definition_preferences()
350 - calendar_normalize_tz()
351 - get_user_timezone_offset()
352 - get_timezone_offset()
353 - get_list_of_timezones()
354 - calculate_user_dst_table()
355 - dst_changes_for_year()
356 - get_timezone_record()
357 - test_get_list_of_timezones()
358 - test_get_timezone_offset()
359 - test_get_user_timezone_offset()
360* The google api library has been updated to version 1.1.7. There was some important changes
361 on the SSL handling. Now the SSL version will be determined by the underlying library.
362 For more information see https://github.com/google/google-api-php-client/pull/644
363* The get_role_users() function will now add the $sort fields that are not part
364 of the requested fields to the query result and will throw a debugging message
365 with the added fields when that happens.
366* The core_user::fill_properties_cache() static method has been introduced to be a reference
367 and allow standard user fields data validation. Right now only type validation is supported
368 checking it against the parameter (PARAM_*) type of the target user field. MDL-52781 is
369 going to add support to null/not null and choices validation, replacing the existing code to
370 validate the user fields in different places in a common way.
371* Webservice function core_course_search_courses now returns results when the search string
372 is less than 2 chars long.
373* Webservice function core_course_search_courses accepts a new parameter 'requiredcapabilities' to filter the results
374 by the capabilities of the current user.
375* New mform element 'course' handles thousands of courses with good performance and usability.
376* The redirect() function will now redirect immediately if output has not
377 already started. Messages will be displayed on the subsequent page using
378 session notifications. The type of message output can be configured using the
379 fourth parameter to redirect().
380* The specification of extra classes in the $OUTPUT->notification()
381 function, and \core\output\notification renderable have been deprecated
382 and will be removed in a future version.
383 Notifications should use the levels found in \core\output\notification.
384* The constants for NOTIFY_PROBLEM, NOTIFY_REDIRECT, and NOTIFY_MESSAGE in
385 \core\output\notification have been deprecated in favour of NOTIFY_ERROR,
386 NOTIFY_WARNING, and NOTIFY_INFO respectively.
387* The following functions, previously used (exclusively) by upgrade steps are not available
388 anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
389 - upgrade_mysql_fix_unsigned_and_lob_columns()
390 - upgrade_course_completion_remove_duplicates()
391 - upgrade_save_orphaned_questions()
392 - upgrade_rename_old_backup_files_using_shortname()
393 - upgrade_mssql_nvarcharmax()
394 - upgrade_mssql_varbinarymax()
395 - upgrade_fix_missing_root_folders()
396 - upgrade_course_modules_sequences()
397 - upgrade_grade_item_fix_sortorder()
398 - upgrade_availability_item()
399* A new parameter $ajaxformdata was added to the constructor for moodleform. When building a
400 moodleform in a webservice or ajax script (for example using the new fragments API) we
401 cannot allow the moodleform to parse it's own data from _GET and _POST - we must pass it as
402 an array.
403* Plugins can extend the navigation for user by declaring the following callback:
404 <frankenstyle>_extend_navigation_user(navigation_node $parentnode, stdClass $user,
405 context_user $context, stdClass $course,
406 context_course $coursecontext)
407* The function notify() now throws a debugging message - see MDL-50269.
408* Ajax calls going through lib/ajax/* now validate the return values before sending
409 the response. If the validation does not pass an exception is raised. This behaviour
410 is consistent with web services.
411* Several changes in Moodle core, standard plugins and third party libraries to
412 ensure compatibility with PHP7. All plugins are recommended to perform testing
413 against PHP7 as well. Refer to https://docs.moodle.org/dev/Moodle_and_PHP7 for more
414 information. The following changes may affect you:
415 * Class moodleform, moodleform_mod and some module classes have been changed to use
416 __construct() for the constructor. Calling parent constructors by the class
417 name will display debugging message. Incorrect: parent::moodleform(),
418 correct: parent::__construct()
419 * All form elements have also changed the constructor syntax. No changes are
420 needed for using form elements, however if plugin defines new form element it
421 needs to use correct syntax. For example, incorrect: parent::HTML_QuickForm_input(),
422 HTML_QuickForm_input::HTML_QuickForm_input(), $this->HTML_QuickForm_input().
423 Correct: HTML_QuickForm_input::__construct() or parent::__construct().
424 * profile_field_base::profile_field_base() is deprecated, use parent::__construct()
425 in custom profile fields constructors. Similar deprecations in exsiting
426 profile_field_* classes.
427 * user_filter_type::user_filter_type() is deprecated, use parent::__construct() in
428 custom user filters. Similar deprecations in existing user_filter_* classes.
429 * table_default_export_format_parent::table_default_export_format_parent() is
430 deprecated, use parent::__construct() in extending classes.
431* groups_delete_group_members() $showfeedback parameter has been removed and is no longer
432 respected. Users of this function should output their own feedback if required.
433* Number of changes to Tags API, see tag/upgrade.txt for more details
434* The previous events API handlers are being deprecated in favour of events 2 API, debugging messages are being displayed if
435 there are 3rd party plugins using it. Switch to events 2 API please, see https://docs.moodle.org/dev/Event_2#Event_dispatching_and_observers
436 Note than you will need to bump the plugin version so moodle is aware that you removed the plugin's event handlers.
437* mforms validation functions are not available in the global JS namespace anymore, event listeners
438 are assigned to fields and buttons through a self-contained JS function.
439* Added $CFG->urlrewriteclass option to config.php allowing clean / semantic urls to
440 be implemented in a plugin, eg local_cleanurls.
441* $CFG->pathtoclam global setting has been moved to clamav antivirus plugin setting of the same name.
442* clam_message_admins() and get_clam_error_code() have been deprecated, its functionality
443 is now a part of \antivirus_clamav\scanner class methods.
444* \repository::antivir_scan_file() has been deprecated, \core\antivirus\manager::scan_file() that
445 applies antivirus plugins is replacing its functionality.
446* Added core_text::str_max_bytes() which safely truncates multi-byte strings to a maximum number of bytes.
447* Zend Framework has been removed completely.
448* Any plugin can report when a scale is being used with the callback function [pluginname]_scale_used_anywhere(int $scaleid).
449* Changes in file_rewrite_pluginfile_urls: Passing a new option reverse = true in the $options var will make the function to convert
450 actual URLs in $text to encoded URLs in the @@PLUGINFILE@@ form.
451* behat_util::is_server_running() is removed, please use behat_util::check_server_status() instead.
452* Behat\Mink\Selector\SelectorsHandler::xpathLiteral() method is deprecated use behat_context_helper::escape instead
453 when building Xpath, or pass the unescaped value when using the named selector.',
454* table_sql download process is using the new data formats plugin which you can't use if you are buffering any output
455 * flexible_table::get_download_menu(), considered private, has been deleted. Use
456 $OUTPUT->download_dataformat_selector() instead.
457 when building Xpath, or pass the unescaped value when using the named selector.
458* Add new file_is_executable(), to consistently check for executables even in Windows (PHP bug #41062).
459* Introduced new hooks for plugin developers.
460 - <component>_pre_course_category_delete($category)
461 - <component>_pre_course_delete($course)
462 - <component>_pre_course_module_delete($cm)
463 - <component>_pre_block_delete($instance)
464 - <component>_pre_user_delete($user)
465 These hooks allow developers to use the item in question before it is deleted by core. For example, if your plugin is
466 a module (plugins located in the mod folder) called 'xxx' and you wish to interact with the user object before it is
467 deleted then the function to create would be mod_xxx_pre_user_delete($user) in mod/xxx/lib.php.
468* pear::Net::GeoIP has been removed.
469
470=== 3.0 ===
471
472* Minify updated to 2.2.1
473* htmlpurifier upgraded to 4.7.0
474* Less.php upgraded to 1.7.0.9
475* The horde library has been updated to version 5.2.7.
476* Google libraries (lib/google) updated to 1.1.5
477* Html2Text library has been updated to the latest version of the library.
478* External functions x_is_allowed_from_ajax() methods have been deprecated. Define 'ajax' => true in db/services.php instead.
479* External functions can be called without a session if they define 'loginrequired' => true in db/services.php.
480* All plugins are required to declare their frankenstyle component name via
481 the $plugin->component property in their version.php file. See
482 https://docs.moodle.org/dev/version.php for details (MDL-48494).
483* PHPUnit is upgraded to 4.7. Some tests using deprecated assertions etc may need changes to work correctly.
484* Users of the text editor API to manually create a text editor should call set_text before calling use_editor.
485* Javascript - SimpleYUI and the Y instance used for modules have been merged. Y is now always the same instance of Y.
486* get_referer() has been deprecated, please use the get_local_referer function instead.
487* \core\progress\null is renamed to \core\progress\none for improved PHP7 compatibility as null is a reserved word (see MDL-50453).
488* \webservice_xmlrpc_client now respects proxy server settings. If your XMLRPC server is available on your local network and not via your proxy server, you may need to add it to the list of proxy
489 server exceptions in $CFG->proxybypass. See MDL-39353 for details.
490* Group and groupings idnumbers can now be passed to and/or are returned from the following web services functions:
491 ** core_group_external::create_groups
492 ** core_group_external::get_groups
493 ** core_group_external::get_course_groups
494 ** core_group_external::create_groupings
495 ** core_group_external::update_groupings
496 ** core_group_external::get_groupings
497 ** core_group_external::get_course_groupings
498 ** core_group_external::get_course_user_groups
499* Following functions are removed from core. See MDL-50049 for details.
500 password_compat_not_supported()
501 session_get_instance()
502 session_is_legacy()
503 session_kill_all()
504 session_touch()
505 session_kill()
506 session_kill_user()
507 session_set_user()
508 session_is_loggedinas()
509 session_get_realuser()
510 session_loginas()
511 js_minify()
512 css_minify_css()
513 update_login_count()
514 reset_login_count()
515 check_gd_version()
516 update_log_display_entry()
517 get_recent_enrolments()
518 groups_filter_users_by_course_module_visible()
519 groups_course_module_visible()
520 error()
521 formerr()
522 editorhelpbutton()
523 editorshortcutshelpbutton()
524 choose_from_menu()
525 update_event()
526 get_generic_section_name()
527 get_all_sections()
528 add_mod_to_section()
529 get_all_mods()
530 get_course_section()
531 format_weeks_get_section_dates()
532 get_print_section_cm_text()
533 print_section_add_menus()
534 make_editing_buttons()
535 print_section()
536 print_overview()
537 print_recent_activity()
538 delete_course_module()
539 update_category_button()
540 make_categories_list()
541 category_delete_move()
542 category_delete_full()
543 move_category()
544 course_category_hide()
545 course_category_show()
546 get_course_category()
547 create_course_category()
548 get_all_subcategories()
549 get_child_categories()
550 get_categories()
551 print_course_search()
552 print_my_moodle()
553 print_remote_course()
554 print_remote_host()
555 print_whole_category_list()
556 print_category_info()
557 get_course_category_tree()
558 print_courses()
559 print_course()
560 get_category_courses_array()
561 get_category_courses_array_recursively()
562 blog_get_context_url()
563 get_courses_wmanagers()
564 convert_tree_to_html()
565 convert_tabrows_to_tree()
566 can_use_rotated_text()
567 get_parent_contexts()
568 get_parent_contextid()
569 get_child_contexts()
570 create_contexts()
571 cleanup_contexts()
572 build_context_path()
573 rebuild_contexts()
574 preload_course_contexts()
575 context_moved()
576 fetch_context_capabilities()
577 context_instance_preload()
578 get_contextlevel_name()
579 print_context_name()
580 mark_context_dirty()
581 delete_context()
582 get_context_url()
583 get_course_context()
584 get_user_courses_bycap()
585 get_role_context_caps()
586 get_courseid_from_context()
587 context_instance_preload_sql()
588 get_related_contexts_string()
589 get_plugin_list_with_file()
590 check_browser_operating_system()
591 check_browser_version()
592 get_device_type()
593 get_device_type_list()
594 get_selected_theme_for_device_type()
595 get_device_cfg_var_name()
596 set_user_device_type()
597 get_user_device_type()
598 get_browser_version_classes()
599 generate_email_supportuser()
600 badges_get_issued_badge_info()
601 can_use_html_editor()
602 enrol_cohort_get_cohorts()
603 enrol_cohort_can_view_cohort()
604 cohort_get_visible_list()
605 enrol_cohort_enrol_all_users()
606 enrol_cohort_search_cohorts()
607* The never unused webdav_locks table was dropped.
608* The actionmenu hideMenu() function now expects an EventFacade object to be passed to it,
609 i.e. a call to M.core.actionmenu.instance.hideMenu() should be change to M.core.actionmenu.instance.hideMenu(e)
610* In the html_editors (tinyMCE, Atto), the manage files button can be hidden by changing the 'enable_filemanagement' option to false.
611* external_api::validate_context now is public, it can be called from other classes.
612* rss_error() now supports returning of correct HTTP status of error and will return '404 Not Found'
613 unless other status is specified.
614* Plugins can extend the navigation for categories settings by declaring the following callback:
615 <frankenstyle>_extend_navigation_category_settings(navigation_node, context_coursecat)
616* The clilib.php provides two new functions cli_write() and cli_writeln() that should be used for outputting texts from the command
617 line interface scripts.
618* External function core_course_external::get_course_contents returned parameter "name" has been changed to PARAM_RAW,
619 this is because the new external_format_string function may return raw data if the global moodlewssettingraw parameter is used.
620* Function is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.
621
622=== 2.9.1 ===
623
624* New methods grade_grade::get_grade_max() and get_grade_min() must be used rather than directly the public properties rawgrademax and rawgrademin.
625* New method grade_item::is_aggregate_item() indicates when a grade_item is an aggreggated type grade.
626
627=== 2.9 ===
628
629* The default home page for users has been changed to the dashboard (formely my home). See MDL-45774.
630* Support for rendering templates from php or javascript has been added. See MDL-49152.
631* Support for loading AMD javascript modules has been added. See MDL-49046.
632* Webservice core_course_delete_courses now return warning messages on any failures and does not try to rollback the entire deletion.
633* \core\event\course_viewed 'other' argument renamed from coursesectionid to coursesectionnumber as it contains the section number.
634* New API core_filetypes::add_type (etc.) allows custom filetypes to be added and modified.
635* PHPUnit: PHPMailer Sink is now started for all tests and is setup within the phpunit wrapper for advanced tests.
636 Catching debugging messages when sending mail will no longer work. Use $sink = $this->redirectEmails(); and then check
637 the message in the sink instead.
638* The file pluginlib.php was deprecated since 2.6 and has now been removed, do not include or require it.
639* \core_component::fetch_subsystems() now returns a valid path for completion component instead of null.
640* Deprecated JS global methods have been removed (show_item, destroy_item, hide_item, addonload, getElementsByTagName, findChildNodes).
641* For 3rd party plugin specific environment.xml files, it's now possible to specify version independent checks by using the
642 <PLUGIN name="component_name"> tag instead of the version dependent <MOODLE version="x.y"> one. If the PLUGIN tag is used any
643 Moodle specific tags will be ignored.
644* html_table: new API for adding captions to tables (new field, $table->caption) and subsequently hiding said captions from sighted users using accesshide (enabled using $table->captionhide).
645* The authorization procedure in the mdeploy.php script has been improved. The script
646 now relies on the main config.php when deploying an available update.
647* sql_internal_reader and sql_select_reader interfaces have been deprecated in favour of sql_internal_table_reader
648 and sql_reader which use iterators to be more memory efficient.
649* $CFG->enabletgzbackups setting has been removed as now backups are stored internally using .tar.gz format by default, you can
650 set $CFG->usezipbackups to store them in zip format. This does not affect the restore process, which continues accepting both.
651* Added support for custom string manager implementations via $CFG->customstringmanager
652 directive in the config.php. See MDL-49361 for details.
653* Add new make_request_directory() for creation of per-request files.
654* Added generate_image_thumbnail_from_string. This should be used instead of generate_image_thumbnail when the source is a string.
655 This prevents the need to write files to disk unnecessarily.
656* Added generate_image_thumbnail to stored_file class. This should be used when generating thumbnails for stored files.
657 This prevents the need to write files to disk unnecessarily.
658* Removed pear/HTTP/WebDav. See MDL-49534 for details.
659* Use standard PHP date time classes and methods - see new core_date class for timezone normalisation methods.
660* Moved lib/google/Google/ to lib/google/src/Google. This is to address autoloader issues with Google's provided autoloader
661 for the library. See MDL-49519 for details.
662* The outdated lib/google/Google_Client.php and related files have been completely removed. To use
663 the new client, read lib/google/readme_moodle.txt, please.
664* profile_display_badges() has been deprecated. See MDL-48935 for details.
665* Added a new method add_report_nodes() to pagelib.php. If you are looking to add links to the user profile page under the heading "Reports"
666 then please use this function to ensure that the breadcrumb and navigation block are created properly for all user profile pages.
667* process_new_icon() now does not always return a PNG file. When possible, it will try to keep the format of the original file.
668 Set the new argument $preferpng to true to force PNG. See MDL-46763 and MDL-50041 for details.
669
670=== 2.8 ===
671
672* Gradebook grade category option "aggregatesubcats" has been removed completely.
673 This means that the database column is removed, the admin settings are removed and
674 the properties from the grade_category object have been removed. If any courses were
675 found to be using this setting, a warning to check the grades will be shown in the
676 course grader report after upgrading the site. The same warning will be shown on
677 courses restored from backup that had this setting enabled (see MDL-47503).
678* lib/excelllib.class.php has been updated. The class MoodleExcelWorkbook will now only produce excel 2007 files.
679* renderers: We now remove the suffix _renderable when looking for a render method for a renderable.
680 If you have a renderable class named like "blah_renderable" and have a method on a renderer named "render_blah_renderable"
681 you will need to change the name of your render method to "render_blah" instead, as renderable at the end is no longer accepted.
682* New functions get_course_and_cm_from_cmid($cmorid, $modulename) and
683 get_course_and_cm_from_instance($instanceorid, $modulename) can be used to
684 more efficiently load these basic data objects at the start of a script.
685* New function cm_info::create($cm) can be used when you need a cm_info
686 object, but have a $cm which might only be a standard database record.
687* $CFG->enablegroupmembersonly no longer exists.
688* Scheduled tasks have gained support for syntax to introduce variability when a
689 task will run across installs. When a when hour or minute are defined as 'R'
690 they will be installed with a random hour/minute value.
691* Several classes grade_edit_tree_column_xxx were removed since grades setup page
692 has been significantly changed. These classes should not be used outside of
693 gradebook or developers can copy them into their plugins from 2.7 branch.
694* Google APIs Client Library (lib/google/) has been upgraded to 1.0.5-beta and
695 API has changed dramatically without backward compatibility. Any code accessing
696 it must be amended. It does not apply to lib/googleapi.php. See MDL-47297
697* Added an extra parameter to the function get_formatted_help_string() (default null) which is used to specify
698 additional string parameters.
699* User settings node and course node in navigation now support callbacks from admin tools.
700* grade_get_grades() optional parameteres $itemtype, $itemmodule, $iteminstance are now required.
701
702DEPRECATIONS:
703* completion_info->get_incomplete_criteria() is deprecated and will be removed in Moodle 3.0.
704* grade_category::aggregate_values() is deprecated and will be removed in Moodle 3.0.
705* groups_filter_users_by_course_module_visible() is deprecated; replace with
706 core_availability\info::filter_user_list. Will be removed in Moodle 3.0.
707* groups_course_module_visible() is deprecated; replace with $cm->uservisible.
708* cm_info property $cm->groupmembersonly is deprecated and always returns 0.
709 Use core_availability\info::filter_user_list if trying to determine which
710 other users can see an activity.
711* cm_info method $cm->is_user_access_restricted_by_group() is deprecated and
712 always returns false. Use $cm->uservisible to determine whether the user can
713 access the activity.
714* Constant FEATURE_GROUPMEMBERSONLY (used in module _supports functions) is
715 deprecated.
716* cohort_get_visible_list() is deprecated. There is a better function cohort_get_available_cohorts()
717 that respects user capabilities to view cohorts.
718* enrol_cohort_get_cohorts() and enrol_cohort_search_cohorts() are deprecated since
719 functionality is removed. Please use cohort_get_available_cohorts()
720* enrol_cohort_enrol_all_users() is deprecated; enrol_manual is now responsible for this action
721* enrol_cohort_can_view_cohort() is deprecated; replace with cohort_can_view_cohort()
722
723=== 2.6.4 / 2.7.1 ===
724
725* setnew_password_and_mail() and update_internal_user_password() will trigger
726 \core\event\user_password_updated. Previously they used to generate
727 \core\event\user_updated event.
728* update_internal_user_password() accepts optional boolean $fasthash for fast
729 hashing.
730* user_update_user() and user_create_user() api's accept optional param
731 $triggerevent to avoid respective events to be triggred from the api's.
732
733=== 2.7 ===
734
735* PHPUnit cannot be installed via PEAR any more, please use composer package manager instead.
736* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
737
738Events and Logging:
739* Significant changes in Logging API. For upgrading existing events_trigger() and
740 add_to_log() see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins
741 For accessing logs from plugins see http://docs.moodle.org/dev/Migrating_log_access_in_reports
742* The validation of the following events is now stricter (see MDL-45445):
743 - \core\event\blog_entry_created
744 - \core\event\blog_entry_deleted
745 - \core\event\blog_entry_updated
746 - \core\event\cohort_member_added
747 - \core\event\cohort_member_removed
748 - \core\event\course_category_deleted
749 - \core\event\course_completed
750 - \core\event\course_content_deleted
751 - \core\event\course_created
752 - \core\event\course_deleted
753 - \core\event\course_restored
754 - \core\event\course_section_updated (see MDL-45229)
755 - \core\event\email_failed
756 - \core\event\group_member_added
757 - \core\event\group_member_removed
758 - \core\event\note_created
759 - \core\event\note_deleted
760 - \core\event\note_updated
761 - \core\event\role_assigned
762 - \core\event\role_deleted
763 - \core\event\role_unassigned
764 - \core\event\user_graded
765 - \core\event\user_loggedinas
766 - \core\event\user_profile_viewed
767 - \core\event\webservice_token_created
768
769DEPRECATIONS:
770* $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
771* Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
772* Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
773* Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
774* mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
775* mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
776* mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.
777* mod_feedback\event\instances_list_viewed has been deprecated. Please use mod_feedback\event\course_module_instance_list_viewed instead.
778* mod_page\event\instances_list_viewed has been deprecated. Please use mod_page\event\course_module_instance_list_viewed instead.
779* The constants FRONTPAGECOURSELIST, FRONTPAGETOPICONLY & FRONTPAGECOURSELIMIT have been removed.
780* Conditional availability API has moved and changed. The condition_info class is
781 replaced by \core_availability\info_module, and condition_info_section by
782 \core_availability\info_section. (Code that uses the old classes will generally
783 still work.)
784* coursemodule_visible_for_user() has been deprecated but still works - replaced
785 by a new static function \core_availability\info_module::is_user_visible()
786* cm_info::is_user_access_restricted_by_conditional_access has been deprecated
787 but still works (it has never done what its name suggests, and is
788 unnecessary).
789* cm_info and section_info property showavailability has been deprecated, but
790 still works (with the caveat that this information is now per-user).
791* cm_info and section_info properties availablefrom and availableuntil have been
792 deprecated and always return zero (underlying data doesn't have these values).
793* section_info property groupingid has been deprecated and always returns zero,
794 same deal.
795* Various cm_info methods have been deprecated in favour of their read-only properties (get_url(), get_content(), get_extra_classes(),
796 get_on_click(), get_custom_data(), get_after_link, get_after_edit_icons)
797* The ajaxenabled function has been deprecated and always returns true. All code should be fully functional in Javascript.
798* count_login_failures() has been deprecated, use user_count_login_failures() instead. Refer MDL-42891 for details.
799
800Conditional availability (activities and sections):
801* New conditional availability API in /availability, including new availability
802 condition plugins in /availability/condition. The new API is very similar with
803 regard to checking availability, but any code that modifies availability settings
804 for an activity or section is likely to need substantial changes.
805
806YUI:
807 * The lightbox attribute for moodle-core-notification-dialogue has been
808 deprecated and replaced by the modal attribute. This was actually
809 changed in Moodle 2.2, but has only been marked as deprecated now. It
810 will be removed in Moodle 2.9.
811 * When destroying any type of dialogue based on moodle-core-notification, the relevant content is also removed from
812 the DOM. Previously it was left orphaned.
813
814JavaSript:
815 * The findChildNodes global function has been deprecated. Y.all should
816 be used instead.
817 * The callback argument to confirm_action and M.util.show_confirm_dialog has been deprecated. If you need to write a
818 confirmation which includes a callback, please use moodle-core-notification-confirmation and attach callbacks to the
819 events provided.
820
821* New locking api and admin settings to configure the system locking type.
822* New "Time spent waiting for the database" performance metric displayed along with the
823 other MDL_PERF vars; the change affects both the error logs and the vars displayed in
824 the page footer.
825* Changes in the tag API. The component and contextid are now saved when assigning tags to an item. Please see
826 tag/upgrade.txt for more information.
827
828=== 2.6 ===
829
830* Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
831 get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
832 get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
833 exactly the same, the only differences are that core_component::get_plugin_types() now always returns
834 full paths and core_component::get_plugin_list() does not accept empty parameter any more.
835* Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
836* Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
837* New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
838* MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
839 this change should be fully transparent and it should help significantly with add-on compatibility.
840* The string manager classes were renamed. Note that they should not be modified or used directly,
841 always use get_string_manager() to get instance of the string manager.
842* The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
843* Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
844* Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
845* Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
846* Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
847 behat_command::$allowedtextselectors and behat_command::$allowedselectors
848* Subplugins are supported in admin tools and local plugins.
849* file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
850 to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
851 function that returns an approximate number of entries in the zip faster than the count() function.
852* Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
853* Class course_modinfo no longer extends stdClass. All properties are read-only.
854* Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
855 is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
856 get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
857 If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
858 object.
859* Internal (noreply and support) user support has been added for sending/receiving message.
860 Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
861 Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
862* New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
863* Use core_plugin_manager::reset_caches() when changing visibility of plugins.
864* Implement new method get_enabled_plugins() method in subplugin info classes.
865* Each plugin should include version information in version.php.
866* Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
867* $USER->password field is intentionally unset so that session data does not contain password hashes.
868* Use core_shutdown_manager::register_function() instead of register_shutdown_function().
869* New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
870 for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
871 backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
872* New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
873 of 'fopen' to read gzip-compressed files if required.
874* update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
875* Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
876* New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
877 should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
878 dialogue.
879* $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
880 to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
881* Date format locale charset for windows server will come from calendar type and for gregorian it will use
882 lang file.
883* The library to interact with Box.net (class boxclient) is only compatible with their APIv1 which
884 reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
885 new class boxnet_client(). Note that the method names and return values have changed.
886* Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
887 work properly will need to set their requires version to a number that is equal to or grater than the 2.6.1 release version.
888* The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
889 test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
890 update your code.
891
892DEPRECATIONS:
893Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
894and will be removed in a future release (target: 2.8), a summary follows:
895
896Accesslib:
897 * get_context_instance() -> context_xxxx::instance()
898 * get_context_instance_by_id() -> context::instance_by_id($id)
899 * get_system_context() -> context_system::instance()
900 * context_moved() -> context::update_moved()
901 * preload_course_contexts() -> context_helper::preload_course()
902 * context_instance_preload() -> context_helper::preload_from_record()
903 * context_instance_preload_sql() -> context_helper::get_preload_record_columns_sql()
904 * get_contextlevel_name() -> context_helper::get_level_name()
905 * create_contexts() -> context_helper::create_instances()
906 * cleanup_contexts() -> context_helper::cleanup_instances()
907 * build_context_path() -> context_helper::build_all_paths()
908 * print_context_name() -> $context->get_context_name()
909 * mark_context_dirty() -> $context->mark_dirty()
910 * delete_context() -> $context->delete_content() or context_helper::delete_instance()
911 * get_context_url() -> $context->get_url()
912 * get_course_context() -> $context->get_course_context()
913 * get_parent_contexts() -> $context->get_parent_context_ids()
914 * get_parent_contextid() -> $context->get_parent_context()
915 * get_child_contexts() -> $context->get_child_contexts()
916 * rebuild_contexts() -> $context->reset_paths()
917 * get_user_courses_bycap() -> enrol_get_users_courses()
918 * get_courseid_from_context() -> $context->get_course_context(false)
919 * get_role_context_caps() -> (no replacement)
920 * load_temp_role() -> (no replacement)
921 * remove_temp_roles() -> (no replacement)
922 * get_related_contexts_string() -> $context->get_parent_context_ids(true)
923 * get_recent_enrolments() -> (no replacement)
924
925Enrollment:
926 * get_course_participants() -> get_enrolled_users()
927 * is_course_participant() -> is_enrolled()
928
929Output:
930 * current_theme() -> $PAGE->theme->name
931 * skip_main_destination() -> $OUTPUT->skip_link_target()
932 * print_container() -> $OUTPUT->container()
933 * print_container_start() -> $OUTPUT->container_start()
934 * print_container_end() -> $OUTPUT->container_end()
935 * print_continue() -> $OUTPUT->continue_button()
936 * print_header() -> $PAGE methods
937 * print_header_simple() -> $PAGE methods
938 * print_side_block() -> $OUTPUT->block()
939 * print_arrow() -> $OUTPUT->arrow()
940 * print_scale_menu_helpbutton() -> $OUTPUT->help_icon_scale($courseid, $scale)
941 * print_checkbox() -> html_writer::checkbox()
942
943Navigation:
944 * print_navigation() -> $OUTPUT->navbar()
945 * build_navigation() -> $PAGE->navbar methods
946 * navmenu() -> (no replacement)
947 * settings_navigation::
948 get_course_modules() -> (no replacement)
949
950Files and repositories:
951 * stored_file::replace_content_with() -> stored_file::replace_file_with()
952 * stored_file::set_filesize() -> stored_file::replace_file_with()
953 * stored_file::get_referencelifetime() -> (no replacement)
954 * repository::sync_external_file() -> see repository::sync_reference()
955 * repository::get_file_by_reference() -> repository::sync_reference()
956 * repository::
957 get_reference_file_lifetime() -> (no replacement)
958 * repository::sync_individual_file() -> (no replacement)
959 * repository::reset_caches() -> (no replacement)
960
961Calendar:
962 * add_event() -> calendar_event::create()
963 * update_event() -> calendar_event->update()
964 * delete_event() -> calendar_event->delete()
965 * hide_event() -> calendar_event->toggle_visibility(false)
966 * show_event() -> calendar_event->toggle_visibility(true)
967
968Misc:
969 * filter_text() -> format_text(), format_string()...
970 * httpsrequired() -> $PAGE->https_required()
971 * detect_munged_arguments() -> clean_param([...], PARAM_FILE)
972 * mygroupid() -> groups_get_all_groups()
973 * js_minify() -> core_minify::js_files()
974 * css_minify_css() -> core_minify::css_files()
975 * course_modinfo::build_section_cache() -> (no replacement)
976 * generate_email_supportuser() -> core_user::get_support_user()
977
978Sessions:
979 * session_get_instance()->xxx() -> \core\session\manager::xxx()
980 * session_kill_all() -> \core\session\manager::kill_all_sessions()
981 * session_touch() -> \core\session\manager::touch_session()
982 * session_kill() -> \core\session\manager::kill_session()
983 * session_kill_user() -> \core\session\manager::kill_user_sessions()
984 * session_gc() -> \core\session\manager::gc()
985 * session_set_user() -> \core\session\manager::set_user()
986 * session_is_loggedinas() -> \core\session\manager::is_loggedinas()
987 * session_get_realuser() -> \core\session\manager::get_realuser()
988 * session_loginas() -> \core\session\manager::loginas()
989
990User-agent related functions:
991 * check_browser_operating_system() -> core_useragent::check_browser_operating_system()
992 * check_browser_version() -> core_useragent::check_browser_version()
993 * get_device_type() -> core_useragent::get_device_type()
994 * get_device_type_list() -> core_useragent::get_device_type_list()
995 * get_selected_theme_for_device_type() -> core_useragent::get_device_type_theme()
996 * get_device_cfg_var_name() -> core_useragent::get_device_type_cfg_var_name()
997 * set_user_device_type() -> core_useragent::set_user_device_type()
998 * get_user_device_type() -> core_useragent::get_user_device_type()
999 * get_browser_version_classes() -> core_useragent::get_browser_version_classes()
1000
1001YUI:
1002 * moodle-core-notification has been deprecated with a recommendation of
1003 using its subclasses instead. This is to allow for reduced page
1004 transport costs. Current subclasses include:
1005 * dialogue
1006 * alert
1007 * confirm
1008 * exception
1009 * ajaxexception
1010
1011Event triggering and event handlers:
1012 * All existing events and event handlers should be replaced by new
1013 event classes and matching new event observers.
1014 * See http://docs.moodle.org/dev/Event_2 for more information.
1015 * The following events will be entirely removed, though they can still
1016 be captured using handlers, but they should not be used any more.
1017 * groups_members_removed -> \core\event\group_member_removed
1018 * groups_groupings_groups_removed -> (no replacement)
1019 * groups_groups_deleted -> \core\event\group_deleted
1020 * groups_groupings_deleted -> \core\event\grouping_deleted
1021 * edit_module_post_actions() does not trigger events any more.
1022
1023=== 2.5.1 ===
1024
1025* New get_course() function for use when obtaining the course record from database. Will
1026 reuse existing $COURSE or $SITE globals if possible to improve performance.
1027
1028=== 2.5 ===
1029
1030* The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
1031 for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
1032 apply for that change.
1033* The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
1034 so any custom utility relying on the old output may require modification.
1035* Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
1036 "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
1037 an option for 0 bytes. Existing code that was replacing the 0 option in the return
1038 from this function with a more sensible message, can now use the return from this function directly.
1039* Functions responsible for output in course/lib.php are deprecated, the code is moved to
1040 appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
1041 make_editing_buttons()
1042 See functions' phpdocs in lib/deprecatedlib.php
1043* Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
1044* zip_packer may create empty zip archives, there is a new option to ignore
1045 problematic files when creating archive
1046* The function delete_course_module was deprecated and has been replaced with
1047 course_delete_module. The reason for this was because the function delete_course_module
1048 only partially deletes data, so wherever it was called extra code was needed to
1049 perform the whole deletion process. The function course_delete_module now takes care
1050 of the whole process.
1051* curl::setopt() does not accept constant values any more. As it never worked properly,
1052 we decided to make the type check stricter. Now, the keys of the array pass must be a string
1053 corresponding to the curl constant name.
1054* Function get_users_listing now return list of users except guest and deleted users. Previously
1055 deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
1056 and not included in get_user function, it will not be returned by get_users_listing.
1057* The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
1058 MODNAME_dndupload_register callback instead.
1059* The signature of the add() method of classes implementing the parentable_part_of_admin_tree
1060 interface (such as admin_category) has been extended. The new parameter allows the caller
1061 to prepend the new node before an existing sibling in the admin tree.
1062* condition_info:get_condition_user_fields($formatoptions) now accepts the optional
1063 param $formatoptions, that will determine if the field names are processed by
1064 format_string() with the passed options.
1065* remove all references to $CFG->gdversion, GD PHP extension is now required
1066* Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
1067 need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
1068* Functions responsible for managing and accessing course categories are moved to class coursecat
1069 in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
1070 moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
1071 category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
1072 course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
1073 get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
1074 print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
1075 print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
1076 get_courses_wmanagers()
1077 See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1078* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
1079* Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
1080 functions to get information for only active (excluding suspended enrolments) users. Included two
1081 helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
1082* The core_plugin_manager class now provides two new helper methods for getting information
1083 about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
1084* The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
1085 to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
1086 to control the availability of the 'Uninstall' link at the Plugins overview page (previously
1087 they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
1088 uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
1089 plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
1090 satisfy all plugin types.
1091
1092Database (DML) layer:
1093* $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
1094 please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
1095* Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
1096 Please note that internally we create indexes instead of foreign keys.
1097
1098YUI changes:
1099* M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
1100 instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
1101 that your help link is placed in a span which has the class 'helplink'.
1102
1103=== 2.4 ===
1104
1105* Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
1106 and page_generic_activity.
1107* use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
1108* Function settings_navigation::add_course_editing_links() is completely removed
1109* function global_navigation::format_display_course_content() is removed completely (the
1110 functionality is moved to course format class)
1111* in the function global_navigation::load_generic_course_sections() the argument $courseformat is
1112 removed
1113* New component and itemid columns in groups_members table - this allows plugin to create protected
1114 group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
1115 callback 'xx_yy_restore_group_member()'.
1116* New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
1117* functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
1118 are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
1119
1120YUI changes:
1121* moodle-enrol-notification has been renamed to moodle-core-notification
1122* YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
1123* M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
1124 to use moodle-core-formautosubmit
1125
1126Unit testing changes:
1127* output debugging() is not sent to standard output any more,
1128 use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
1129 $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
1130
1131=== 2.3 ===
1132
1133Database layer changes:
1134* objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
1135
1136Note:
1137* DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
1138debug messages and will produce fatal errors
1139
1140API changes:
1141
1142* send_stored_file() has changed its interface
1143* deleted several resourcelib_embed_* functions from resourcelib.php
1144
1145=== 2.2 ===
1146
1147removed unused libraries:
1148* odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
1149
1150API changes:
1151* new admin/tool plugin type
1152* new context API - old API is still available
1153* deleted users do not have context any more
1154* removed global search
1155
1156
1157=== 2.1 ===
1158
1159API changes:
1160* basic suport for restore from 1.9
1161* new mobile devices API
1162* new questions API
1163
1164
1165=== 2.0 ===
1166
1167API changes:
1168* new DML API - http://docs.moodle.org/dev/DML_functions
1169* new DDL API - http://docs.moodle.org/dev/DDL_functions
1170* new file API - http://docs.moodle.org/dev/File_API
1171* new $PAGE and $OUTPUT API
1172* new navigation API
1173* new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
1174* new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
1175* new portfolio API
1176* new local plugin type
1177* new translation support - http://lang.moodle.org
1178* new web service API
1179* new cohorts API
1180* new messaging API
1181* new rating API
1182* new comment API
1183* new sessions API
1184* new enrolment API
1185* new backup/restore API
1186* new blocks API
1187* new filters API
1188* improved plugin support (aka Frankenstyle)
1189* new registration and hub API
1190* new course completion API
1191* new plagiarism API
1192* changed blog API
1193* new text editor API
1194* new my moodle and profiles API