moodle/UPGRADING.md

Moodle Upgrade notes

This file contains important information for developers on changes to the Moodle codebase.

More detailed information on key changes can be found in the Developer update notes for your version of Moodle.

The format of this change log follows the advice given at Keep a CHANGELOG.

4.5dev

core

Removed

• The previously deprecated function search_generate_text_SQL has been removed and can no longer be used.

  For more information see MDL-48940

• The previously deprecated function core_text::reset_caches() has been removed and can no longer be used.

  For more information see MDL-71748

• The following previously deprecated methods have been removed and can no longer be used:

  • renderer_base::should_display_main_logo

  For more information see MDL-73165

• Final deprecation of print_error(). Use moodle_exception instead.

  For more information see MDL-74484

Changed

• The class autoloader has been moved to an earlier point in the Moodle bootstrap. Autoloaded classes are now available to scripts using the ABORT_AFTER_CONFIG constant.

  For more information see MDL-80275

Added

• New DML constant SQL_INT_MAX to define the size of a large integer with cross database platform support

  For more information see MDL-81282

• Added an exception L2 Namespace to APIs

  For more information see MDL-81903

Fixed

• Use server timezone when constructing \DateTimeImmutable for the system \core\clock implementation.

  For more information see MDL-81894

Deprecated

• The following methods have been deprecated, existing usage should switch to secure \core\encryption library:

  • rc4encrypt
  • rc4decrypt
  • endecrypt

  For more information see MDL-81940

mod_assign

Added

• Added 2 new settings:

  • mod_assign/defaultgradetype
    • The value of this setting dictates which of the GRADE_TYPE_X constants is the default option when creating new instances of the assignment.
    • The default value is GRADE_TYPE_VALUE (Point)
  • mod_assign/defaultgradescale
    • The value of this setting dictates which of the existing scales is the default option when creating new instances of the assignment.

  For more information see MDL-54105

• A new default value for attemptreopenmethod has been set to "Automatically until pass".

  For more information see MDL-80741

Removed

• 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.

  For more information see MDL-80741

Deprecated

• The constant ASSIGN_ATTEMPT_REOPEN_METHOD_NONE has been deprecated, and a new default value for attemptreopenmethod has been set to "Automatically until pass".

  For more information see MDL-80741

report

Removed

• The previously deprecated report_helper::save_selected_report method has been removed and can no longer be used

  For more information see MDL-72353

report_eventlist

Deprecated

• The following deprecated methods in report_eventlist_list_generator have been removed:

  • get_core_events_list()
  • get_non_core_event_list()

  For more information see MDL-72786

core_grades

Removed

• The following previously deprecated Behat step helper methods have been removed and can no longer be used:

  • behat_grade::select_in_gradebook_navigation_selector
  • behat_grade::select_in_gradebook_tabs

  For more information see MDL-74581

core_reportbuilder

Removed

• The following previously deprecated local helper methods have been removed and can no longer be used:

  • audience::get_all_audiences_menu_types
  • report::get_available_columns

  For more information see MDL-76690

Changed

• In order to better support float values in filter forms, the following filter types now cast given SQL prior to comparison:

  • duration
  • filesize
  • number

  For more information see MDL-81168

• The base datasource add_all_from_entities method accepts a new optional parameter to specify which entities to add elements from

  For more information see MDL-81330

Added

• The following external methods now return tags data relevant to each custom report:

  • core_reportbuilder_list_reports
  • core_reportbuilder_retrieve_report

  For more information see MDL-81433

• Added a new database helper method sql_replace_parameters to help ensure uniqueness of parameters within a SQL expression

  For more information see MDL-81434

core_question

Changed

• 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.

  For more information see MDL-81125

mod_data

Added

• The data_add_record method accepts a new $approved parameter to set the corresponding state of the new record

  For more information see MDL-81274

Deprecated

• The mod_data_renderer::render_fields_footer method has been deprecated as it's no longer used

  For more information see MDL-81321

editor_tiny

Changed

• The helplinktext language string is no longer required by editor plugins, instead the pluginname will be used in the help dialogue

  For more information see MDL-81572

output

Added

• Added a new renderer_base::get_page getter method

  For more information see MDL-81597

theme

Added

• New core/context_header mustache template has been added. This template can be overridden by themes to modify the context header

  For more information see MDL-81597

core_courseformat

Added

• The constructor of core_courseformat\output\local\state\cm has been updated to accept a new optional parameter, $istrackeduser. If istrackeduser is pre-computed for the course module's course, it can be provided here to avoid an additional function call.

  For more information see MDL-81610

core_completion

Changed

• get_overall_completion_state() function could also return COMPLETION_COMPLETE_FAIL and not only COMPLETION_COMPLETE and COMPLETION_INCOMPLETE

  For more information see MDL-81749

availability

Changed

• The base class info::get_groups method has a $userid parameter to specify for which user you want to retrieve course groups (defaults to current user)

  For more information see MDL-81850

core_course

Changed

• The reset course page has been improved. The words "Delete" and "Remove" have been removed from all the options to make it easier to focus on the data to be removed and avoid inconsistencies and duplicated information. Third party plugins implementing reset methods might need to:

  • Add static element in the _reset_course_form_definition method before all the options with the Delete string: $mform->addElement('static', 'assigndelete', get_string('delete'));
  • Review all the strings used in the reset page to remove the "Delete" or "Remove" words from them.

  For more information see MDL-81872