weekly release 4.0dev
[moodle.git] / completion / upgrade.txt
1 This files describes API changes in /completion/* - completion,
2 information provided here is intended especially for developers.
4 === 3.11 ===
5 * New Behat steps for activity completion in the behat_completion class:
6   - activity_completion_condition_displayed_as()
7     - Given the "<Completion condition>" completion condition of "<Activity name>" is displayed as "<Status>"
8   - activity_should_have_the_completion_condition()
9     - Given "<Activity name>" should have the "<Condition name>" completion condition
10   - manual_completion_button_displayed_as()
11     - Given the manual completion button of "<Activity name>" is displayed as "<Status>"
12   - the_manual_completion_button_for_activity_should_be_disabled()
13     - Given the manual completion button for "<Activity name>" should be disabled
14   - there_should_be_no_completion_for_activity()
15     - Given there should be no completion information shown for "<Activity name>"
16   - toggle_the_manual_completion_state()
17     - Given I toggle the manual completion state of "<Activity name>"
18   - overridden_manual_completion_button_displayed_as
19     - Given the manual completion button of "<Activity name>" overridden by "<User>" is displayed as "<Status>"
20   - overridden_activity_completion_condition_displayed_as
21     - Given the "<Completion condition>" completion condition of "<Activity name>" overridden by "<User>" is displayed as "<Status>"
22 * *_get_completion_state() callback functions have been deprecated and should no longer be used. Plugins that define custom
23   completion rules must implement the mod_[modname]\completion\custom_completion class that extends the
24   \core_completion\activity_custom_completion base class.
26 === 3.7 ===
27  * External function core_completion_external::get_activities_completion_status new returns the following additional field:
28    - valueused (indicates whether the completion state affects the availability of other content)
29  * On the course page, only users with the capability 'moodle/course:isincompletionreports' (students, by default) can now tick the
30    completion checkboxes. Teachers no longer get working checkboxes; tey see slightly different icons that indicate whether
31    completion is enabled for the activity. These are the same icons which have always been shown to teachers before when the
32    enabled the course editing mode.
34 === 2.9 ===
36 * A completed and failed activity counts as a completed activity for
37   course completion.