2013-03-15 00:59:26 +01:00
|
|
|
This files describes API changes in core libraries and APIs,
|
2011-10-30 09:28:20 +01:00
|
|
|
information provided here is intended especially for developers.
|
|
|
|
|
|
2012-12-14 11:32:21 +08:00
|
|
|
=== 2.5 ===
|
|
|
|
|
|
2013-03-12 16:08:49 +01:00
|
|
|
* The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
|
|
|
|
|
so any custom utility relying on the old output may require modification.
|
2013-01-21 14:36:57 +08:00
|
|
|
* Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
|
|
|
|
|
"Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
|
|
|
|
|
an option for 0 bytes. Existing code that was replacing the 0 option in the return
|
|
|
|
|
from this function with a more sensible message, can now use the return from this function directly.
|
2012-12-14 11:32:21 +08:00
|
|
|
* Functions responsible for output in course/lib.php are deprecated, the code is moved to
|
|
|
|
|
appropriate renderers: print_section_add_menus()
|
|
|
|
|
See functions' phpdocs in lib/deprecatedlib.php
|
|
|
|
|
* Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
|
2013-01-15 20:45:36 +01:00
|
|
|
* zip_packer may create empty zip archives, there is a new option to ignore
|
|
|
|
|
problematic files when creating archive
|
2013-01-23 15:48:50 +08:00
|
|
|
* The function delete_course_module was deprecated and has been replaced with
|
|
|
|
|
course_delete_module. The reason for this was because the function delete_course_module
|
|
|
|
|
only partially deletes data, so wherever it was called extra code was needed to
|
|
|
|
|
perform the whole deletion process. The function course_delete_module now takes care
|
|
|
|
|
of the whole process.
|
2013-02-19 13:01:21 +08:00
|
|
|
* curl::setopt() does not accept constant values any more. As it never worked properly,
|
|
|
|
|
we decided to make the type check stricter. Now, the keys of the array pass must be a string
|
|
|
|
|
corresponding to the curl constant name.
|
2013-03-12 10:00:55 +08:00
|
|
|
* Function get_users_listing now return list of users except guest and deleted users. Previously
|
|
|
|
|
deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
|
|
|
|
|
and not included in get_user function, it will not be returned by get_users_listing.
|
2013-03-19 09:55:39 +08:00
|
|
|
* The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
|
|
|
|
|
MODNAME_dndupload_register callback instead.
|
2013-03-15 00:59:26 +01:00
|
|
|
* The signature of the add() method of classes implementing the parentable_part_of_admin_tree
|
|
|
|
|
interface (such as admin_category) has been extended. The new parameter allows the caller
|
|
|
|
|
to prepend the new node before an existing sibling in the admin tree.
|
2013-03-20 00:09:43 +01:00
|
|
|
* condition_info:get_condition_user_fields($formatoptions) now accepts the optional
|
|
|
|
|
param $formatoptions, that will determine if the field names are processed by
|
|
|
|
|
format_string() with the passed options.
|
2013-03-22 16:51:18 +01:00
|
|
|
* remove all references to $CFG->gdversion, GD PHP extension is now required
|
2013-03-22 16:38:10 +08:00
|
|
|
* Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
|
|
|
|
|
need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
|
2013-02-21 10:37:52 +11:00
|
|
|
* Functions responsible for managing and accessing course categories are moved to class coursecat
|
2013-02-21 10:46:52 +11:00
|
|
|
in lib/coursecatlib.php. The following global functions are deprecated: make_categories_list(),
|
2013-02-21 10:55:35 +11:00
|
|
|
category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
|
2013-02-22 12:24:40 +11:00
|
|
|
course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
|
2013-02-20 20:51:21 +11:00
|
|
|
get_child_categories(), get_categories()
|
2012-12-14 11:32:21 +08:00
|
|
|
|
2012-10-10 11:03:00 +01:00
|
|
|
YUI changes:
|
|
|
|
|
* M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
|
|
|
|
|
instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
|
|
|
|
|
that your help link is placed in a span which has the class 'helplink'.
|
|
|
|
|
|
2012-07-23 13:16:42 +08:00
|
|
|
=== 2.4 ===
|
|
|
|
|
|
|
|
|
|
* Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
|
|
|
|
|
and page_generic_activity.
|
2012-08-19 20:07:27 +02:00
|
|
|
* use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
|
2012-09-25 14:42:25 +08:00
|
|
|
* Function settings_navigation::add_course_editing_links() is completely removed
|
2012-09-18 09:57:37 +08:00
|
|
|
* function global_navigation::format_display_course_content() is removed completely (the
|
|
|
|
|
functionality is moved to course format class)
|
|
|
|
|
* in the function global_navigation::load_generic_course_sections() the argument $courseformat is
|
|
|
|
|
removed
|
2012-09-26 17:13:42 +02:00
|
|
|
* New component and itemid columns in groups_members table - this allows plugin to create protected
|
|
|
|
|
group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
|
|
|
|
|
callback 'xx_yy_restore_group_member()'.
|
|
|
|
|
* New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
|
2012-09-26 14:11:41 +08:00
|
|
|
* functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
|
|
|
|
|
are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
|
2011-10-30 09:28:20 +01:00
|
|
|
|
2012-07-07 11:31:55 +01:00
|
|
|
YUI changes:
|
|
|
|
|
* moodle-enrol-notification has been renamed to moodle-core-notification
|
2012-08-14 15:31:52 +08:00
|
|
|
* YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
|
2012-09-21 15:17:22 +01:00
|
|
|
* M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
|
|
|
|
|
to use moodle-core-formautosubmit
|
2012-07-07 11:31:55 +01:00
|
|
|
|
2012-09-17 12:09:25 +02:00
|
|
|
Unit testing changes:
|
|
|
|
|
* output debugging() is not sent to standard output any more,
|
|
|
|
|
use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
|
|
|
|
|
$this->getDebuggingMessages() or $this->assertResetDebugging() instead.
|
|
|
|
|
|
2012-03-17 18:42:30 +01:00
|
|
|
=== 2.3 ===
|
|
|
|
|
|
|
|
|
|
Database layer changes:
|
|
|
|
|
* objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
|
|
|
|
|
|
2012-03-21 09:28:02 +08:00
|
|
|
Note:
|
|
|
|
|
* DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
|
|
|
|
|
debug messages and will produce fatal errors
|
2012-03-17 18:42:30 +01:00
|
|
|
|
2012-04-17 15:05:33 +02:00
|
|
|
API changes:
|
MDL-29624 Media embedding system, part 1: new API and filter changes
Includes new API in medialib.php and core_media_renderer in outputrenderers.php.
Enable/disable settings moved from filter to systemwide appearance page.
Filter changed to use new API.
AMOS BEGIN
MOV [flashanimation,filter_mediaplugin],[flashanimation,core_media]
MOV [flashanimation_help,filter_mediaplugin],[flashanimation_desc,core_media]
MOV [flashvideo,filter_mediaplugin],[flashvideo,core_media]
MOV [flashvideo_help,filter_mediaplugin],[flashvideo_desc,core_media]
MOV [html5audio,filter_mediaplugin],[html5audio,core_media]
MOV [html5audio_help,filter_mediaplugin],[html5audio_desc,core_media]
MOV [html5video,filter_mediaplugin],[html5video,core_media]
MOV [html5video_help,filter_mediaplugin],[html5video_desc,core_media]
MOV [mp3audio,filter_mediaplugin],[mp3audio,core_media]
MOV [mp3audio_help,filter_mediaplugin],[mp3audio_desc,core_media]
MOV [legacyquicktime,filter_mediaplugin],[legacyquicktime,core_media]
MOV [legacyquicktime_help,filter_mediaplugin],[legacyquicktime_desc,core_media]
MOV [legacyreal,filter_mediaplugin],[legacyreal,core_media]
MOV [legacyreal_help,filter_mediaplugin],[legacyreal_desc,core_media]
MOV [legacywmp,filter_mediaplugin],[legacywmp,core_media]
MOV [legacywmp_help,filter_mediaplugin],[legacywmp_desc,core_media]
MOV [legacyheading,filter_mediaplugin],[legacyheading,core_media]
MOV [legacyheading_help,filter_mediaplugin],[legacyheading_desc,core_media]
MOV [sitevimeo,filter_mediaplugin],[sitevimeo,core_media]
MOV [sitevimeo_help,filter_mediaplugin],[sitevimeo_desc,core_media]
MOV [siteyoutube,filter_mediaplugin],[siteyoutube,core_media]
MOV [siteyoutube_help,filter_mediaplugin],[siteyoutube_desc,core_media]
AMOS END
2011-12-13 17:08:34 +00:00
|
|
|
|
2012-04-17 15:05:33 +02:00
|
|
|
* send_stored_file() has changed its interface
|
MDL-29624 Media embedding system, part 1: new API and filter changes
Includes new API in medialib.php and core_media_renderer in outputrenderers.php.
Enable/disable settings moved from filter to systemwide appearance page.
Filter changed to use new API.
AMOS BEGIN
MOV [flashanimation,filter_mediaplugin],[flashanimation,core_media]
MOV [flashanimation_help,filter_mediaplugin],[flashanimation_desc,core_media]
MOV [flashvideo,filter_mediaplugin],[flashvideo,core_media]
MOV [flashvideo_help,filter_mediaplugin],[flashvideo_desc,core_media]
MOV [html5audio,filter_mediaplugin],[html5audio,core_media]
MOV [html5audio_help,filter_mediaplugin],[html5audio_desc,core_media]
MOV [html5video,filter_mediaplugin],[html5video,core_media]
MOV [html5video_help,filter_mediaplugin],[html5video_desc,core_media]
MOV [mp3audio,filter_mediaplugin],[mp3audio,core_media]
MOV [mp3audio_help,filter_mediaplugin],[mp3audio_desc,core_media]
MOV [legacyquicktime,filter_mediaplugin],[legacyquicktime,core_media]
MOV [legacyquicktime_help,filter_mediaplugin],[legacyquicktime_desc,core_media]
MOV [legacyreal,filter_mediaplugin],[legacyreal,core_media]
MOV [legacyreal_help,filter_mediaplugin],[legacyreal_desc,core_media]
MOV [legacywmp,filter_mediaplugin],[legacywmp,core_media]
MOV [legacywmp_help,filter_mediaplugin],[legacywmp_desc,core_media]
MOV [legacyheading,filter_mediaplugin],[legacyheading,core_media]
MOV [legacyheading_help,filter_mediaplugin],[legacyheading_desc,core_media]
MOV [sitevimeo,filter_mediaplugin],[sitevimeo,core_media]
MOV [sitevimeo_help,filter_mediaplugin],[sitevimeo_desc,core_media]
MOV [siteyoutube,filter_mediaplugin],[siteyoutube,core_media]
MOV [siteyoutube_help,filter_mediaplugin],[siteyoutube_desc,core_media]
AMOS END
2011-12-13 17:08:34 +00:00
|
|
|
* deleted several resourcelib_embed_* functions from resourcelib.php
|
2012-04-17 15:05:33 +02:00
|
|
|
|
2011-10-30 09:28:20 +01:00
|
|
|
=== 2.2 ===
|
|
|
|
|
|
|
|
|
|
removed unused libraries:
|
|
|
|
|
* odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
|
|
|
|
|
|
|
|
|
|
API changes:
|
|
|
|
|
* new admin/tool plugin type
|
|
|
|
|
* new context API - old API is still available
|
2011-11-26 09:07:23 +01:00
|
|
|
* deleted users do not have context any more
|
2011-10-30 09:28:20 +01:00
|
|
|
* removed global search
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=== 2.1 ===
|
|
|
|
|
|
|
|
|
|
API changes:
|
|
|
|
|
* basic suport for restore from 1.9
|
|
|
|
|
* new mobile devices API
|
|
|
|
|
* new questions API
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=== 2.0 ===
|
|
|
|
|
|
|
|
|
|
API changes:
|
|
|
|
|
* new DML API - http://docs.moodle.org/dev/DML_functions
|
|
|
|
|
* new DDL API - http://docs.moodle.org/dev/DDL_functions
|
|
|
|
|
* new file API - http://docs.moodle.org/dev/File_API
|
|
|
|
|
* new $PAGE and $OUTPUT API
|
|
|
|
|
* new navigation API
|
|
|
|
|
* new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
|
|
|
|
|
* new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
|
|
|
|
|
* new portfolio API
|
|
|
|
|
* new local plugin type
|
|
|
|
|
* new translation support - http://lang.moodle.org
|
|
|
|
|
* new web service API
|
|
|
|
|
* new cohorts API
|
|
|
|
|
* new messaging API
|
|
|
|
|
* new rating API
|
|
|
|
|
* new comment API
|
|
|
|
|
* new sessions API
|
|
|
|
|
* new enrolment API
|
|
|
|
|
* new backup/restore API
|
|
|
|
|
* new blocks API
|
|
|
|
|
* new filters API
|
|
|
|
|
* improved plugin support (aka Frankenstyle)
|
|
|
|
|
* new registration and hub API
|
|
|
|
|
* new course completion API
|
|
|
|
|
* new plagiarism API
|
|
|
|
|
* changed blog API
|
|
|
|
|
* new text editor API
|
2012-03-21 09:28:02 +08:00
|
|
|
* new my moodle and profiles API
|
