grade/upgrade.txt

   1 This file describes API changes in /grade/* ;
   2 Information provided here is intended especially for developers.
   3
   4 === 4.4 ===
   5 * The grade_structure::get_element_icon() function has been deprecated. Please use grade_helper::get_element_icon() instead.
   6 * The grade_structure::get_element_type_string() function has been deprecated. Please use grade_helper::get_element_type_string() instead.
   7 * The grade_structure::get_element_header() function has been deprecated. Please use grade_helper::get_element_header() instead.
   8 * The grade_structure::get_activity_link() functions has been deprecated. Please use grade_helper::get_activity_link() instead.
   9 * Some changes to how print_grade_page_head() sets the page title:
  10   * If a non-empty `$heading` parameter is passed, it will be used as the page title's unique identifying information.
  11   * Add support for grade report plugins that define an `editingmode_title` lang string. If the grade report plugin defines this
  12     language string, it will be used for the page title's unique identifying information when editing mode is turned on.
  13 * The function gradeimport_csv_load_data::insert_grade_record() now has extra parameter $gradeitem to carry over the grade item related info
  14   for validation.
  15 * The function get_gradable_users() in grade/lib.php has extra param now to retrieve only active enrolments.
  16 * A new webservice core_grades_get_gradable_users has been added to retrieve gradable users for a course.
  17 * The following previously deprecated methods have been removed and can no longer be used:
  18   - `grade_print_tabs`
  19   - `print_grade_plugin_selector`
  20
  21 === 4.3 ===
  22 * The $showtitle parameter in the print_grade_page_head function located inside grade/lib.php has been deprecated and is not used anymore.
  23 * The deprecated `core_grades_create_gradecategory` external method has been removed, in addition to the accompanying
  24   `core_grades_external::create_gradecategory` methods
  25 * User, Group & Grade item JS classes have been added to easily enable the creation of combobox search components.
  26   Refer to the dev docs on details of how to implement this feature if desired.
  27 * basewidget.js has been deprecated and its uses replaced with the new JS classes mentioned above.
  28 * With the basewidget being deprecated all usages of it in core have now been migrated and the files that used it removed.
  29   The basewidget itself will go through the proper deprecation process and be removed in a future version.
  30 * The following webservices have had some optional parameters changed:
  31   - grade/classes/external/get_enrolled_users_for_selector
  32     - profileimage -> profileimageurl & profileimageurlsmall
  33     - return changed to use the core_user_external::user_description() method instead of a custom baked one.
  34   - grade/classes/external/get_groups_for_selector
  35     - Has been relocated to core_group_external::get_groups_for_selector()
  36     - groupimageurl is now available as an optional parameter to give the user an image either set or generated for the group.
  37 * The grade `itemname` property contained in the return structure of the following external methods is now PARAM_CLEANHTML:
  38   - `core_grades_get_gradeitems`
  39   - `gradereport_user_get_grade_items`
  40 * The grade_helper::get_lang_string() function has been deprecated. Please use get_string() instead.
  41
  42 === 4.1 ===
  43 * The $importactiveurl parameter in the constructor of the core_grades\output\import_action_bar class has been deprecated and is not used anymore.
  44 * The $exportactiveurl parameter in the constructor of the core_grades\output\export_action_bar class has been deprecated and is not used anymore.
  45 * The select_in_gradebook_navigation_selector() function in behat_grade.php has been deprecated. Please use
  46   behat_forms::i_set_the_field_to() instead.
  47
  48 === 4.0 ===
  49
  50 * The select_in_gradebook_tabs() function in behat_grade.php has been deprecated. Please use the function
  51   select_in_gradebook_navigation_selector() instead.
  52 * The setting $CFG->grade_navmethod setting has been completely removed because it's not required anymore. This setting
  53   was used to set the type of navigation (tabs or dropdown box) used in gradebook which is now replaced with tertiary
  54   navigation.
  55 * The print_grade_plugin_selector() function has been deprecated. This function was used to generate and output the
  56   dropdown box navigation in gradebook which is now replaced with tertiary navigation.
  57 * The grade_print_tabs() function has been deprecated. This function was used to generate and output the tabs navigation
  58   in gradebook which is now replaced with tertiary navigation.
  59 * There is a new callback inside of grade_get_plugin_info called extend_gradebook_plugininfo
  60   which allows for new tabs to be added to the gradebook.
  61
  62 === 3.7 ===
  63
  64 * The grade_cron() function has been removed. Please use grade_history_cleanup_task and grade_cron_task scheduled tasks instead.
  65
  66 === 3.6 ===
  67
  68 * The grade_plugin_return constructor now uses parameters from the
  69   request as defaults, which can be overridden by parameters supplied
  70   to the constructor. This may lead to a change in behaviour if only
  71   some of the possible parameters are supplied.
  72 * The grade_plugin_return class now tracks groupid as well as the
  73   type, plugin, courseid, userid and page parameters that were tracked
  74   previously. The groupid parameter will be set using
  75   groups_get_course_group for the relevant course if the group is
  76   otherwise unspecified.
  77 * The above changes mean that code using grade_plugin_return objects
  78   should generally no longer call groups_get_course_group directly,
  79   but should use the gpr->groupid parameter instead.
  80 * The grade_plugin_return constructor now accepts either course or
  81   courseid as a parameter to specify course.