Merge branch 'MDL-76310-311' of https://github.com/paulholden/moodle into MOODLE_311_...
[moodle.git] / mod / lti / upgrade.txt
blob318c625ce78f57e09b35ab6007f5e57eda57b1ff
1 This files describes API changes in the lti code.
3 === 3.10 ===
5 * Select Content supports multiple, allowing a tool to return more than one link at a time.
6   Parameter multiple in function lti_build_content_item_selection_request() is now set to true.
7 * Deprecated unused function after external function, 'get_tool_proxies()', was refactored:
8     - serialise_tool_proxy()
10 === 3.8 ===
12 * The following functions have been finally deprecated and can not be used anymore:
13     * lti_scale_used()
15 === 3.7 ===
17 * Deprecated functions to add support for LTI 1 tools to access services:
18     - mod_lti\local\ltiservice\service_base->check_tool_proxy()
19     - mod_lti\local\ltiservice\service_base->check_type()
20     - mod_lti\local\ltiservice\resource_base->check_tool_proxy()
21     - mod_lti\local\ltiservice\resource_base->check_type()
22     - mod_lti_edit_types_form->get_lti_advantage_services()
23   replaced by:
24     - mod_lti\local\ltiservice\service_base->check_tool()
25     - mod_lti\local\ltiservice\resource_base->check_tool()
26     - mod_lti_edit_types_form->get_lti_services()
27 * Deprecated unused function:
28     - mod_lti\local\ltiservice\service_base->get_configuration_parameter_names()
29 * Deprecated functions to simplify implementation of LTI scopes for accessing services:
30     - mod_lti\local\ltiservice\resource_base->get_permissions()
31     - ltiservice_gradebookservices\local\resources\lineitem\get_permissions()
32     - ltiservice_gradebookservices\local\resources\lineitems\get_permissions()
33     - ltiservice_gradebookservices\local\resources\results\get_permissions()
34     - ltiservice_gradebookservices\local\resources\scores\get_permissions()
35     - ltiservice_memberships\local\resources\contextmemberships\get_permissions()
36     replaced by:
37     - mod_lti\local\ltiservice\service_base->get_permitted_scopes()
38     - ltiservice_gradebookservices\local\service\gradebookservices->get_permitted_scopes()
39     - ltiservice_memberships\local\service\memberships\->get_permitted_scopes()
40 * Deprecated function to remove definition as static:
41     - ltiservice_memberships\local\service\memberships\get_users_json()
42     replaced by:
43     - ltiservice_memberships\local\service\memberships\get_members_json()
45 === 3.4 ===
47 * The following functions, previously used (exclusively) by upgrade steps are not available
48   anymore because of the upgrade cleanup performed for this version. See MDL-57432 for more info:
49     - mod_lti_upgrade_custom_separator()
51 === 3.2 ===
53 * Support for LTI ContentItem message type.
54 * New function lti_build_content_item_selection_request() for building an LTI ContentItemSelectionRequest.
55 * New Select content button in External tool configuration page that lets the user configure an external tool by fetching tool
56   configuration content from the preconfigured tool's content selection interface.
58 === 3.1 ===
60 * When requesting a grade from the outcome service, and empty grade will now be returned as
61   an empty grade in accordance with the spec. Previously a grade of 0 would be returned.
63 === 3.0 ===
65 * Function lti_view (locallib.php) was renamed to lti_launch_tool.
66   A new and different lti_view function was created in the module lib.php containing the code
67   for launching events and update the completion status for the module.
70 === 2.8 ===
72 * Support for LTI 2 added, including extensible services implemented as ltiservice plugins.
73 * Function sendOAuthBodyPOST removed from OAuthBody.php because it was not being used.
74 * The field 'grade' in the table {lti} is now an integer rather than a numeric to bring it
75   in line with the 'grade' field in other activities.
77 === 2.7 ===
79 * mod_lti\event\unknown_service_api_called now has less data stored in 'other'
80   but everything is still available for event observers via method get_message_data()