faca6035d4846520d152441625b806dae2996d5a
[moodle.git] / badges / upgrade.txt
1 This files describes API changes in /badges/*,
2 information provided here is intended especially for developers.
4 === 3.9 ===
5 * BADGE_BACKPACKAPIURL and BADGE_BACKPACKWEBURL are deprecated and should not be used.
6 * OBv2 has been set to the default value when the obversion is not defined.
8 === 3.7 ===
9 * BADGE_BACKPACKURL is deprecated and should not be used.
10 * Incorrect term "badge competencies" has been refactored to "alignments" everywhere.
12 === 3.6 ===
14 * The WebService core_badges_get_user_badges now returns more information for each badge: notification, nextcron, email, version, language, imageauthorname, imageauthoremail, imageauthorurl, imagecaption, endorsement, competencies and relatedbadges.
16 === 2.7 ===
18 * get_completed_criteria_sql() - This method was added to award_criteria class and must be overriden
19   in all criteria classes. This method returns an array consisting of SQL JOIN statement, WHERE conditions,
20   and any parameters that might be required. The results are used in lib/badgeslib.php in review_all_criteria()
21   to reduce to the minimum the number of users to review and award badges.
22 * New optional parameter $filtered in review() allows to indicate that some expensive checks can be skipped
23   if the list of users has been initially filtered based on met criteria.
24 * New optional parameter $archive in delete() in badge class in badgeslib.php
25   allows to indicate that a badge should be archived instead of fully deleted.
26   If this parameter is set to FALSE, a badge will all its information, criteria,
27   and awards will be removed from the database.
28 * BADGE_BACKPACKURL constant has been moved from badges/lib/backpacklib.php to lib/badgeslib.php, and URI scheme
29   name ('http://') has been removed.