UPGRADING.md

   1 # Moodle Upgrade notes
   2
   3 This file contains important information for developers on changes to the Moodle codebase.
   4
   5 More detailed information on key changes can be found in the [Developer update notes](https://moodledev.io/docs/devupdate) for your version of Moodle.
   6
   7 The format of this change log follows the advice given at [Keep a CHANGELOG](https://keepachangelog.com).
   8
   9 ## 4.5dev
  10
  11 ### core
  12
  13 #### Removed
  14
  15 - The previously deprecated function `search_generate_text_SQL` has been removed and can no longer be used.
  16
  17   For more information see [MDL-48940](https://tracker.moodle.org/browse/MDL-48940)
  18 - The previously deprecated function `core_text::reset_caches()` has been removed and can no longer be used.
  19
  20   For more information see [MDL-71748](https://tracker.moodle.org/browse/MDL-71748)
  21 - The following previously deprecated methods have been removed and can no longer be used:
  22     - `renderer_base::should_display_main_logo`
  23
  24   For more information see [MDL-73165](https://tracker.moodle.org/browse/MDL-73165)
  25 - Final deprecation of print_error(). Use moodle_exception instead.
  26
  27   For more information see [MDL-74484](https://tracker.moodle.org/browse/MDL-74484)
  28
  29 ### report
  30
  31 #### Removed
  32
  33 - The previously deprecated `report_helper::save_selected_report` method has been removed and can no longer be used
  34
  35   For more information see [MDL-72353](https://tracker.moodle.org/browse/MDL-72353)
  36
  37 ### core_grades
  38
  39 #### Removed
  40
  41 - The following previously deprecated Behat step helper methods have been removed and can no longer be used:
  42    - `behat_grade::select_in_gradebook_navigation_selector`
  43    - `behat_grade::select_in_gradebook_tabs`
  44
  45   For more information see [MDL-74581](https://tracker.moodle.org/browse/MDL-74581)
  46
  47 ### core_reportbuilder
  48
  49 #### Removed
  50
  51 - The following previously deprecated local helper methods have been removed and can no longer be used:
  52     - `audience::get_all_audiences_menu_types`
  53     - `report::get_available_columns`
  54
  55   For more information see [MDL-76690](https://tracker.moodle.org/browse/MDL-76690)
  56
  57 #### Changed
  58
  59 - In order to better support float values in filter forms, the following filter types now cast given SQL prior to comparison:
  60     - `duration`
  61     - `filesize`
  62     - `number`
  63
  64   For more information see [MDL-81168](https://tracker.moodle.org/browse/MDL-81168)
  65 - The base datasource `add_all_from_entities` method accepts a new optional parameter to specify which entities to add elements from
  66
  67   For more information see [MDL-81330](https://tracker.moodle.org/browse/MDL-81330)
  68
  69 #### Added
  70
  71 - The following external methods now return tags data relevant to each custom report:
  72     - `core_reportbuilder_list_reports`
  73     - `core_reportbuilder_retrieve_report`
  74
  75   For more information see [MDL-81433](https://tracker.moodle.org/browse/MDL-81433)
  76 - Added a new database helper method `sql_replace_parameters` to help ensure uniqueness of parameters within a SQL expression
  77
  78   For more information see [MDL-81434](https://tracker.moodle.org/browse/MDL-81434)
  79
  80 ### mod_assign
  81
  82 #### Removed
  83
  84 - The default option "Never" for `attemptreopenmethod` setting, which disallowed multiple attempts at the assignment, has been removed. This option was unnecessary because limiting attempts to 1 through the `maxattempts` setting achieves the same behavior.
  85
  86   For more information see [MDL-80741](https://tracker.moodle.org/browse/MDL-80741)
  87
  88 #### Deprecated
  89
  90 - The constant `ASSIGN_ATTEMPT_REOPEN_METHOD_NONE` has been deprecated, and a new default value for `attemptreopenmethod` has been set to "Automatically until pass".
  91
  92   For more information see [MDL-80741](https://tracker.moodle.org/browse/MDL-80741)
  93
  94 #### Added
  95
  96 - A new default value for `attemptreopenmethod` has been set to "Automatically until pass".
  97
  98   For more information see [MDL-80741](https://tracker.moodle.org/browse/MDL-80741)
  99
 100 ### core_question
 101
 102 #### Changed
 103
 104 - column_base::from_column_name now has an ignoremissing field, which can be used to ignore if the class does not exist, instead of throwing an exception.
 105
 106   For more information see [MDL-81125](https://tracker.moodle.org/browse/MDL-81125)
 107
 108 ### mod_data
 109
 110 #### Added
 111
 112 - The `data_add_record` method accepts a new `$approved` parameter to set the corresponding state of the new record
 113
 114   For more information see [MDL-81274](https://tracker.moodle.org/browse/MDL-81274)
 115
 116 ### core_courseformat
 117
 118 #### Added
 119
 120 - The constructor of `core_courseformat\output\local\state\cm` has been updated to accept a new optional parameter, `$istrackeduser`.
 121   If `istrackeduser` is pre-computed for the course module's course, it can be provided here to avoid an additional function call.
 122
 123   For more information see [MDL-81610](https://tracker.moodle.org/browse/MDL-81610)