MoodleDocs - User contributions [en]

Talk:Moodle 4.0.2 release notes

2022-07-08T21:45:14Z

Fox: Please adapt correctly interlanguage links

Lang links should point to 4.0.2 versions pages.
--[[User:Séverin Terrier|Séverin Terrier]] ([[User talk:Séverin Terrier|talk]]) 21:44, 8 July 2022 (UTC)

Moodle 3.9.14 release notes

2022-05-09T17:39:23Z

Fox: Released

<p class="note">'''This version of Moodle is no longer supported for general bug fixes.''' You are encouraged to [[:en:Upgrading|upgrade]] to a supported version of Moodle.</p>

[[Releases]] > {{FULLPAGENAME}}

Release date: 9 May 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.9.14%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.9.14].

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.9.13 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.9]]

[[fr:Notes de mise à jour de Moodle 3.9.14]]
[[es:Notas de Moodle 3.9.14]]

Moodle 3.11.7 release notes

2022-05-09T17:38:36Z

Fox: Released

[[Releases]] > {{FULLPAGENAME}}

Release date: 9 May 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.11.7%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.11.7].
==General fixes and improvements==
* MDL-69552 - Tag filter not working when adding random question from questionbank
* MDL-48633 - Lesson grade handling is buggy when scales in use
* MDL-58044 - Course completion report labels do not align correctly in RTL mode
* MDL-74299 - Unable to delete Questions from Question bank
* MDL-73979 - Timeline block views should display consistent information
* MDL-74127 - Attempts remaining for lesson are only displayed when "This page" is set to wrong answers
* MDL-74321 - Increased DB reads on forum
* MDL-74486 - Background images bleed into user tours
* MDL-57383 - Upload users admin tool incorrectly updates authentication method for existing users
* MDL-74258 - H5P activities not searchable by global search
* MDL-73874 - Drag and drop into text & Select missing words questions: form should validate 'multiple' is on for choices used more than once
* MDL-69078 - The error when importing a GIFT question file with the wrong encoding does not make the problem clear
* MDL-74481 - LTI Advantage: Non-Editing Teacher has role Student
* MDL-74478 - Awarded badge for activity completion, despite not receiving a passing grade
* MDL-74436 - Fatal error when importing "course" events from ics file
* MDL-74427 - Coding error detected when deleting question category
==Security fixes==
Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.
==See also==
*[[Moodle 3.11.6 release notes]]
[[Category:Release notes]]
[[Category:Moodle 3.11]]
[[fr:Notes de mise à jour de Moodle 3.11.7]]
[[es:Notas de Moodle 3.11.7]]

Moodle 3.10.11 release notes

2022-05-09T17:38:21Z

Fox: Released

<p class="note">'''This version of Moodle is no longer supported for general bug fixes.''' You are encouraged to [[:en:Upgrading|upgrade]] to a supported version of Moodle.</p>

[[Releases]] > {{FULLPAGENAME}}

Release date: 9 May 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.10.11%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.10.11].

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.10.10 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.10]]

[[fr:Notes de mise à jour de Moodle 3.10.11]]
[[es:Notas de Moodle 3.10.11]]

Moodle 4.0.1 release notes

2022-05-09T17:37:51Z

Fox: Released

Release notes template

2022-05-05T09:17:50Z

Fox: French link (to adapt if 4.x or 3.x)

Copy and paste this wiki code into the new release notes page and replace all the missing bits.
<syntaxhighlight lang="text">
[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%22X.X.X%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in X.X.X].

==Server requirements==

===Database requirements===

==Client requirements==

===Browser support===
Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge
* Internet Explorer

Mobile:
* MobileSafari
* Google Chrome

For the best experience and optimum security, we recommend that you keep your browser up to date.

Note: Legacy browsers with known compatibility issues with Moodle X.X:
* Internet Explorer 10 and below
* Safari 7 and below

==Major features==

''Items to be added soon...''

==Other highlights==

''Items to be added soon...''

==For admins==

''Items to be added soon...''

==For developers==

''Items to be added soon...''

==Security issues==

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle X.X.X-1 release notes]]

[[Category:Release notes]]
[[Category:Moodle X.X]]

[[fr:Notes de version de Moodle X.X.X]] (please use this for 4.x, and delete this tip and the line under)
[[fr:Notes de mise à jour de Moodle X.X.X]] (please use this for 3.x, and delete this tip and the line upper)
[[es:Notas de Moodle X.X.X]]

</syntaxhighlight>

===Tips===

The following git command can be used to find all upgrade.txt files that were modified since the last release, so that links to them can be provided in the release notes - typically in the For developers section.

$ git log --oneline --pretty="format:" --name-only v3.5.0..v3.6.0-beta | grep upgrade.txt | sort | uniq | while read path; do echo "* [https://git.in.moodle.com/moodle/moodle/blob/v3.6.0-beta/$path $path]"; done

See e.g. [[Moodle 3.6 release notes#Component APIs upgrades]] for how it was used in the past.

[[:es:Plantilla para las notas de versiones|Plantilla en Español]]

[[Category:Release notes]]
[[Category:Processes|Release process]]

Moodle 4.0.1 release notes

2022-05-05T08:36:08Z

Fox: French link (name changed since 4.0)

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for 9 May 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%224.0.1%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 4.0.1].

==General fixes and improvements==
* MDL-74461 - Not always possible to easily navigate back to section from an activity page
* MDL-74514 - BigbluebuttonBN is polling the BigblueButton server too often
* MDL-74481 - LTI Advantage: Non-Editing Teacher has role Student
* MDL-74478 - Awarded badge for activity completion, despite not receiving a passing grade
* MDL-74450 - The course secondary navigation should be displayed in the site home settings page
* MDL-74317 - Edit mode cannot be turned on/off when using other capabilities
* MDL-74436 - Fatal error when importing "course" events from ics file
* MDL-74427 - Coding error detected when deleting question category

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 4.0 release notes]]

[[Category:Release notes]]
[[Category:Moodle 4.0]]

[[fr:Notes de version de Moodle 4.0.1]]
[[es:Notas de Moodle 4.0.1]]

Category:DevDocs Migration

2022-04-12T12:00:35Z

Fox: Typo

Moodle is currently assessing options for improving Developer Documentation and resources.

As a part of this assessment we are also assessing alternatives to WikiMedia for this documentation and are migrating some of the content in this wiki into the systems we have under assessment.

To keep track of the pages that have been migrated, and to help consider how such a migration could be managed, we have created a new Category for the migration, as this will allow us to find and identify any documentation which has or has not been moved. In the event that we do adopt one of the systems that we are exploring it is hoped that we will also be able to make use of any transitioned documents, and apply any updates since the change was made.

More information on any changes will be announced at a later date.

Moodle 4.0 developer update

2021-11-17T14:11:11Z

Fox: /* Introduction of a new activity icons */

{{Moodle 4.0}}This page highlights the important changes that are coming in Moodle 4.0 for developers. Including how the UX improvements impact custom themes, relevant API changes, and what you can do as developer to prepare for the 4.0 release.
== Theme changes ==
The 4.0 theme changes can be classified as changes to improve overall navigation, changes for the course navigation and page, and general UI improvements for Moodle 4.0 and newer only.
==== Navigation UI changes ====
A new layout has been added that pushes the blocks region offscreen called the drawers layout. This layout has a fixed width of 800px for the main content area and page buttons to open / close the drawers. Files:
/theme/boost/layouts/drawers.php
/theme/boost/templates/drawers.mustache
In case a page uses “fake blocks” (for example book, quiz, calendar, etc.) the drawer region will be opened automatically on first visit.

Child themes implementing this layout should update the theme config.php and configure the ‘drawers’ layout from theme boost for pages like ‘course’ and ‘incourse’

Pages that should not use the drawers layout are the admin pages or other pages that require more horizontal space in the main content area.
===== Primary / secondary navigation =====
The top navbar now includes the new '''primary navigation''', this navigation used to be in the page navdrawer region. If custommenu items are configured in the global theme settings they will be added to the primary navigation.

The main content area shows tabs for secondary navigation with a maximum of 5 items being rendered in this ‘more’ menu. A new UI component has been created to render menus like this. Files:
/lib/templates/moremenu.mustache
===== Navigation upcoming changes =====
===== Edit switch. =====
MDL-71610

On theme boost the “Turn editing on” and “Customise this page” buttons have been replaced by an edit switch in the top navbar. Theme Classic will keep using the old buttons. Child themes can choose to use the edit switch if the theme config.php is using this variable
$THEME->haseditswitch = true;
The languague menu, which used to be rendered in place of the custom menu has moved to the user dropdown when the user is logged in. If not logged in it will be placed next to the search / notification / messaging icon in the top navbar.
==== Course navigation and the course page ====
===== Introduction of a new course index component =====
The new course index feature can be themed using a set of scss variables. Use them to change the look and feel instead of adding custom css
/theme/boost/scss/moodle/courseindex.scss
With the introduction of the course index component, the previous and next links shown underneath each activity are no longer needed and they will be removed.
===== Introduction of a new activity icons =====
The icons used for activities have been redesigned and updated for all core moodle activities.

When viewing the new icons in a file manager, for example for the quiz activity, you will see a simple black monochrome icon with a transparent background.

On the course page, or in the activity chooser, the icon will display as a white icon on a coloured background. Styling of the icons on the coursepage is controlled by the css in theme/boost/scss/moodle/icons.scss.

The background colour for activity icons is set using a new variable in function [modname]_supports(). The quiz activity is of type assessment, so in function quiz_supports() there is a new line defining the purpose:
case FEATURE_MOD_PURPOSE: return MOD_PURPOSE_ASSESSMENT;
Available purposes are:

* MOD_PURPOSE_COMMUNICATION
* MOD_PURPOSE_ASSESSMENT
* MOD_PURPOSE_COLLABORATION
* MOD_PURPOSE_CONTENT
* MOD_PURPOSE_ADMINISTRATION
* MOD_PURPOSE_INTERFACE

The background colours linked to these purposes are set in theme/boost/scss/moodle/variables.scss
$activity-icon-colors: map-merge(
(
"administration": #5d63f6,
"assessment": #eb66a2,
"collaboration": #f7634d,
"communication": #11a676,
"content": #399be2,
"interface": #a378ff
),
$activity-icon-colors
);
If activity plugins do not define FEATURE_MOD_PURPOSE the activity icon will be rendered against a light grey background. There is no requirement to define the purpose of activity plugins, it will only affect the icon styling.

Customising the activity icon can be done in an alternative way. For example using the styles.css in mod/[pluginname/styles.css

In the example below the activity plugin developer chooses to keep the coloured icon for the activity and render it as large as the coloured background on the core activities
.modicon_subcourse.activityiconcontainer {
background-color: transparent;
padding: 0;
}

.modicon_subcourse.activityiconcontainer img {
width: 50px;
height: 50px;
}
To customize all icon colours use this scss array and add it to the ‘Raw initial SCSS’ in the theme Boost advanced settings page. The complete array of icon background colours can be overridden using the ‘Raw initial SCSS’ in the theme settings page. The example below changes the colours of each activity type.
$activity-icon-colors: (
"administration": #5D63F6,
"assessment": #11A676,
"collaboration": #EB66A2,
"communication": #F7634D,
"content": #399BE2,
"interface": #A378FF
)

===== General UI improvements upcoming changes =====
===== Login page =====
MDL-69371

The login page has been redesigned and allows the admin to configure a background image for the login page only in the theme settings page. This change is available in both Boost and Classic. The login page still has all the features with an improved layout.
===== The page footer =====
MDL-71965

In large screens, the page footer button is only visible when clicking a help button at the bottom right of the screen.
===== User initials as profile picture placeholder =====
MDL-72305

If users do not upload a profile picture the user initials are displayed on a rounded gray background as a placeholder picture in the top navbar or any other page using a placeholder image. This change will be available in both Boost and Classic.

With the introduction of this placeholder image the full username will no longer be displayed in the top navbar.

===== Removal of back to top link =====
MDL-72454

The "back to top" link will be removed for theme boost since the new course index reduced the dependence on page scrolling. Also, the new footer is positioned where this component used to be.
===== Styling changes =====
By default rounded edges will be used for UI components MDL-72455, for the page header and main content area the borders will be removed MDL-72457.
== Component library ==
==== Purpose of the Component Library ====
Each Moodle installation now ships with a Moodle User Interface (UI) Component library, a documentation system used to describe all the Bootstrap components and the custom Moodle components. The component Library is a helper tool for developers when creating user interfaces, a testing tool for theme developers and a documentation tool for core developers. The ultimate goal of having a component library is to encourage developers to create consistent user interfaces to improve Moodle’s overall user experience.

The library contains pages with documentation about User Interface components. It contains details on how to use the component, what variations are available and the JavaScript events / options are associated with the component.

When writing on these pages it is possible to render core mustache templates using some custom syntax like this:
<nowiki>{{< mustache template="core/notification_error" >}}</nowiki>
<nowiki>{{< /mustache >}}</nowiki>
You can also call core JavaScript or use HTML examples where the html code and the rendered result are visible in the Component Library. For more info visit the [http://componentlibrary.moodle.com/admin/tool/componentlibrary/docspage.php/library/moodle-templates/ Moodle templates] page or the [http://componentlibrary.moodle.com/admin/tool/componentlibrary/docspage.php/library/moodle-javascript/ Moodle JavaScript] page.

Each page in the library uses the current css from the default theme in your Moodle installation, if you have multiple themes installed and enabled the setting "Allow theme changes on url", the component library will have a theme selector option.
===== Enabling the Component Library =====
Component library pages are written in the markdown language. These pages need to be compiled to HTML pages before the Component Library is visible. To compile the pages the server running Moodle needs to have the [[Javascript Modules#Install%20NVM%20and%20Node|JavaScript developer tools installed]] (nodeJs and Grunt)

If your server meets all requirements you can enable the library running
$ npm install
$ grunt componentlibrary
Further installation instructions can be found in the Component Library itself.
===== The online version of the Component Library =====
A hosted version of the Component Library can be found here. http://componentlibrary.moodle.com
===== Documenting new UI Components =====
There are no set rules for adding new pages in the component library yet. These rules will need to be written and adopted in the integration process for Moodle code.

As a guideline for making this rules consideration are:

The component library is not about single use components, for example the Moodle grade book (a huge component with many custom features). Or about very common components like buttons, these are already covered by the Bootstrap section of the component library.

New features should be build keeping in mind the UI part needs to be customisable and if possible (and making sense) reusable. And example would be the new page drawers that we are introducing for the Navigation project. Or the custom primary navigation menus where overflowing items are pushed into a More section.
== Navigation ==
The core Navigation API has been left mostly untouched. The callbacks to all navigation callbacks remains unchanged and will be called as part of the regular 'navigation' and 'settingsnav' initialisation. Some new core classes have been created and exist within a new namespace 'core/navigation' and serves as conduit to rearrange, cherry-pick existing navigation nodes from the navigation/settingsnav trees and display within the respective navigation type. As such, it is highly recommended to provide unique keys for custom navigation nodes as this helps in the cherry-picking / rearranging process within the new classes.
===== Primary navigation / Primary Output =====
The primary navigation(the navbar) apart from the existing content will now display links to the Dashboard, My Courses, Site Admin and Course search, by default. You can still add items to the navbar via the 'custom menu' option. This will be displayed within the 'More' menu. We have transitioned the menus to be rendered via templates - refer user_menu.mustache. The lang menu has been moved to reside within the user menu.
===== New view =====
All settings for courses/modules will now be displayed as tabs within the module. A predefined set of tabs will be shown with any remaining / newly added ones residing within the 'Course Admin' page. The settings cog will not be shown anymore. It is recommended to review any settings as some might be displayed as tabs and possibly move them to the tertiary navigation as is done in the core activity modules<sup>1</sup>. At most 5 tabs will be displayed to a user with all the overflow nodes now residing within the 'More' menu. Some of the nodes can be hidden by using the new functions defined.
===== New API functions =====
====== Page API ======
* Magic getters to fetch the primary and secondary navs and the primary output.
* The secondarynav magic getter also checks whether a custom secondary class has been defined within the module's local\views directory. Use this if you want to deviate from the standard secondary nav structure/order.

* set_secondary_nav - Force override the secondary navigation class

* has_secondary_navigation_setter - Sets the ‘_hassecondarynavigation’ to indicate whether a page should render the secondary navigation
====== Navigationlib ======
* set_show_in_secondary_navigation - whether or not a node should be displayed in the secondary nav. Accepts a single boolean argument
* set_force_into_more_menu- whether or not to force a node into the 'More' menu. Accepts a single boolean argument
===== Changing order of tabs in secondary navigation nodes =====
Apart from the previously mentioned functions, you can also create a custom secondary class as mentioned earlier. This will automatically be picked by getter and used to render the secondary nav within the activity. E.g. mod_assign/local/views/secondary. Note: This is currently only possible on an activity and block level.
===== Upcoming changes: =====
# <sup>1 -</sup> Complete tertiary nav overhaul for core’s modules - MDL-71912. MDL-71913, MDL-71914, MDL-71915
# Backwards compatibility for complex deep nested custom navigation. Any custom navigation added by 3rd party devs will now be displayed as flatter structure within a URL select - MDL-72352
# New module API to inject common content at the top of a module page. The common content would be the title, description and activity information. This solves 2 issues:
## A centralised location where we can handle #2 and inject it into the relevant page
## A centralised location where we can inject items particularly activity_information without the need to be replicated in each module.
== The core_courseformat subsystem ==
Most of the logic for rendering and editing a course has been moved to a new subsystem called courseformat. The subsystem is located in "course/format" folder so it includes all the format plugins inside. The methods and modules which are distributed between the course and the course/format folders are now rearranged or refactored to be aligned with the current Moodle coding style.
==== Mandatory renderer in course formats ====
Now format plugins renderer is not optional anymore. Legacy formats without a renderer will get a deprecation message but it will continue working however, they should create a new renderer as soon as possible. The section-based format can do it by extending the provided core_courseformat\output\section_renderer class which includes all the necessary methods.
==== New format base class ====
The old base_format class (which all plugins extend) is now renamed as core_courseformat\base. The new class provides all the functionally of the previous base_format but it has been refactored to be used as a centralized source of truth for the course rendering. Legacy formats should extend the new class to avoid the deprecation message.

Now, the plugin format class provides information such as:
* If the page is displaying a single or multiple section
* Give access to other related format objects like the modinfo, the course record, maximum number of sections...
* If the format is compatible with features like course index, reactive components, ajax...
* Other format specifics like the page title, the default section name, default blocks...

The format instance is now the main object output components will use to render a course (see next section for more information).
==== New course output classes and mustache files ====
Traditionally, section-based course formats uses print_single_section_page and print_multiple_section_page to render the course content. In Moodle 4.0 most of the course rendering methods are migrated to output components and mustache templates. The old methods will get deprecation messages if they use the old renderer methods.

This is an example of a format rendering a course:<syntaxhighlight lang="php-brief">
// Get the course format instance.
$format = course_get_format($course);

// Get the specific format renderer.
$renderer = $format->get_renderer($PAGE);

if (!empty($displaysection)) {
// Setup the format instance to display a single section.
$format->set_section_number($displaysection);
}

// Create the ouptut instance and render it.
$outputclass = $format->get_output_classname('content');
$widget = new $outputclass($format);

echo $renderer->render($widget);
</syntaxhighlight>Format plugins are free to use its own output classes to render a course, or they could override the existing output classes by providing their own implementation. For example, the default output for "content" (as in the previous example) is "core_courseformat\output\local\|content", however, if the plugin has a "format_XXX\output\courseformat\content" class, the $format->class the get_output_class will return the overridden one.
Another important update on course rendering is that now all course structure is rendered using mustache templates instead of the original html_writer methods. Now themes are able to override the course format by providing alternative versions of the mustache files. All core course templates are located in "course/format/templates".

All the new output classes and a guide on how to migrate the current third-party plugins will be available soon.
==== Course editor javascript modules and frontend components ====
The majority of the javascript logic related to the course editing is replaced by AMD modules. Because this is a major change in the way courses are edited and rendered, by default format plugins will continue using the previous YUI modules for now. However, formats can start using the new libraries overriding the "$format->supports_components()" method.

Some Moodle 4.0 new features are only available for courses using the new editor library:
* Edit the course via the course index
* Creating sections without reloading the course page
* The new move section/activity modal
* Native browser drag&drop implementation
The new course editor uses a component-based reactive pattern to keep track of the course changes. The pattern highlights are:
* The main AMD module "core_crouseformat\courseeditor" maintains a data structure called state.
* Each UI element is implemented as a Component that observes the course state data and reacts to any data change
* When any reactive component needs to modify the course, it asks the course editor to execute a mutation. Mutations encapsulate all web services calls and alter the course state data.

The reactive library documentation, as well as the format plugin migration guide, will be available soon.
==== Other course related 4.0 changes ====
Two new web services have been added:
* core_courseformat_get_state: user by the new javascript course editor to get the current course state data (containing the list of sections, activities, and other course-related data)
* core_courseformat_update_course: to alter the current course content. Each call returns the parts of the course state altered by the action
== API changes ==
== Behat changes ==
To make behat tests more readable and easy to maintain, it is recommended to use the most direct steps to get what the test needs. So since MDL-66335 was integrated, and the step was improved in MDL-72179 is highly recommended to use
I am on the "Activity name" "[modname] activity" page
or
I am on the "Activity name" "[modname] activity" page logged in as "user"
instead of navigating to the activity via
I am on "Course" course homepage
I follow "Activity name"
Now that [https://docs.moodle.org/dev/Prototypes#Course_creation_improvements Course index] (MDL-71209) is integrated but the project is not stable, these behat steps
I am on "Course" course homepage
I follow "Activity name"
will fail using Boost theme.

The reason for it is that the drawer used in Boost is hiding the course index. So when the test is trying to follow an "Activity name" link, it finds two different links:
* one in the course index
* another one in the course main content.
But the first one, the one in the course index, is hidden by the drawer, and the test fails.

However the recommended behat steps
I am on the "Activity name" "[modname] activity" page
or
I am on the "Activity name" "[modname] activity" page logged in as "user"
work '''fine'''.

Some of the failing behats are fixed in https://github.com/ferranrecio/moodle/commit/c79d58a50b48aa6891ff1d3ba92a7b0ab2393c88#diff-fdf8b0b1eade3b69eaad038de0ddd7c8dec2be7afa32dc693fb929739a49fa9dR32 - MDL-71209

For example:
And I am on the "Test assignment name" "assign activity" page logged in as teacher1
instead of:
When I log in as "teacher1"
And I am on "Course" course homepage
And I follow "Test assignment name"
== Core plugins review ==
A few plugins from core Moodle LMS which are no longer or hardly used have been removed and, if appropriate, added to the Moodle plugins directory.

More information about this project, the list of plugins to be removed and the process to follow for keeping them before upgrading to 4.0 can be found in the [[Core plugins review]] page.

Moodle 4.0 release notes

2021-11-03T09:33:39Z

Fox: Updated version to 4.0

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for January 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%224.0%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 4.0].

If you are upgrading from a previous version, please see [[:en:Upgrading|Upgrading]] in the user docs.

==Server requirements==

''Note: Requirements still to be reviewed and updated as necessary!''

These are just the minimum supported versions. We recommend keeping all of your software and operating systems up-to-date.

* Moodle upgrade: Moodle 3.6 or later
* PHP version: minimum PHP 7.3.0 ''Note: minimum PHP version has increased since Moodle 3.10''. PHP 7.4.x is supported too. [[Moodle and PHP|PHP 8.0 support]] is being implemented (see MDL-70745) and '''not ready for production''' yet.
* PHP extension '''sodium''' is recommended. It will be required in Moodle 4.2. For further details, see [https://docs.moodle.org/311/en/Environment_-_PHP_extension_sodium Environment - PHP extension sodium].
* PHP extension '''exif''' is recommended.
* PHP setting '''max_input_vars''' is recommended to be >= 5000 for PHP 7.x installations. It's a requirement for PHP 8.x installations. For further details, see [https://docs.moodle.org/311/en/Environment_-_max_input_vars Environment - max input vars].

=== Database requirements ===

Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.

{| class="wikitable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 10 (increased since Moodle 3.11)
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.7
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 10.2.29
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2017 (increased since Moodle 3.10)
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 11.2
| Latest
|}

==Client requirements==

=== Browser support ===

Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge

''Note: Moodle 4.0 does NOT support Internet Explorer 11.''

Safari 7 and below has known compatibility issues with Moodle 4.0.

Mobile:
* MobileSafari
* Google Chrome

For the best experience and optimum security, we recommend that you keep your browser up to date.
==Major features==

==Other highlights==

==Security issues==

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.11 release notes]]

[[Category:Release notes]]
[[Category:Moodle 4.0]]

[[fr:Notes de version de Moodle 4.0]]
[[es:Notas de Moodle 4.0]]

Moodle 4.0 release notes

2021-11-03T09:20:16Z

Fox: Changed release date + updated french link (since 4.0)

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for January 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%224.0%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 4.0].

If you are upgrading from a previous version, please see [[:en:Upgrading|Upgrading]] in the user docs.

==Server requirements==

''Note: Requirements still to be reviewed and updated as necessary!''

These are just the minimum supported versions. We recommend keeping all of your software and operating systems up-to-date.

* Moodle upgrade: Moodle 3.6 or later
* PHP version: minimum PHP 7.3.0 ''Note: minimum PHP version has increased since Moodle 3.10''. PHP 7.4.x is supported too. [[Moodle and PHP|PHP 8.0 support]] is being implemented (see MDL-70745) and '''not ready for production''' yet.
* PHP extension '''sodium''' is recommended. It will be required in Moodle 4.2. For further details, see [https://docs.moodle.org/311/en/Environment_-_PHP_extension_sodium Environment - PHP extension sodium].
* PHP extension '''exif''' is recommended.
* PHP setting '''max_input_vars''' is recommended to be >= 5000 for PHP 7.x installations. It's a requirement for PHP 8.x installations. For further details, see [https://docs.moodle.org/311/en/Environment_-_max_input_vars Environment - max input vars].

=== Database requirements ===

Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.

{| class="wikitable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 10 (increased since Moodle 3.11)
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.7
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 10.2.29
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2017 (increased since Moodle 3.10)
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 11.2
| Latest
|}

==Client requirements==

=== Browser support ===

Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge

''Note: Moodle 3.10 does NOT support Internet Explorer 11.''

Safari 7 and below has known compatibility issues with Moodle 3.10.

Mobile:
* MobileSafari
* Google Chrome

For the best experience and optimum security, we recommend that you keep your browser up to date.
==Major features==

==Other highlights==

==Security issues==

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.11 release notes]]

[[Category:Release notes]]
[[Category:Moodle 4.0]]

[[fr:Notes de version de Moodle 4.0]]
[[es:Notas de Moodle 4.0]]

Moodle 3.10.7 release notes

2021-09-10T14:02:41Z

Fox: Undo revision 61262 by Tsala (talk)

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for 13 September 2021

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.10.7%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.10.7].

==General fixes and improvements==
* MDL-70176 - Forum Grading Does Not Respect Separate Groups Filter
* MDL-71121 - Default settings async course backup
* MDL-49202 - Checking "Hidden" in grade item settings does not hide the item from student, at the same time selecting "Hide" from dropdown on the setup page does
* MDL-72242 - Missing SVG files in forum posts
* MDL-70376 - Assignment - Annotated PDF Download issues when page is turned
* MDL-72312 - PHP 7.2 tests failing in 3.10 & 3.9, caused by buggy php-igbinary extension
* MDL-71500 - Cannot select a date on the right hand side 3 month mini calendar, after previously selecting one
* MDL-69451 - moodle_read_slave_trait: restore temptables object when creating rw and ro handles
* MDL-72033 - User tours: step placement issues if screen too narrow
* MDL-71973 - Exception thrown when evaluating disabled models from the CLI
* MDL-70006 - Suspended enrolment will get analytics messages
* MDL-70165 - Unable to change user role in a new course
* MDL-70433 - In gradebook titles, ampersand '&' is being displayed as & amp;
* MDL-71050 - H5P does not use the correct language
* MDL-72265 - Backup code added in MDL-56310 incorrectly checks moodle/role:safeoverride for users who already have moodle/role:override
* MDL-67833 - Text run over on Lang customization screen
* MDL-72035 - Course completion report Excel download should include BOM to ensure correct character encoding
* MDL-71945 - Bulk releasing grades for anonymous submissions pushes them to gradebook
* MDL-71844 - Navigation breadcrumbs lost when running single task
* MDL-71487 - Setting filesize settings to huge values breaks settings pages/search
* MDL-72207 - Webservice mod_assign_get_submission_status doesn't support "All participants"
* MDL-71029 - Forum summary report multiplies counts by number of enrollments a user has
* MDL-72271 - Clicking "Finish Review" after a quiz set to Full screen popup with Javascript security results in a 404 to /mod/quiz/0 if not in a popup window
* MDL-72325 - sitepolicynotagreed popup appears when trying to start a user tour
* MDL-72153 - Privacy export of user data doesn't export description files correctly/triggers debugging
* MDL-72106 - Error being displayed after deleting calendar subscription

==Accessibility improvements==
* MDL-68639 - Atto produces invalid nested unordered (UL) lists
* MDL-72286 - Atto plugin steals default submit action so enter key in other fields no longer submits the form
* MDL-71674 - Atto editor's insert image dialog boxes do not show all error messages
* MDL-71656 - Add meaningful label to colour items in colour chooser elements
* MDL-72206 - Insufficient colour contrast in warning messages in environment check
* MDL-71814 - Atto: File picker – file info panel focus issue

==Security improvements==
* MDL-72014 - Update grunt and some components to avoid some security reports
* MDL-72187 - Log visibility change of log stores

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.10.6 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.10]]

[[fr:Notes de mise à jour de Moodle 3.10.7]]
[[es:Notas de Moodle 3.10.7]]

Moodle 3.11.3 release notes

2021-09-10T13:59:22Z

Fox: /* Accessibility improvements */ Delete line in double

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for 13 September 2021

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.11.3%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.11.3].

==General fixes and improvements==
* MDL-70176 - Forum Grading Does Not Respect Separate Groups Filter
* MDL-71121 - Default settings async course backup
* MDL-49202 - Checking "Hidden" in grade item settings does not hide the item from student, at the same time selecting "Hide" from dropdown on the setup page does
* MDL-72242 - Missing SVG files in forum posts
* MDL-70376 - Assignment - Annotated PDF Download issues when page is turned
* MDL-72312 - PHP 7.2 tests failing in 3.10 & 3.9, caused by buggy php-igbinary extension
* MDL-71500 - Cannot select a date on the right hand side 3 month mini calendar, after previously selecting one
* MDL-69451 - moodle_read_slave_trait: restore temptables object when creating rw and ro handles
* MDL-72033 - User tours: step placement issues if screen too narrow
* MDL-71973 - Exception thrown when evaluating disabled models from the CLI
* MDL-70006 - Suspended enrolment will get analytics messages
* MDL-70165 - Unable to change user role in a new course
* MDL-70433 - In gradebook titles, ampersand '&' is being displayed as & amp;
* MDL-71050 - H5P does not use the correct language
* MDL-72358 - Error exception in content bank when an H5P file doesn't exist
* MDL-72265 - Backup code added in MDL-56310 incorrectly checks moodle/role:safeoverride for users who already have moodle/role:override
* MDL-67833 - Text run over on Lang customization screen
* MDL-72035 - Course completion report Excel download should include BOM to ensure correct character encoding
* MDL-71945 - Bulk releasing grades for anonymous submissions pushes them to gradebook
* MDL-71844 - Navigation breadcrumbs lost when running single task
* MDL-71487 - Setting filesize settings to huge values breaks settings pages/search
* MDL-72207 - Webservice mod_assign_get_submission_status doesn't support "All participants"
* MDL-71029 - Forum summary report multiplies counts by number of enrollments a user has
* MDL-72271 - Clicking "Finish Review" after a quiz set to Full screen popup with Javascript security results in a 404 to /mod/quiz/0 if not in a popup window
* MDL-72325 - sitepolicynotagreed popup appears when trying to start a user tour
* MDL-72153 - Privacy export of user data doesn't export description files correctly/triggers debugging
* MDL-72106 - Error being displayed after deleting calendar subscription
* MDL-71899 - Improve 3.11 Activity information performance

==Accessibility improvements==
* MDL-68639 - Atto produces invalid nested unordered (UL) lists
* MDL-72286 - Atto plugin steals default submit action so enter key in other fields no longer submits the form
* MDL-71674 - Atto editor's insert image dialog boxes do not show all error messages
* MDL-71656 - Add meaningful label to colour items in colour chooser elements
* MDL-72206 - Insufficient colour contrast in warning messages in environment check
* MDL-71814 - Atto: File picker – file info panel focus issue

==Security improvements==
* MDL-72014 - Update grunt and some components to avoid some security reports
* MDL-72187 - Log visibility change of log stores

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.11.2 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.11]]

[[fr:Notes de mise à jour de Moodle 3.11.3]]
[[es:Notas de Moodle 3.11.3]]

Moodle 4.0 developer update

2021-09-02T08:06:09Z

Fox: /* The core_courseformat subsystem */

{{Moodle 4.0}}This page will highlight the important changes that are coming in Moodle 4.0 for developers. Including how the UX improvements impact custom themes, relevant API changes, and what you can do as developer to prepare for the 4.0 release.
== UX and theme changes ==
== Component library ==
== Navigation ==
== The core_courseformat subsystem ==
Most of the logic for rendering and editing a course has been moved to a new subsystem called courseformat. The subsystem is located at "course/format" folder so it includes all the format plugins inside. The methods and modules which are distributes between the course and the course/format folders are now rearranged or refactored to be aligned with the current Moodle coding style. The major affected specifications are:

* Now format plugins must provide a renderer, which is not optional anymore
* The old base_format which plugins extends is now core_courseformat\base
* The methods to render a course are now deprecated and moved to output classes
* The majority of the javascript logic of the course editing is replaced by a new course editor AMD module. The old libraries are still available for third party formats but will eventually replace the previous ones.
* Gradually, all tests and templates are being moved to the subsystem folder

== API changes ==
== Behat changes ==
To make behat tests more readable and easy to maintain, it is recommended to use the most direct steps to get what the test needs. So since MDL-66335 was integrated, and the step was improved in MDL-72179 is highly recommended to use
I am on the "Activity name" "[modname] activity" page
or
I am on the "Activity name" "[modname] activity" page logged in as "user"
instead of navigating to the activity via
I am on "Course" course homepage
I follow "Activity name"
Now that [https://docs.moodle.org/dev/Prototypes#Course_creation_improvements Course index] (MDL-71209) is integrated but the project is not stable, these behat steps
I am on "Course" course homepage
I follow "Activity name"
will fail using Boost theme.

The reason for it is that the drawer used in Boost is hiding the course index. So when the test is trying to follow an "Activity name" link, it finds two different links:
* one in the course index
* another one in the course main content.
But the first one, the one in the course index, is hidden by the drawer, and the test fails.

However the recommended behat steps
I am on the "Activity name" "[modname] activity" page
or
I am on the "Activity name" "[modname] activity" page logged in as "user"
work '''fine'''.

Some of the failing behats are fixed in https://github.com/ferranrecio/moodle/commit/c79d58a50b48aa6891ff1d3ba92a7b0ab2393c88#diff-fdf8b0b1eade3b69eaad038de0ddd7c8dec2be7afa32dc693fb929739a49fa9dR32 - MDL-71209

For example:
And I am on the "Test assignment name" "assign activity" page logged in as teacher1
instead of:
When I log in as "teacher1"
And I am on "Course" course homepage
And I follow "Test assignment name"
== Core plugins review ==
A few plugins from core Moodle LMS which are no longer or hardly used have been removed and, if appropriate, added to the Moodle plugins directory.

More information about this project, the list of plugins to be removed and the process to follow for keeping them before upgrading to 4.0 can be found in the [[Core plugins review]] page.

JavaScript namespacing proposal

2021-08-26T11:31:07Z

Fox: New table coding

{{obsolete}}
The idea of JavaScript namespacing was raised during the developers meeting that occured on Tuesday 29th September 2009 and I think its a fantastic idea, so I wrote this wee proposal and plan to hopefully win people over and get this is in for Moodle 2.0.

Note: This proposal assumes that the patch proposed for MDL-16699 that splits javascript-static into two files and moves JavaScript that is only being used in a single place within Moodle to a file that can be included by the code that uses it.

===Concept===
The concept is to apply a namespacing scheme to the JavaScript that is used by Moodle core code. By namespacing the JavaScript we can better define the structure of the JavaScript code as well as hopefully make it both more easily accessible and with any luck make it easier to develop JavaScript that is potentially reusable.

===The root namespace===
After discussing this with the development team it was decided that the core namespace will be <strong>M</strong>. The original concept was to go with MOODLE however we decided that there was no need to go with the so many characters where one would do, and this fit in with the changes YUI was making in the release of version 3.0 changing their root namespace from <strong>YAHOO</strong> to <strong>Y</strong>.

===Core namespaces===
The following are namspaces that will be created in order to support the initial conversion to a namespaced JavaScript core.
; control : JavaScript that creates controls, or structures used throughout Moodle.
; dom : JavaScript for interacting with the DOM.
; form : JavaScript for interacting with forms.
; util : Miscellaneous JavaScript functions.
; user : JavaScript that is utilised in direct respect to the user.

===Creating new namespaces===
Ideally additional code (or as it is being converted) should be namespaced directly after M with a name fitting to the PHP code. For modules this would be the module name e.g. M.forum .

===Time estimate===
I think it would take a day to namespace the JavaScript files, and then a further day or two to convert the function calls and test.
It is a reasonably simple procedure and with all of the JavaScript clean up that has gone into head already there should be realivily few edge cases left.

===Implementation===
The implementation of the core namespace and supporting functions to further namespace is reasonably simple, however it would need to be the very first bit of Moodle JavaScript to be executed. This simply means it would be defined and set up within javascript-priority.js which is the first file to be included in the HTML head.

===Conversion of JavaScript files===
====lib/javascript-static.js====
{| class="wikitable" width='80%'
|-
! width='20%' | Declaration
! Namespaced declaration
! width='20%' | Declaration type
|-
| block_hider
| M.util.block_hider
| object
|-
| checkall
| M.form.check_all
| function
|-
| checknone
| M.form.check_none
| function
|-
| collapsible_region
| M.dom.collapsible_region
| object
|-
| deselect_all_in
| M.form.deselect_all_in
| function
|-
| findParentNode
| M.dom.find_parent
| function
|-
| fix_column_width
| M.util.fix_column_width
| function
|-
| fix_column_widths
| M.util.fix_column_widths
| function
|-
| focuscontrol
| M.form.set_focus
| function
|-
| frame_breakout
| M.frame.add_breakout_target
| function
|-
| init_help_icons
| M.util.init_help_icons
| function
|-
| openpopup
| M.util.window.popup
| function
|-
| select_all_in
| M.form.select_all_in
| function
|-
| submit_form_by_id
| M.form.submit_form_by_id
| function
|-
| emoticons_help
| M.util.emoticons_help
| object
|-
| old_onload_focus
| To be depreacted as part of MDL-19740
|
|}

====lib/javascript-priority.js====
{| class="wikitable" width='80%'
|-
! width='20%' | Declaration
! Namespaced declaration
! width='20%' | Declaration type
|-
| build_querystring
| M.util.build_query_string
| function
|-
| cancel_scroll_to_end
| M.util.scroll.cancel_autoscroll
| function
|-
| close_window
| M.util.window.close
| function
|-
| close_window_reload
| M.util.window.reload_close
| function
|-
| confirm_dialog
| M.control.confirmdialog
| object
|-
| create_UFO_object
| M.control.ufo.create
| function
|-
| destroy_item
| M.dom.element.remove
| function
|-
| getElementsByClassName
| Should really be deprecated in favour of YUI equivilant
|
|-
| hide_item
| M.dom.element.hide
| function
|-
| json_decode
| M.util.json.decode
| function
|-
| json_encode
| M.util.json.encode
| function
|-
| repeatedly_scroll_t
| M.util.scroll.autoscroll
| function
|-
| scroll_to_end
| M.util.scroll.bottom
| function
|-
|
| M.util.scroll.top
| function
|-
| set_user_preference
| M.user.set_preference
| function
|-
| show_item
| M.dom.element.show
| function
|-
| stripHTML
| M.util.strip_html
| function
|-
| unmaskPassword
| M.form.unmask_password
| function
|-
| update_progress_bar
| M.control.progressbar.update
| function
|}

====lib/javascript-navigation.js====
{| class="wikitable" width='80%'
|-
! width='20%' | Declaration
! Namespaced declaration
! width='20%' | Declaration type
|-
| create_shadow
| M.control.shadow.create
| function
|-
| move_all_sidetabs_t...
| M.control.dock.undock_all
| function
|-
| navigation_tab_panel
| M.control.dock
| object
|-
| navigation_tree
| M.control.tree
| object
|-
| navigation_tree_branch
| M.control.tree.branch
| object
|-
| remove_shadow
| M.control.shadow.remove
| function
|-
| setup_new_navtree
| M.control.tree.init
| function
|}

====lib/javascript-deprecated.js====
{| class="wikitable" width='80%'
|-
! width='20%' | Declaration
! Namespaced declaration
! width='20%' | Declaration type
|-
| deprecate
| M.util.deprecate
| function
|-
| deprecated_addonload
| M.util.deprecated.addonload
| function
|-
| deprecated_confirm_if
| M.util.deprecated.confirm_if
| function
|-
| submitFormById
| M.util.deprecated.submitFormById
| function
|}

====lib/form/form.js====
{| class="wikitable" width='80%'
|-
! width='20%' | Declaration
! Namespaced declaration
! width='20%' | Declaration type
|-
| date_selector_calendar
| M.form.mforms.date_selector.calendar
| object
|-
| elementShowAdvanced
| M.form.mforms.show_advanced.show
| function
|-
| get_form_element_value
| M.form.mforms.get_element_value
| function
|-
| init_date_selectors
| M.form.mforms.date_selector.init
| function
|-
| lockoptionsall
| M.form.mforms.lockoptionsall
| function
|-
| lockoptionsallsetup
| M.form.mforms.lockoptionsallsetup
| function
|-
| set_form_element_disabled
| M.form.mforms.disable_element
| funciton
|-
| showAdvancedInit
| M.form.mforms.show_advanced.init
| function
|-
| showAdvancedOnClick
| M.form.mforms.show_advanced.handle_click
| function
|}

===Resulting namespaced structure===
*<strong>M</strong>
**<strong>control</strong>
***<em>confirmdialog</em>
***<em>dock</em>
****undock_all
***<em>tree</em>
****<em>branch</em>
***progressbar
****update
***shadow
****create
****remove
***ufo
****create
**<strong>dom</strong>
***<strong>element</strong>
****hide
****remove
****show
***collapsible_region
***find_parent
**<strong>form</strong>
***<strong>mforms</strong>
****<strong>date_selector</strong>
*****calendar
*****init
****<strong>show_advanced</strong>
*****init
*****handle_click
*****show
****get_element_value
****lockoptionsall
****lockoptionsallsetup
****disable_element
***check_all
***check_none
***deselect_all_in
***set_focus
***select_all_in
***submit_form_by_id
***unmask_password
**<strong>util</strong>
***<strong>deprecated</strong>
****addonload
****confirm_if
****submitFormById
***<strong>json</strong>
****decode
****encode
***<strong>scroll</strong>
****autoscroll
****bottom
****top
***<strong>window</strong>
****close
****popup
****reload_close
***block_hider
***fix_column_width
***fix_column_widths
***init_help_icons
***emoticons_help
***build_query_string
***strip_html
***deprecate
**<strong>user</strong>
***set_preference

===Why bother?===
Because ....
# It greatly reduces the chances of developers accidentally creating clashing methods, or variables. Not just with core code but more importantly conflicts that may arise between 3rd party extensions.
# Hopefully make the JavaScript code more usable and obvious by providing better organisation and structure. This will in turn hopefully reduce the number of identical functions that arise.
# It's the sort of thing that can only be done when revision of code is necessary and there's no time like a major release for that.
# It looks better, more organised.

===Questions===
To answer a few quick questions about the process:

; How long would it take to namespace the JavaScript : It wouldn't take very long at all to go through and apply a namespacing scheme to the JavaScript once the structure has been decided upon. Once the JavaScript has been namespaced it would be a simple case of iterating through the files that make up Moodle and converting references to the original JavaScript functions to their namespaced equivalents.

; Does all JavaScript have to be namespaced : No not at all. Initially only the core JavaScript files would be converted. After this it would be up to developers to namespace their code should they choose to.... it would be the perfect opportunity to revise that legacy JavaScript ;)

; What about code that uses the old function calls? : All of the core uses should be converted as part of the task of namespacing however we certainly need to support the old function calls. We will create mapping functions that simply take a call to a non-namespaced function and pass it to its namespaced equivalent.

; Will any of the JavaScript change? : No. A couple of new internal functions will be introduced to support namespacing however the actual JavaScript functions being namespaced will not change. You will still be able to call them as you did before, you will just need to use the namespaced reference.

Moodle 3.11 release notes

2021-04-22T10:05:32Z

Fox: /* For administrators */ Typo

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for 10 May 2021

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.11%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.11].

If you are upgrading from a previous version, please see [[:en:Upgrading|Upgrading]] in the user docs.

==Server requirements==

These are just the minimum supported versions. We recommend keeping all of your software and operating systems up-to-date.

* Moodle upgrade: Moodle 3.6 or later
* PHP version: minimum PHP 7.3.0 ''Note: minimum PHP version has increased since Moodle 3.10''. PHP 7.4.x is supported too. [[Moodle and PHP|PHP 8.0 support]] is being implemented (@ MDL-70745) and '''not ready for production''' yet.
* PHP extension '''sodium''' is now required.

=== Database requirements ===

Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.

{| class="nicetable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 9.6
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.7
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 10.2.29
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2017 (increased since Moodle 3.10)
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 11.2
| Latest
|}

==Client requirements==

=== Browser support ===

Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge

''Note: Moodle 3.10 does NOT support Internet Explorer 11.''

Safari 7 and below has known compatibility issues with Moodle 3.10.

Mobile:
* MobileSafari
* Google Chrome

For the best experience and optimum security, we recommend that you keep your browser up to date. https://www.whatsmybrowser.org/

==Major features==

==Other highlights==

===For administrators===

* MDL-67748 - Web services configuration is now located in ''Site administration > Server'' section. Tokens management was improved to allow searching and filtering.

==Security issues==

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==For developers==

===Web service additions and updates===

* MDL-71169 - All new external functions implementation classes should use <tt>execute</tt> as the method name, in which case the <tt>methodname</tt> property should not be specified in db/services.php file

==See also==
*[[Moodle 3.10 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.11]]

[[fr:Notes de mise à jour de Moodle 3.11]]
[[es:Notas de Moodle 3.11]]

Moodle 3.9.6 release notes

2021-03-25T07:59:59Z

Fox: Corrected French link

[[Releases]] > {{FULLPAGENAME}}

Release date: 25 March 2021

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.9.6%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.9.6].

===Regression fix===

* MDL-71182 - Revert latest calendar/data request changes (revert MDL-67494)

==Other fixes==

* MDL-66025 - It's possible to send an empty message to course participants

==Accessibility improvements==

* MDL-70992 - Folder: Unnecessary tab stops to the left of files

==Security improvements==

* MDL-71068 - Usernames or emails can be enumerated under certain conditions with $CFG->protectusernames on

==See also==

*[[Moodle 3.9.5 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.9]]

[[fr:Notes de mise à jour de Moodle 3.9.6]]
[[es:Notas de Moodle 3.9.6]]

Moodle 3.10.1 release notes

2021-01-22T08:25:26Z

Fox: Warning like for Moodle 3.9.4

[[Releases]] > {{FULLPAGENAME}}

Release date: 18 January 2021

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.10.1%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.10.1].

==Warning - courses with many sections==
If you use a custom course format, and your courses need to have a large number of sections (more than 52), for this release you may need to implement the method get_max_sections() in your custom course format's lib.php file, to set a higher limit than the default. The default comes from get_max_sections() in course/format/lib.php - you can copy this method into your course format's lib file and use whatever maximum you need.

==General fixes and improvements==
* MDL-54907 - Automatically submitted quiz attempts: finish time is set to when cron ran, not when the attempt ended
* MDL-69964 - The "Select all X users" button doesn't activate the drop-down menu in Participants Page
* MDL-68896 - SCORM error in Chrome because of "XHR in page dismissal" policy change
* MDL-67623 - Course overview (my courses block) pagination is broken beyond the second page
* MDL-56119 - Rubric display layout issue, after students feedback is released
* MDL-50955 - Lesson module error on save - Cannot find grade item for 'lesson'
* MDL-65941 - Redis server issues break cache configuration page
* MDL-70285 - The MDL-69687 upgrade step kills large databases
* MDL-69526 - Custom field values in course overview block follow incorrect order
* MDL-65852 - Non-editing teacher should be able to download course participants list
* MDL-70265 - Reduce the number of phpunit runs in core's .travis.yml
* MDL-70386 - Illegible css coloring of correct/incorrect div
* MDL-69930 - Duplication items in drag-onto-image question
* MDL-70276 - Add support for github actions to moodle.git
* MDL-70355 - Multilang Filters not applied to Calendar block
* MDL-70063 - [Youtube Plugin] Selecting a category results in <data could not be obtained> error
* MDL-67513 - View conversation link does not work when grading in full screen mode
* MDL-70558 - Available language packs unsorted, difficult to locate
* MDL-69868 - H5P corrupts USER object, causing forum error
* MDL-70426 - Drag-drop markers questions: infinite markers keep duplicating
* MDL-70065 - Quiz add questions from question bank: problem with paging & show all
* MDL-62707 - codingerror in Global Search when "search within enrolled courses only" is set
* MDL-70430 - OAuth2 system account's refresh token does not get updated due to a typo
* MDL-70148 - Write new keyboard steps for Behat
* MDL-69955 - Question type Drag and Drop: drop zone disappear in special case
* MDL-70320 - Incorrect HTML escaping on the override permissions screen
* MDL-70261 - Upload Courses tool breaks on locked custom fields
* MDL-70153 - Qtype_essay file-size limit: it says "0 bytes" for students when "Site upload limit" is set
* MDL-70436 - On mobile, the Quiz confirmation modal has it's close button cut off
* MDL-70373 - Atto HTML editor lacks border outside Moodle forms (e.g. Essay questions)
* MDL-70374 - Layout of multiple choice questions not well aligned
* MDL-70520 - Moodle upgrade resets scheduled tasks lastruntime
* MDL-70117 - PDF dataformat export: content can overflow when page headers are involved
* MDL-70072 - Date in message system (always in Gregorian)
* MDL-70237 - Payment modal breaks if there is html in a gateway description
* MDL-70248 - Drag and Drop onto images: Drop zones have UI issue in Editing form
* MDL-67636 - Locking grade category exposes hidden item grades on user report
* MDL-70352 - Modal forms stay on the screen if you have multiple modals on one page
* MDL-70580 - Privacy export tree navigation non-functional since MDL-69559
* MDL-70567 - Task logs page doesn't respect result filter when moving through the pagination
* MDL-70009 - Course with H5P element in content bank can not be deleted by Manager/Teacher role (with appropriate rights)

==Accessibility improvements==
* MDL-69841 - Edit Quiz, click on help icon under review options group will check / uncheck the checkbox
* MDL-69422 - HTML validation and accessibility problems on database export page
* MDL-69301 - Focus order in tabs
* MDL-70094 - Question preview: Technical info section expands if you click the help icon there

==Security improvements==
* MDL-69877 - Set up a security.txt file in Moodle LMS

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.10 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.10]]

[[fr:Notes de mise à jour de Moodle 3.10.1]]
[[es:Notas de Moodle 3.10.1]]

Releases

2020-09-15T14:20:20Z

Fox: /* Moodle 3.8 */

This page lists all official releases of Moodle, grouped by branch in reverse chronological order.

==Version support==

From Moodle 2.6 onwards, the end of support, both general and security, happens the second Monday of May and November, observing the 12, 18... month periods, no matter if the major release was delayed or not.

The most recent [https://en.wikipedia.org/wiki/Long-term_support long-term support release (LTS)] version is Moodle 3.9.

{| class="wikitable" border="1px solid #dee2e6;"
|-
! style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: rgba(0, 0, 0, 0.05);" | Version
! style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: rgba(0, 0, 0, 0.05);" | Release status
! style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: rgba(0, 0, 0, 0.05);" | Initial release
! style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:rgba(0, 0, 0, 0.05);" | General support ends
! style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: rgba(0, 0, 0, 0.05);" | Security support ends
|-
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 3.5 (LTS)
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:#239cae; padding: .3rem 0.5rem 0.3rem 0.5rem;" | Current security
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 17 May 2018
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 13 May 2019
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 10 May 2021
|-
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 3.7
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:#239cae; padding: .3rem 0.5rem 0.3rem 0.5rem;" | Current security
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 20 May 2019
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 11 May 2020
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 9 November 2020
|-
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 3.8
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:#f98012; padding: .3rem 0.5rem 0.3rem 0.5rem;" | Current stable
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 18 November 2019
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 9 November 2020
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 10 May 2021
|-
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 3.9 (LTS)
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:#f98012; padding: .3rem 0.5rem 0.3rem 0.5rem;" | Current stable
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 15 June 2020
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 10 May 2021
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | 8 May 2023
|}
[[Image:releasescurrent.png|alt=Release graph]]

<b>Release graph key:</b>
{| class="wikitable" border="1px solid #dee2e6;"
|-
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:#f98012; padding: .3rem 0.5rem 0.3rem 0.5rem;" | Current stables
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: rgba(0, 0, 0, 0.05);" | Currently supported stable releases.
|-
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:#239cae; padding: .3rem 0.5rem 0.3rem 0.5rem;" | Current security
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | Current release of versions still receiving security-only updates.
|-
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:#9cbd50; padding: .3rem 0.5rem 0.3rem 0.5rem;" | Future stables
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: rgba(0, 0, 0, 0.05);" | Future point releases receiving bug fixes, as well as security updates.
|-
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:#316d5e; color:white; adding: .3rem 0.5rem 0.3rem 0.5rem;" | Future security
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | Future point releases receiving security-only updates.
|-
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:#686566; color:white; padding: .3rem 0.5rem 0.3rem 0.5rem;" | Past stables
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: rgba(0, 0, 0, 0.05);" | Previously released versions containing bug fixes, as well as security updates. Updating to a currently supported version is recommended.
|-
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color:#282828; color:white; padding: .3rem 0.5rem 0.3rem 0.5rem;" | Past security
| style="vertical-align: top; border-top: 1px solid #dee2e6; background-color: #FFFFFF" | Previously released versions containing security updates only. Updating to a currently supported version is recommended.
|}

==General release calendar==

These are the target dates for releases. These dates may vary slightly due to unforeseen circumstances.

{| class="nicetable"
|-
! Release type
! Frequency
! Months
|-
| [[Process#Major_release_cycles|Major]] (eg. 3.x)
| 6 monthly
| Second Monday of May and November
|-
| [[Process#Stable_maintenance_cycles|Minor]] (Point) (eg. 3.x.y)
| 2 monthly
| Second Monday of July, September, November, January, March and May
|}

All releases are preceded by a one week warning. Upcoming release dates can be found in the [https://www.google.com/calendar/ical/moodle.com_p4c2oe7hsb77ltaro5qtihb5d4%40group.calendar.google.com/public/basic.ics Moodle development calendar] (Note, this is an iCAL link that will try to add the dates to your personal calendar. If you just want to browse the dates online, use [https://calendar.google.com/calendar/embed?src=moodle.com_p4c2oe7hsb77ltaro5qtihb5d4@group.calendar.google.com&pli=1 this link].).

==Moodle 3.9 (LTS)==

{| class="nicetable"
|-
! Moodle 3.9
| 15 June 2020
| 2020061500
| [[Moodle 3.9 release notes|Release Notes]]
| [https://docs.moodle.org/39/en/Upgrading Upgrading to 3.9]
|-
! Moodle 3.9.1
| 13 July 2020
| 2020061501
| [[Moodle 3.9.1 release notes|Release Notes]]
|
|-
! Moodle 3.9.2
| 14 September 2020
| 2020061502
| [[Moodle 3.9.2 release notes|Release Notes]]
|
|}

Bug fixes for general core bugs in 3.9.x will end 10 May 2021 (12 months).
Bug fixes for security issues in 3.9.x will end 8 May 2023 (36 months).

==Moodle 3.8==

{| class="nicetable"
|-
! Moodle 3.8
| 18 November 2019
| 2019111800
| [[Moodle 3.8 release notes|Release Notes]]
| [https://docs.moodle.org/38/en/Upgrading Upgrading to 3.8]
|-
! Moodle 3.8.1
| 13 January 2020
| 2019111801
| [[Moodle 3.8.1 release notes|Release Notes]]
|
|-
! Moodle 3.8.2
| 9 March 2020
| 2019111802
| [[Moodle 3.8.2 release notes|Release Notes]]
|
|-
! Moodle 3.8.3
| 11 May 2020
| 2019111803
| [[Moodle 3.8.3 release notes|Release Notes]]
|
|-
! Moodle 3.8.4
| 13 July 2020
| 2019111804
| [[Moodle 3.8.4 release notes|Release Notes]]
|
|-
! Moodle 3.8.5
| 14 September 2020
| 2019111805
| [[Moodle 3.8.5 release notes|Release Notes]]
|
|}

Bug fixes for general core bugs in 3.8.x will end 9 November 2020 (12 months).
Bug fixes for security issues in 3.8.x will end 10 May 2021 (18 months).

==Moodle 3.7==

{| class="nicetable"
|-
! Moodle 3.7
| 20 May 2019
| 2019052000
| [[Moodle 3.7 release notes|Release Notes]]
| [https://docs.moodle.org/37/en/Upgrading Upgrading to 3.7]
|-
! Moodle 3.7.1
| 8 July 2019
| 2019052001
| [[Moodle 3.7.1 release notes|Release Notes]]
|
|-
! Moodle 3.7.2
| 9 September 2019
| 2019052002
| [[Moodle 3.7.2 release notes|Release Notes]]
|
|-
! Moodle 3.7.3
| 11 November 2019
| 2019052003
| [[Moodle 3.7.3 release notes|Release Notes]]
|
|-
! Moodle 3.7.4
| 13 January 2020
| 2019052004
| [[Moodle 3.7.4 release notes|Release Notes]]
|
|-
! Moodle 3.7.5
| 9 March 2020
| 2019052005
| [[Moodle 3.7.5 release notes|Release Notes]]
|
|-
! Moodle 3.7.6
| 11 May 2020
| 2019052006
| [[Moodle 3.7.6 release notes|Release Notes]]
|
|-
! Moodle 3.7.7
| 13 July 2020
| 2019052007
| [[Moodle 3.7.7 release notes|Release Notes]]
|
|-
! Moodle 3.7.8
| 14 September 2020
| 2019052008
| [[Moodle 3.7.8 release notes|Release Notes]]
|
|}

Bug fixes for general core bugs in 3.7.x ended 11 May 2020 (12 months).
Bug fixes for security issues in 3.7.x will end 9 November 2020 (18 months).

==Moodle 3.6==

{| class="nicetable"
|-
! Moodle 3.6
| 3 December 2018
| 2018120300
| [[Moodle 3.6 release notes|Release Notes]]
| [https://docs.moodle.org/36/en/Upgrading Upgrading to 3.6]
|-
! Moodle 3.6.1
| 5 December 2018
| 2018120301
| [[Moodle 3.6.1 release notes|Release Notes]]
|
|-
! Moodle 3.6.2
| 14 January 2019
| 2018120302
| [[Moodle 3.6.2 release notes|Release Notes]]
|
|-
! Moodle 3.6.3
| 11 March 2019
| 2018120303
| [[Moodle 3.6.3 release notes|Release Notes]]
|
|-
! Moodle 3.6.4
| 13 May 2019
| 2018120304
| [[Moodle 3.6.4 release notes|Release Notes]]
|
|-
! Moodle 3.6.5
| 8th July 2019
| 2018120305
| [[Moodle 3.6.5 release notes|Release Notes]]
|
|-
! Moodle 3.6.6
| 9th September 2019
| 2018120306
| [[Moodle 3.6.6 release notes|Release Notes]]
|
|-
! Moodle 3.6.7
| 11th November 2019
| 2018120307
| [[Moodle 3.6.7 release notes|Release Notes]]
|
|-
! Moodle 3.6.8
| 13th January 2020
| 2018120308
| [[Moodle 3.6.8 release notes|Release Notes]]
|
|-
! Moodle 3.6.9
| 9th March 2020
| 2018120309
| [[Moodle 3.6.9 release notes|Release Notes]]
|
|-
! Moodle 3.6.10
| 11th May 2020
| 2018120310
| [[Moodle 3.6.10 release notes|Release Notes]]
|
|}

Bug fixes for general core bugs in 3.6.x ended 11 November 2019 (12 months).
Bug fixes for security issues in 3.6.x ended 11 May 2020 (18 months).

==Moodle 3.5 (LTS)==

{| class="nicetable"
|-
! Moodle 3.5
| 17 May 2018
| 2018051700
| [[Moodle 3.5 release notes|Release Notes]]
| [https://docs.moodle.org/35/en/Upgrading Upgrading to 3.5]
|-
! Moodle 3.5.1
| 9 July 2018
| 2018051701
| [[Moodle 3.5.1 release notes|Release Notes]]
|
|-
! Moodle 3.5.2
| 10 September 2018
| 2018051702
| [[Moodle 3.5.2 release notes|Release Notes]]
|
|-
! Moodle 3.5.3
| 12 November 2018
| 2018051703
| [[Moodle 3.5.3 release notes|Release Notes]]
|
|-
! Moodle 3.5.4
| 14 January 2019
| 2018051704
| [[Moodle 3.5.4 release notes|Release Notes]]
|
|-
! Moodle 3.5.5
| 11 March 2019
| 2018051705
| [[Moodle 3.5.5 release notes|Release Notes]]
|
|-
! Moodle 3.5.6
| 13 May 2019
| 2018051706
| [[Moodle 3.5.6 release notes|Release Notes]]
|
|-
! Moodle 3.5.7
| 8 July 2019
| 2018051707
| [[Moodle 3.5.7 release notes|Release Notes]]
|
|-
! Moodle 3.5.8
| 9 September 2019
| 2018051708
| [[Moodle 3.5.8 release notes|Release Notes]]
|
|-
! Moodle 3.5.9
| 11 November 2019
| 2018051709
| [[Moodle 3.5.9 release notes|Release Notes]]
|
|-
! Moodle 3.5.10
| 13 January 2020
| 2018051710
| [[Moodle 3.5.10 release notes|Release Notes]]
|
|-
! Moodle 3.5.11
| 9 March 2020
| 2018051711
| [[Moodle 3.5.11 release notes|Release Notes]]
|
|-
! Moodle 3.5.12
| 11 May 2020
| 2018051712
| [[Moodle 3.5.12 release notes|Release Notes]]
|
|-
! Moodle 3.5.13
| 13 July 2020
| 2018051713
| [[Moodle 3.5.13 release notes|Release Notes]]
|
|-
! Moodle 3.5.14
| 14 September 2020
| 2018051714
| [[Moodle 3.5.14 release notes|Release Notes]]
|
|}

Bug fixes for general core bugs in 3.5.x ended May 2019 (12 months).
Bug fixes for security issues in 3.5.x will end 10 May 2021 (36 months).

==Moodle 3.4==

{| class="nicetable"
|-
! Moodle 3.4
| 13 November 2017
| 2017111300
| [[Moodle 3.4 release notes|Release Notes]]
| [https://docs.moodle.org/34/en/Upgrading Upgrading to 3.4]
|-
! Moodle 3.4.1
| 15 January 2018
| 2017111301
| [[Moodle 3.4.1 release notes|Release Notes]]
|
|-
! Moodle 3.4.2
| 19 March 2018
| 2017111302
| [[Moodle 3.4.2 release notes|Release Notes]]
|
|-
! Moodle 3.4.3
| 17 May 2018
| 2017111303
| [[Moodle 3.4.3 release notes|Release Notes]]
|
|-
! Moodle 3.4.4
| 9 July 2018
| 2017111304
| [[Moodle 3.4.4 release notes|Release Notes]]
|
|-
! Moodle 3.4.5
| 10 September 2018
| 2017111305
| [[Moodle 3.4.5 release notes|Release Notes]]
|
|-
! Moodle 3.4.6
| 12 November 2018
| 2017111306
| [[Moodle 3.4.6 release notes|Release Notes]]
|
|-
! Moodle 3.4.7
| 14 January 2019
| 2017111307
| [[Moodle 3.4.7 release notes|Release Notes]]
|
|-
! Moodle 3.4.8
| 11 March 2019
| 2017111308
| [[Moodle 3.4.8 release notes|Release Notes]]
|
|-
! Moodle 3.4.9
| 13 May 2019
| 2017111309
| [[Moodle 3.4.9 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 3.4.x ended 12 November 2018 (12 months).
Bug fixes for security issues in 3.4.x ended 13 May 2019 (18 months).

==Moodle 3.3==

{| class="nicetable"
|-
! Moodle 3.3
| 15 May 2017
| 2017051500
| [[Moodle 3.3 release notes|Release Notes]]
| [https://docs.moodle.org/33/en/Upgrading Upgrading to 3.3]
|-
! Moodle 3.3.1
| 10 July 2017
| 2017051501
| [[Moodle 3.3.1 release notes|Release Notes]]
|
|-
! Moodle 3.3.2
| 11 September 2017
| 2017051502
| [[Moodle 3.3.2 release notes|Release Notes]]
|
|-
! Moodle 3.3.3
| 13 November 2017
| 2017051503
| [[Moodle 3.3.3 release notes|Release Notes]]
|
|-
! Moodle 3.3.4
| 15 January 2018
| 2017051504
| [[Moodle 3.3.4 release notes|Release Notes]]
|
|-
! Moodle 3.3.5
| 19 March 2018
| 2017051505
| [[Moodle 3.3.5 release notes|Release Notes]]
|
|-
! Moodle 3.3.6
| 17 May 2018
| 2017051506
| [[Moodle 3.3.6 release notes|Release Notes]]
|
|-
! Moodle 3.3.7
| 9 July 2018
| 2017051507
| [[Moodle 3.3.7 release notes|Release Notes]]
|
|-
! Moodle 3.3.8
| 10 September 2018
| 2017051508
| [[Moodle 3.3.8 release notes|Release Notes]]
|
|-
! Moodle 3.3.9
| 12 November 2018
| 2017051509
| [[Moodle 3.3.9 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 3.3.x ended 17 May 2018 (12 months).
Bug fixes for security issues in 3.3.x ended 12 November 2018 (18 months).

==Moodle 3.2==

{| class="nicetable"
|-
! Moodle 3.2
| 5 December 2016
| 2016120500
| [[Moodle 3.2 release notes|Release Notes]]
| [https://docs.moodle.org/32/en/Upgrading Upgrading to 3.2]
|-
! Moodle 3.2.1
| 9 January 2017
| 2016120501
| [[Moodle 3.2.1 release notes|Release Notes]]
|
|-
! Moodle 3.2.2
| 13 March 2017
| 2016120502
| [[Moodle 3.2.2 release notes|Release Notes]]
|
|-
! Moodle 3.2.3
| 8 May 2017
| 2016120503
| [[Moodle 3.2.3 release notes|Release Notes]]
|
|-
! Moodle 3.2.4
| 10 July 2017
| 2016120504
| [[Moodle 3.2.4 release notes|Release Notes]]
|
|-
! Moodle 3.2.5
| 11 September 2017
| 2016120505
| [[Moodle 3.2.5 release notes|Release Notes]]
|
|-
! Moodle 3.2.6
| 13 November 2017
| 2016120506
| [[Moodle 3.2.6 release notes|Release Notes]]
|
|-
! Moodle 3.2.7
| 15 January 2018
| 2016120507
| [[Moodle 3.2.7 release notes|Release Notes]]
|
|-
! Moodle 3.2.8
| 19 March 2018
| 2016120508
| [[Moodle 3.2.8 release notes|Release Notes]]
|
|-
! Moodle 3.2.9
| 17 May 2018
| 2016120509
| [[Moodle 3.2.9 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 3.2.x ended 13 November 2017 (12 months).
Bug fixes for security issues in 3.2.x ended 17 May 2018 (18 months).

==Moodle 3.1 (LTS)==

{| class="nicetable"
|-
! Moodle 3.1
| 23 May 2016
| 2016052300
| [[Moodle 3.1 release notes|Release Notes]]
| [https://docs.moodle.org/31/en/Upgrading Upgrading to 3.1]
|-
! Moodle 3.1.1
| 11 July 2016
| 2016052301
| [[Moodle 3.1.1 release notes|Release Notes]]
|
|-
! Moodle 3.1.2
| 12 September 2016
| 2016052302
| [[Moodle 3.1.2 release notes|Release Notes]]
|
|-
! Moodle 3.1.3
| 14 November 2016
| 2016052303
| [[Moodle 3.1.3 release notes|Release Notes]]
|
|-
! Moodle 3.1.4
| 9 January 2017
| 2016052304
| [[Moodle 3.1.4 release notes|Release Notes]]
|
|-
! Moodle 3.1.5
| 13 March 2017
| 2016052305
| [[Moodle 3.1.5 release notes|Release Notes]]
|
|-
! Moodle 3.1.6
| 8 May 2017
| 2016052306
| [[Moodle 3.1.6 release notes|Release Notes]]
|
|-
! Moodle 3.1.7
| 10 July 2017
| 2016052307
| [[Moodle 3.1.7 release notes|Release Notes]]
|
|-
! Moodle 3.1.8
| 11 September 2017
| 2016052308
| [[Moodle 3.1.8 release notes|Release Notes]]
|
|-
! Moodle 3.1.9
| 13 November 2017
| 2016052309
| [[Moodle 3.1.9 release notes|Release Notes]]
|
|-
! Moodle 3.1.10
| 15 January 2018
| 2016052310
| [[Moodle 3.1.10 release notes|Release Notes]]
|
|-
! Moodle 3.1.11
| 19 March 2018
| 2016052311
| [[Moodle 3.1.11 release notes|Release Notes]]
|
|-
! Moodle 3.1.12
| 17 May 2018
| 2016052312
| [[Moodle 3.1.12 release notes|Release Notes]]
|
|-
! Moodle 3.1.13
| 9 July 2018
| 2016052313
| [[Moodle 3.1.13 release notes|Release Notes]]
|
|-
! Moodle 3.1.14
| 10 September 2018
| 2016052314
| [[Moodle 3.1.14 release notes|Release Notes]]
|
|-
! Moodle 3.1.15
| 12 November 2018
| 2016052315
| [[Moodle 3.1.15 release notes|Release Notes]]
|
|-
! Moodle 3.1.16
| 14 January 2019
| 2016052316
| [[Moodle 3.1.16 release notes|Release Notes]]
|
|-
! Moodle 3.1.17
| 11 March 2019
| 2016052317
| [[Moodle 3.1.17 release notes|Release Notes]]
|
|-
! Moodle 3.1.18
| 13 May 2019
| 2016052318
| [[Moodle 3.1.18 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 3.1.x ended 8 May 2017 (12 months).
Bug fixes for security issues in 3.1.x ended 13 May 2019 (36 months).

==Moodle 3.0==

{| class="nicetable"
|-
! Moodle 3.0
| 16 November 2015
| 2015111600
| [[Moodle 3.0 release notes|Release Notes]]
| [https://docs.moodle.org/30/en/Upgrading Upgrading to 3.0]
|-
! Moodle 3.0.1
| 21 December 2015
| 2015111601
| [[Moodle 3.0.1 release notes|Release Notes]]
|
|-
! Moodle 3.0.2
| 11 January 2016
| 2015111602
| [[Moodle 3.0.2 release notes|Release Notes]]
|
|-
! Moodle 3.0.3
| 14 March 2016
| 2015111603
| [[Moodle 3.0.3 release notes|Release Notes]]
|
|-
! Moodle 3.0.4
| 9 May 2016
| 2015111604
| [[Moodle 3.0.4 release notes|Release Notes]]
|
|-
! Moodle 3.0.5
| 11 July 2016
| 2015111605
| [[Moodle 3.0.5 release notes|Release Notes]]
|
|-
! Moodle 3.0.6
| 12 September 2016
| 2015111606
| [[Moodle 3.0.6 release notes|Release Notes]]
|
|-
! Moodle 3.0.7
| 14 November 2016
| 2015111607
| [[Moodle 3.0.7 release notes|Release Notes]]
|
|-
! Moodle 3.0.8
| 9 January 2017
| 2015111608
| [[Moodle 3.0.8 release notes|Release Notes]]
|
|-
! Moodle 3.0.9
| 13 March 2017
| 2015111609
| [[Moodle 3.0.9 release notes|Release Notes]]
|
|-
! Moodle 3.0.10
| 8 May 2017
| 2015111610
| [[Moodle 3.0.10 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 3.0.x ended 14 November 2016 (12 months).
Bug fixes for security issues in 3.0.x ended 8 May 2017 (18 months).

==Moodle 2.9==

{| class="nicetable"
|-
! Moodle 2.9
| 11 May 2015
| 2015051100
| [[Moodle 2.9 release notes|Release Notes]]
| [https://docs.moodle.org/29/en/Upgrading_to_Moodle_2.9 Upgrading to 2.9]
|-
! Moodle 2.9.1
| 6 July 2015
| 2015051101
| [[Moodle 2.9.1 release notes|Release Notes]]
|
|-
! Moodle 2.9.2
| 14 September 2015
| 2015051102
| [[Moodle 2.9.2 release notes|Release Notes]]
|
|-
! Moodle 2.9.3
| 9 November 2015
| 2015051103
| [[Moodle 2.9.3 release notes|Release Notes]]
|
|-
! Moodle 2.9.4
| 11 January 2016
| 2015051104
| [[Moodle 2.9.4 release notes|Release Notes]]
|
|-
! Moodle 2.9.5
| 14 March 2016
| 2015051105
| [[Moodle 2.9.5 release notes|Release Notes]]
|
|-
! Moodle 2.9.6
| 9 May 2016
| 2015051106
| [[Moodle 2.9.6 release notes|Release Notes]]
|
|-
! Moodle 2.9.7
| 11 July 2016
| 2015051107
| [[Moodle 2.9.7 release notes|Release Notes]]
|
|-
! Moodle 2.9.8
| 12 September 2016
| 2015051108
| [[Moodle 2.9.8 release notes|Release Notes]]
|
|-
! Moodle 2.9.9
| 14 November 2016
| 2015051109
| [[Moodle 2.9.9 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.9.x ended 9 May 2016 (12 months).
Bug fixes for security issues in 2.9.x ended 14 November 2016 (18 months).

==Moodle 2.8==

{| class="nicetable"
|-
! Moodle 2.8
| 10 November 2014
| 2014111000
| [[Moodle 2.8 release notes|Release Notes]]
| [https://docs.moodle.org/28/en/Upgrading_to_Moodle_2.8 Upgrading to 2.8]
|-
! Moodle 2.8.1
| 13 November 2014
| 2014111001
| [[Moodle 2.8.1 release notes|Release Notes]]
|
|-
! Moodle 2.8.2
| 12 January 2015
| 2014111002
| [[Moodle 2.8.2 release notes|Release Notes]]
|
|-
! Moodle 2.8.3
| 2 February 2015
| 2014111003
| [[Moodle 2.8.3 release notes|Release Notes]]
|
|-
! Moodle 2.8.4
| 9 March 2015
| 2014111004
| [[Moodle 2.8.4 release notes|Release Notes]]
|
|-
! Moodle 2.8.5
| 10 March 2015
| 2014111005
| [[Moodle 2.8.5 release notes|Release Notes]]
|
|-
! Moodle 2.8.6
| 11 May 2015
| 2014111006
| [[Moodle 2.8.6 release notes|Release Notes]]
|
|-
! Moodle 2.8.7
| 6 July 2015
| 2014111007
| [[Moodle 2.8.7 release notes|Release Notes]]
|
|-
! Moodle 2.8.8
| 14 September 2015
| 2014111008
| [[Moodle 2.8.8 release notes|Release Notes]]
|
|-
! Moodle 2.8.9
| 9 November 2015
| 2014111009
| [[Moodle 2.8.9 release notes|Release Notes]]
|
|-
! Moodle 2.8.10
| 11 January 2016
| 2014111010
| [[Moodle 2.8.10 release notes|Release Notes]]
|
|-
! Moodle 2.8.11
| 14 March 2016
| 2014111011
| [[Moodle 2.8.11 release notes|Release Notes]]
|
|-
! Moodle 2.8.12
| 9 May 2016
| 2014111012
| [[Moodle 2.8.12 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.8.x ended 9 November 2015 (12 months).
Bug fixes for security issues in 2.8.x ended 9 May 2016 (18 months).

==Moodle 2.7 (LTS)==

{| class="nicetable"
|-
! Moodle 2.7
| 12 May 2014
| 2014051200
| [[Moodle 2.7 release notes|Release Notes]]
| [https://docs.moodle.org/27/en/Upgrading_to_Moodle_2.7 Upgrading to 2.7]
|-
! Moodle 2.7.1
| 14 July 2014
| 2014051201
| [[Moodle 2.7.1 release notes|Release Notes]]
|
|-
! Moodle 2.7.2
| 8 September 2014
| 2014051202
| [[Moodle 2.7.2 release notes|Release Notes]]
|
|-
! Moodle 2.7.3
| 10 November 2014
| 2014051203
| [[Moodle 2.7.3 release notes|Release Notes]]
|
|-
! Moodle 2.7.4
| 12 January 2015
| 2014051204
| [[Moodle 2.7.4 release notes|Release Notes]]
|
|-
! Moodle 2.7.5
| 2 February 2015
| 2014051205
| [[Moodle 2.7.5 release notes|Release Notes]]
|
|-
! Moodle 2.7.6
| 9 March 2015
| 2014051206
| [[Moodle 2.7.6 release notes|Release Notes]]
|
|-
! Moodle 2.7.7
| 10 March 2015
| 2014051207
| [[Moodle 2.7.7 release notes|Release Notes]]
|
|-
! Moodle 2.7.8
| 11 May 2015
| 2014051208
| [[Moodle 2.7.8 release notes|Release Notes]]
|
|-
! Moodle 2.7.9
| 6 July 2015
| 2014051209
| [[Moodle 2.7.9 release notes|Release Notes]]
|
|-
! Moodle 2.7.10
| 14 September 2015
| 2014051210
| [[Moodle 2.7.10 release notes|Release Notes]]
|
|-
! Moodle 2.7.11
| 9 November 2015
| 2014051211
| [[Moodle 2.7.11 release notes|Release Notes]]
|
|-
! Moodle 2.7.12
| 11 January 2016
| 2014051212
| [[Moodle 2.7.12 release notes|Release Notes]]
|
|-
! Moodle 2.7.13
| 14 March 2016
| 2014051213
| [[Moodle 2.7.13 release notes|Release Notes]]
|
|-
! Moodle 2.7.14
| 9 May 2016
| 2014051214
| [[Moodle 2.7.14 release notes|Release Notes]]
|
|-
! Moodle 2.7.15
| 11 July 2016
| 2014051215
| [[Moodle 2.7.15 release notes|Release Notes]]
|
|-
! Moodle 2.7.16
| 12 September 2016
| 2014051216
| [[Moodle 2.7.16 release notes|Release Notes]]
|
|-
! Moodle 2.7.17
| 14 November 2016
| 2014051217
| [[Moodle 2.7.17 release notes|Release Notes]]
|
|-
! Moodle 2.7.18
| 9 January 2017
| 2014051218
| [[Moodle 2.7.18 release notes|Release Notes]]
|
|-
! Moodle 2.7.19
| 13 March 2017
| 2014051219
| [[Moodle 2.7.19 release notes|Release Notes]]
|
|-
! Moodle 2.7.20
| 8 May 2017
| 2014051220
| [[Moodle 2.7.20 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.7.x ended 11 May 2015 (12 months).
Bug fixes for security issues in 2.7.x ended 8 May 2017 (36 months).

==Moodle 2.6==

{| class="nicetable"
|-
! Moodle 2.6
| 18 November 2013
| 2013111800
| [[Moodle 2.6 release notes|Release Notes]]
| [https://docs.moodle.org/26/en/Upgrading_to_Moodle_2.6 Upgrading to 2.6]
|-
! Moodle 2.6.1
| 13 January 2014
| 2013111801
| [[Moodle 2.6.1 release notes|Release Notes]]
|
|-
! Moodle 2.6.2
| 10 March 2014
| 2013111802
| [[Moodle 2.6.2 release notes|Release Notes]]
|
|-
! Moodle 2.6.3
| 12 May 2014
| 2013111803
| [[Moodle 2.6.3 release notes|Release Notes]]
|
|-
! Moodle 2.6.4
| 14 July 2014
| 2013111804
| [[Moodle 2.6.4 release notes|Release Notes]]
|
|-
! Moodle 2.6.5
| 8 September 2014
| 2013111805
| [[Moodle 2.6.5 release notes|Release Notes]]
|
|-
! Moodle 2.6.6
| 10 November 2014
| 2013111806
| [[Moodle 2.6.6 release notes|Release Notes]]
|
|-
! Moodle 2.6.7
| 12 January 2015
| 2013111807
| [[Moodle 2.6.7 release notes|Release Notes]]
|
|-
! Moodle 2.6.8
| 2 February 2015
| 2013111808
| [[Moodle 2.6.8 release notes|Release Notes]]
|
|-
! Moodle 2.6.9
| 9 March 2015
| 2013111809
| [[Moodle 2.6.9 release notes|Release Notes]]
|
|-
! Moodle 2.6.10
| 10 March 2015
| 2013111810
| [[Moodle 2.6.10 release notes|Release Notes]]
|
|-
! Moodle 2.6.11
| 11 May 2015
| 2013111811
| [[Moodle 2.6.11 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.6.x ended 10 November 2014 (12 months).
Bug fixes for security issues in 2.6.x ended 11 May 2015 (18 months).

==Moodle 2.5==

{| class="nicetable"
|-
! Moodle 2.5
| 14 May 2013
| 2013051400
| [[Moodle 2.5 release notes|Release Notes]]
| [https://docs.moodle.org/25/en/Upgrading_to_Moodle_2.5 Upgrading to 2.5]
|-
! Moodle 2.5.1
| 8 July 2013
| 2013051401
| [[Moodle 2.5.1 release notes|Release Notes]]
|
|-
! Moodle 2.5.2
| 9 September 2013
| 2013051402
| [[Moodle 2.5.2 release notes|Release Notes]]
|
|-
! Moodle 2.5.3
| 11 November 2013
| 2013051403
| [[Moodle 2.5.3 release notes|Release Notes]]
|
|-
! Moodle 2.5.4
| 13 January 2014
| 2013051404
| [[Moodle 2.5.4 release notes|Release Notes]]
|
|-
! Moodle 2.5.5
| 10 March 2014
| 2013051405
| [[Moodle 2.5.5 release notes|Release Notes]]
|
|-
! Moodle 2.5.6
| 12 May 2014
| 2013051406
| [[Moodle 2.5.6 release notes|Release Notes]]
|
|-
! Moodle 2.5.7
| 14 July 2014
| 2013051407
| [[Moodle 2.5.7 release notes|Release Notes]]
|
|-
! Moodle 2.5.8
| 8 September 2014
| 2013051408
| [[Moodle 2.5.8 release notes|Release Notes]]
|
|-
! Moodle 2.5.9
| 10 November 2014
| 2013051409
| [[Moodle 2.5.9 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.5.x ended May 2014 (12 months).
Bug fixes for security issues in 2.5.x ended 10 November 2014 (18 months).

==Moodle 2.4==

{| class="nicetable"
|-
! Moodle 2.4
| 3 December 2012
| 2012120300
| [[Moodle 2.4 release notes|Release Notes]]
| [https://docs.moodle.org/24/en/Upgrading_to_Moodle_2.4 Upgrading to 2.4]
|-
! Moodle 2.4.1
| 14 January 2013
| 2012120301
| [[Moodle 2.4.1 release notes|Release Notes]]
|
|-
! Moodle 2.4.2
| 11 March 2013
| 2012120302
| [[Moodle 2.4.2 release notes|Release Notes]]
|
|-
! Moodle 2.4.3
| 18 March 2013
| 2012120303
| [[Moodle 2.4.3 release notes|Release Notes]]
|
|-
! Moodle 2.4.4
| 14 May 2013
| 2012120304
| [[Moodle 2.4.4 release notes|Release Notes]]
|
|-
! Moodle 2.4.5
| 8 July 2013
| 2012120305
| [[Moodle 2.4.5 release notes|Release Notes]]
|
|-
! Moodle 2.4.6
| 9 September 2013
| 2012120306
| [[Moodle 2.4.6 release notes|Release Notes]]
|
|-
! Moodle 2.4.7
| 11 November 2013
| 2012120307
| [[Moodle 2.4.7 release notes|Release Notes]]
|
|-
! Moodle 2.4.8
| 13 January 2014
| 2012120308
| [[Moodle 2.4.8 release notes|Release Notes]]
|
|-
! Moodle 2.4.9
| 10 March 2014
| 2012120309
| [[Moodle 2.4.9 release notes|Release Notes]]
|
|-
! Moodle 2.4.10
| 12 May 2014
| 2012120310
| [[Moodle 2.4.10 release notes|Release Notes]]
|
|-
! Moodle 2.4.11
| 14 July 2014
| 2012120311
| [[Moodle 2.4.11 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.4.x ended December 2013 (12 months).
Bug fixes for security issues in 2.4.x ended June 2014 (18 months).

==Moodle 2.3==

{| class="nicetable"
|-
! Moodle 2.3
| 25 June 2012
| 2012062500
| [[Moodle 2.3 release notes|Release Notes]]
| [https://docs.moodle.org/23/en/Upgrading_to_Moodle_2.3 Upgrading to 2.3]
|-
! Moodle 2.3.1
| 9 July 2012
| 2012062501
| [[Moodle 2.3.1 release notes|Release Notes]]
|
|-
! Moodle 2.3.2
| 10 September 2012
| 2012062502
| [[Moodle 2.3.2 release notes|Release Notes]]
|
|-
! Moodle 2.3.3
| 12 November 2012
| 2012062503
| [[Moodle 2.3.3 release notes|Release Notes]]
|
|-
! Moodle 2.3.4
| 14 January 2013
| 2012062504
| [[Moodle 2.3.4 release notes|Release Notes]]
|
|-
! Moodle 2.3.5
| 11 March 2013
| 2012062505
| [[Moodle 2.3.5 release notes|Release Notes]]
|
|-
! Moodle 2.3.6
| 18 March 2013
| 2012062506
| [[Moodle 2.3.6 release notes|Release Notes]]
|
|-
! Moodle 2.3.7
| 14 May 2013
| 2012062507
| [[Moodle 2.3.7 release notes|Release Notes]]
|
|-
! Moodle 2.3.8
| 8 July 2013
| 2012062508
| [[Moodle 2.3.8 release notes|Release Notes]]
|
|-
! Moodle 2.3.9
| 9 September 2013
| 2012062509
| [[Moodle 2.3.9 release notes|Release Notes]]
|
|-
! Moodle 2.3.10
| 11 November 2013
| 2012062510
| [[Moodle 2.3.10 release notes|Release Notes]]
|
|-
! Moodle 2.3.11
| 13 January 2014
| 2012062511
| [[Moodle 2.3.11 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.3.x ended June 2013 (12 months).
Bug fixes for security issues in 2.3.x ended December 2013 (18 months).

==Moodle 2.2==

{| class="nicetable"
|-
! Moodle 2.2
| 5 December 2011
| 2011120500
| [[Moodle 2.2 release notes|Release Notes]]
| [https://docs.moodle.org/22/en/Upgrading_to_Moodle_2.2 Upgrading to 2.2]
|-
! Moodle 2.2.1
| 9 January 2012
| 2011120501
| [[Moodle 2.2.1 release notes|Release Notes]]
|
|-
! Moodle 2.2.2
| 12 March 2012
| 2011120502
| [[Moodle 2.2.2 release notes|Release Notes]]
|
|-
! Moodle 2.2.3
| 14 May 2012
| 2011120503
| [[Moodle 2.2.3 release notes|Release Notes]]
|
|-
! Moodle 2.2.4
| 9 July 2012
| 2011120504
| [[Moodle 2.2.4 release notes|Release Notes]]
|
|-
! Moodle 2.2.5
| 10 September 2012
| 2011120505
| [[Moodle 2.2.5 release notes|Release Notes]]
|
|-
! Moodle 2.2.6
| 12 November 2012
| 2011120506
| [[Moodle 2.2.6 release notes|Release Notes]]
|
|-
! Moodle 2.2.7
| 14 January 2013
| 2011120507
| [[Moodle 2.2.7 release notes|Release Notes]]
|
|-
! Moodle 2.2.8
| 11 March 2013
| 2011120508
| [[Moodle 2.2.8 release notes|Release Notes]]
|
|-
! Moodle 2.2.9
| 18 March 2013
| 2011120509
| [[Moodle 2.2.9 release notes|Release Notes]]
|
|-
! Moodle 2.2.10
| 14 May 2013
| 2011120510
| [[Moodle 2.2.10 release notes|Release Notes]]
|
|-
! Moodle 2.2.11
| 8 July 2013
| 2011120511
| [[Moodle 2.2.11 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.2.x ended December 2012 (12 months).
Bug fixes for security issues in 2.2.x ended June 2013 (18 months).

==Moodle 2.1==

{| class="nicetable"
|-
! Moodle 2.1
| 1 July 2011
| 2011070100
| [[Moodle 2.1 release notes|Release Notes]]
| [https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1 Upgrading to 2.1]
|-
! Moodle 2.1.1
| 1 August 2011
| 2011070101
| [[Moodle 2.1.1 release notes|Release Notes]]
|
|-
! Moodle 2.1.2
| 10 October 2011
| 2011070102
| [[Moodle 2.1.2 release notes|Release Notes]]
|
|-
! Moodle 2.1.3
| 28 November 2011
| 2011070103
| [[Moodle 2.1.3 release notes|Release Notes]]
|
|-
! Moodle 2.1.4
| 9 January 2012
| 2011070104
| [[Moodle 2.1.4 release notes|Release Notes]]
|
|-
! Moodle 2.1.5
| 12 March 2012
| 2011070105
| [[Moodle 2.1.5 release notes|Release Notes]]
|
|-
! Moodle 2.1.6
| 14 May 2012
| 2011070106
| [[Moodle 2.1.6 release notes|Release Notes]]
|
|-
! Moodle 2.1.7
| 9 July 2012
| 2011070107
| [[Moodle 2.1.7 release notes|Release Notes]]
|
|-
! Moodle 2.1.8
| 10 September 2012
| 2011070108
| [[Moodle 2.1.8 release notes|Release Notes]]
|
|-
! Moodle 2.1.9
| 12 November 2012
| 2011070109
| [[Moodle 2.1.9 release notes|Release Notes]]
|
|-
! Moodle 2.1.10
| 14 January 2013
| 2011070110
| [[Moodle 2.1.10 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.1.x ended June 2012 (12 months).
Bug fixes for security issues in 2.1.x ended December 2012 (18 months).

==Moodle 2.0==
{| class="nicetable"
|-
! Moodle 2.0
| 24 November 2010
| 2010112400
| [[Moodle 2.0 release notes|Release Notes]]
| [https://docs.moodle.org/20/en/Upgrading_to_Moodle_2.0 Upgrading to 2.0]
|-
! Moodle 2.0.1
| 25 December 2010
| 2010122500
| [[Moodle 2.0.1 release notes|Release Notes]]
|
|-
! Moodle 2.0.2
| 21 February 2011
| 2011022100
| [[Moodle 2.0.2 release notes|Release Notes]]
|
|-
! Moodle 2.0.3
| 5 May 2011
| 2011033003
| [[Moodle 2.0.3 release notes|Release Notes]]
|
|-
! Moodle 2.0.4
| 1 August 2011
| 2011033004
| [[Moodle 2.0.4 release notes|Release Notes]]
|
|-
! Moodle 2.0.5
| 10 October 2011
| 2011033005
| [[Moodle 2.0.5 release notes|Release Notes]]
|
|-
! Moodle 2.0.6
| 28 November 2011
| 2011033006
| [[Moodle 2.0.6 release notes|Release Notes]]
|
|-
! Moodle 2.0.7
| 9 January 2012
| 2011033007
| [[Moodle 2.0.7 release notes|Release Notes]]
|
|-
! Moodle 2.0.8
| 12 March 2012
| 2011033008
| [[Moodle 2.0.8 release notes|Release Notes]]
|
|-
! Moodle 2.0.9
| 14 May 2012
| 2011033009
| [[Moodle 2.0.9 release notes|Release Notes]]
|
|-
! Moodle 2.0.10
| 9 July 2012
| 2011033010
| [[Moodle 2.0.10 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.0.x ended December 2011 (12 months).
Bug fixes for security issues in 2.0.x ended June 2012 (18 months).

==Moodle 1.9==

{| class="nicetable"
|-
! Moodle 1.9
| 3 March 2008
| 2007101509
| [[Moodle 1.9 release notes|Release Notes]]
| [https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.9 Upgrading to 1.9]
|-
! Moodle 1.9.1
| 15 May 2008
| 2007101512
| [[Moodle 1.9.1 release notes|Release Notes]]
|
|-
! Moodle 1.9.2
| 11 July 2008
| 2007101520
| [[Moodle 1.9.2 release notes|Release Notes]]
|
|-
! Moodle 1.9.3
| 15 October 2008
| 2007101530
| [[Moodle 1.9.3 release notes|Release Notes]]
|
|-
! Moodle 1.9.4
| 28 January 2009
| 2007101540
| [[Moodle 1.9.4 release notes|Release Notes]]
|
|-
! Moodle 1.9.5
| 13 May 2009
| 2007101550
| [[Moodle 1.9.5 release notes|Release Notes]]
|
|-
! Moodle 1.9.6
| 21 October 2009
| 2007101560
| [[Moodle 1.9.6 release notes|Release Notes]]
|
|-
! Moodle 1.9.7
| 25 November 2009
| 2007101570
| [[Moodle 1.9.7 release notes|Release Notes]]
|
|-
! Moodle 1.9.8
| 25 March 2010
| 2007101580.00
| [[Moodle 1.9.8 release notes|Release Notes]]
|
|-
! Moodle 1.9.9
| 8 June 2010
| 2007101590.00
| [[Moodle 1.9.9 release notes|Release Notes]]
|
|-
! Moodle 1.9.10
| 25 October 2010
| 2007101591.00
| [[Moodle 1.9.10 release notes|Release Notes]]
|
|-
! Moodle 1.9.11
| 21 February 2011
| 2007101591.02
| [[Moodle 1.9.11 release notes|Release Notes]]
|
|-
! Moodle 1.9.12
| 10 May 2011
| 2007101591.03
| [[Moodle 1.9.12 release notes|Release Notes]]
|
|-
! Moodle 1.9.13
| 1 August 2011
| 2007101591.04
| [[Moodle 1.9.13 release notes|Release Notes]]
|
|-
! Moodle 1.9.14
| 10 October 2011
| 2007101591.06
| [[Moodle 1.9.14 release notes|Release Notes]]
|
|-
! Moodle 1.9.15
| 28 November 2011
| 2007101591.07
| [[Moodle 1.9.15 release notes|Release Notes]]
|
|-
! Moodle 1.9.16
| 9 January 2012
| 2007101591.10
| [[Moodle 1.9.16 release notes|Release Notes]]
|
|-
! Moodle 1.9.17
| 12 March 2012
| 2007101591.12
| [[Moodle 1.9.17 release notes|Release Notes]]
|
|-
! Moodle 1.9.18
| 14 May 2012
| 2007101591.16
| [[Moodle 1.9.18 release notes|Release Notes]]
|
|-
! Moodle 1.9.19
| 9 July 2012
| 2007101592.00
| [[Moodle 1.9.19 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 1.9.x has ended June 2011 (3.5 years).
Bug fixes for security issues in 1.9.x by Moodle HQ ended June 2012 (4.5 years).
Bug fixes for security issues in 1.9.19+ branch by [http://catalyst.net.nz Catalyst IT] ended [http://moodle.org/mod/forum/discuss.php?d=199706 Dec 2013] (6 years).

==Moodle 1.8==
*[[Moodle 1.8 release notes|Moodle 1.8]] - 30 March 2007
*[[Moodle 1.8.1 release notes|Moodle 1.8.1]] - 14 June 2007
*[[Moodle 1.8.2 release notes|Moodle 1.8.2]] - 8 July 2007
*[[Moodle 1.8.3 release notes|Moodle 1.8.3]] - 11 October 2007
*[[Moodle 1.8.4 release notes|Moodle 1.8.4]] - 11 January 2008
*[[Moodle 1.8.5 release notes|Moodle 1.8.5]] - 8 April 2008
*[[Moodle 1.8.6 release notes|Moodle 1.8.6]] - 11 July 2008
*[[Moodle 1.8.7 release notes|Moodle 1.8.7]] - 15 October 2008
*[[Moodle 1.8.8 release notes|Moodle 1.8.8]] - 28 January 2009
*[[Moodle 1.8.9 release notes|Moodle 1.8.9]] - 15 May 2009
*[[Moodle 1.8.10 release notes|Moodle 1.8.10]] - 26 October 2009
*[[Moodle 1.8.11 release notes|Moodle 1.8.11]] - 25 November 2009
*[[Moodle 1.8.12 release notes|Moodle 1.8.12]] - 27 March 2010
*[[Moodle 1.8.13 release notes|Moodle 1.8.13]] - 8 June 2010
*[[Moodle 1.8.14 release notes|Moodle 1.8.14]] - 3 December 2010
*Support has ended

==Moodle 1.7==
*[[Moodle 1.7 release notes|Moodle 1.7]] - 7 November 2006
*[[Moodle 1.7.1 release notes|Moodle 1.7.1]] - 17 January 2007
*[[Moodle 1.7.2 release notes|Moodle 1.7.2]] - 30 March 2007
*[[Moodle 1.7.3 release notes|Moodle 1.7.3]] - 11 October 2007
*[[Moodle 1.7.4 release notes|Moodle 1.7.4]] - 11 January 2008
*[[Moodle 1.7.5 release notes|Moodle 1.7.5]] - 11 July 2008
*[[Moodle 1.7.6 release notes|Moodle 1.7.6]] - 15 October 2008
*[[Moodle 1.7.7 release notes|Moodle 1.7.7]] - 28 January 2009
*Support has ended

==Moodle 1.6==
*[[Moodle 1.6 release notes|Moodle 1.6]] - 20 June 2006
*[[Moodle 1.6.1 release notes|Moodle 1.6.1]] - 20 July 2006
*[[Moodle 1.6.2 release notes|Moodle 1.6.2]] - 12 September 2006
*[[Moodle 1.6.3 release notes|Moodle 1.6.3]] - 10 October 2006
*[[Moodle 1.6.4 release notes|Moodle 1.6.4]] - 17 January 2007
*[[Moodle 1.6.5 release notes|Moodle 1.6.5]] - 30 March 2007
*Moodle 1.6.6 - 11 January 2008
*Moodle 1.6.7 - 11 July 2008
*[[Moodle 1.6.8 release notes|Moodle 1.6.8]] - 15 October 2008
*[[Moodle 1.6.9 release notes|Moodle 1.6.9]] - 28 January 2009
* Support has ended

==Moodle 1.5==
*[[Moodle 1.5 release notes|Moodle 1.5]] - 5 June 2005
*[[Moodle 1.5.1 release notes|Moodle 1.5.1]] - 8 July 2005
*[[Moodle 1.5.2 release notes|Moodle 1.5.2]] - 16 July 2005
*[[Moodle 1.5.3 release notes|Moodle 1.5.3]] - 11 November 2005
*[[Moodle 1.5.4 release notes|Moodle 1.5.4]] - 21 May 2006
* Support has ended

==Moodle 1.4==
*Moodle 1.4 - 31 August 2004
*Moodle 1.4.1 - 12 September 2004
*Moodle 1.4.2 - 5 November 2004
*Moodle 1.4.3 - 21 December 2004
*Moodle 1.4.4 - 7 March 2005
*[[Moodle 1.4.5 release notes|Moodle 1.4.5]] - 7 May 2005
* Support has ended

==Moodle 1.3==
*Moodle 1.3 - 25 May 2004
*Moodle 1.3.1 - 4 June 2004
*Moodle 1.3.2 - 9 July 2004
*Moodle 1.3.3 - 16 July 2004
*Moodle 1.3.4 - 11 August 2004
*Moodle 1.3.5 - 9 September 2004
* Support has ended

==Moodle 1.2==
*Moodle 1.2 - 20 March 2004
*Moodle 1.2.1 - 25 March 2004
* Support has ended

==Moodle 1.1==
*Moodle 1.1 - 29 August 2003
*Moodle 1.1.1 - 11 September 2003
* Support has ended

==Moodle 1.0==
*Moodle 1.0 - 20 August 2002
*Moodle 1.0.1 - 26 August 2002
*Moodle 1.0.2 - 2 September 2002
*Moodle 1.0.3 - 5 September 2002
*Moodle 1.0.4 - 10 September 2002
*Moodle 1.0.5 - 27 September 2002
*Moodle 1.0.6 - 26 October 2002
:: 1.0.6.1 - 6 November 2002
:: 1.0.6.2 - 11 November 2002
:: 1.0.6.3 - 14 November 2002
:: 1.0.6.4 - 25 November 2002
*Moodle 1.0.7 - 9 December 2002
*Moodle 1.0.8 - 7 January 2003
*Moodle 1.0.9 - 30 May 2003
* Support has ended

==See also==
*[[Roadmap]] - future versions
*[[Moodle versions]] - an explanation of how our versions work plus version numbers for each release (for $plugin->requires)

[[Category:Release notes]]
[[Category:Core development]]

[[fr:Historique des versions]]
[[es:dev/Historia de las versiones]]
[[de:Versionshistorie]]

Category:Moodle 3.6

2020-08-28T12:52:23Z

Fox: French link

Pages that relate to the planning and development of Moodle 3.6 features.

[[fr:Catégorie:Moodle 3.6]]

Category:Moodle 3.7

2020-08-28T12:52:04Z

Fox: French link

Pages that relate to the planning and development of Moodle 3.7 features.

[[fr:Catégorie:Moodle 3.7]]

Category:Moodle 3.8

2020-08-28T12:51:45Z

Fox: French link

Pages that relate to the planning and development of Moodle 3.8 features.

[[fr:Catégorie:Moodle 3.8]]

Category:Moodle 3.9

2020-08-28T12:51:23Z

Fox: French link

Pages that relate to the planning and development of Moodle 3.9 features.

[[fr:Catégorie:Moodle 3.9]]

Category:Moodle 3.10

2020-08-28T12:50:27Z

Fox: French link

Pages that relate to the planning and development of Moodle 3.10 features.

[[fr:Catégorie:Moodle 3.10]]

New docs version process

2020-06-17T14:17:49Z

Fox: Check (and update if needed) Upgrading and Upgrade overview pages

This page describes the procedures for creating a new Moodle Docs version wiki.

==4 weeks prior==

Tidying up in current latest version wiki:

# Delete https://docs.moodle.org/en/Special:BrokenRedirects
# Edit https://docs.moodle.org/en/Special:DoubleRedirects (ignoring redirects to dev docs)
# Check and delete as necessary https://docs.moodle.org/en/Special:NewFiles
# Check and delete as necessary https://docs.moodle.org/en/Special:ListDuplicatedFiles
# Check and delete as necessary https://docs.moodle.org/en/Special:UnusedFiles
# (Check and delete as necessary https://docs.moodle.org/en/Special:ShortPages )

Create a tracker issue for creating new en and de version wikis similar to MDLSITE-5946.

==3 weeks prior==

In new version wiki:

# Edit MediaWiki:MoodleDocsVersionLinks
# Edit Main_page
# Add message to MediaWiki:Sitenotice
# Remove new features template from all pages in Category:New_features
# Edit Template:New_features and Category:New_features
# Go through [https://tracker.moodle.org/issues/?jql=labels%20%3D%20docs_required tracker issues with the docs_required label] and the release notes for the upcoming release and add documentation on new features plus the new features template
# Create Upgrading_to_Moodle_3.x and redirect to Upgrading
# Update version number in Template:Version and Template:Version2 and Git for Administrators
# Review Special:WantedPages
# Review Special:LonelyPages
# Review instances of "(new in 3.x)" text (not always necessary to remove them)
# Add link to new version wiki to https://docs.moodle.org/dev/MediaWiki:Sidebar
# Add link to new version wiki to https://docs.moodle.org/en/MoodleDocs:Overview
# Post on moodle.org in the Moodle community sites forum about the new version wikis e.g. [https://moodle.org/mod/forum/discuss.php?d=404029 Moodle Docs 3.9 wikis now available]

==1 week prior==

Create a tracker issue for making the new wiki default, similar to MDLSITE-6027.

In new wiki:

* Remove message in MediaWiki:Sitenotice
* Check (and update if needed) Upgrading and Upgrade overview pages

In all older version wikis:

* Edit https://docs.moodle.org/en/MediaWiki:MoodleDocsVersionLinks to add the new version and remove older versions (though keeping 3.5 as [[Releases|LTS release]])

==Day of release==

In previous latest version wiki:

* Edit https://docs.moodle.org/en/MediaWiki:Noarticletext to make it like https://docs.moodle.org/2x-1/en/MediaWiki:Noarticletext
* Edit https://docs.moodle.org/en/Creating_SCORM_Content to make it like https://docs.moodle.org/2x-1/en/Creating_SCORM_Content
* Go through Special:RecentChanges in the previous most recent version wiki and add relevant changes to the new version wiki
* Edit https://docs.moodle.org/en/Awards and add <code><nowiki>#redirect [[:en:Awards]]</nowiki></code> so it redirects to the latest version of the page
* Edit https://docs.moodle.org/en/MoodleDocs:Overview and add <code><nowiki>#redirect [[:en:MoodleDocs:Overview]]</nowiki></code> so it redirects to the latest version of the page
* Create MediaWiki:Sitenotice by copying content from https://docs.moodle.org/26/en/MediaWiki:Sitenotice

On moodle.org, dev.moodle.org, download.moodle.org and lang.moodle.org in footersitesmap change the version number.

==Final checks==

* Email notification of watched pages enabled
* Links without version number e.g. https://docs.moodle.org/en/Main_page redirect to the new version wiki
* New version wiki listed in https://docs.moodle.org/overview/

[[Category:Documentation]]
[[Category:Processes]]
[[Category:Moodle Docs]]

Moodle 3.9 release notes

2020-05-13T14:53:32Z

Fox: /* Server requirements */

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for Monday 8 June 2020

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.9%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.9].

If you are upgrading from a previous version, please see [[:en:Upgrading|Upgrading]] in the user docs.

==Server requirements==

''Note: Requirements still to be reviewed and updated as necessary!''

These are just the minimum supported versions. We recommend keeping all of your software and operating systems up-to-date.

* Moodle upgrade: Moodle 3.5 or later
* PHP version: minimum PHP 7.2.0 ''Note: minimum PHP version has increased since Moodle 3.8''. PHP 7.3.x and 7.4.x are supported too. See [[Moodle and PHP]] for details.
* PHP extension '''mbstring''' is required (it was recommended)

=== Database requirements ===

''Note: Requirements still to be reviewed and updated as necessary!''

Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.

{| class="nicetable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 9.5
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.6
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 10.2.29
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2012
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 11.2
| Latest
|}

==Client requirements==

=== Browser support ===
Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge
* Internet Explorer

Mobile:
* MobileSafari
* Google Chrome

For the best experience and optimum security, we recommend that you keep your browser up to date. https://whatbrowser.org

Note: Legacy browsers with known compatibility issues with Moodle 3.9:
* Internet Explorer 10 and below
* Safari 7 and below

==Major features==

==Other highlights==

==Security issues==

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.8 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.9]]

[[fr:Notes de mise à jour de Moodle 3.9]]
[[es:Notas de Moodle 3.9]]

Moodle and PHP

2020-05-11T17:20:04Z

Fox: French link

PHP7 was released on 3 December 2015 and has significant performance improvement comparing to PHP5. Everybody wants to benefit from it, however the language standards have changed and code written for PHP5 might not work in PHP7. Moodle core and plugins should modify the code so it works the same way on both versions of PHP.

This page contains description of what has been changed in Moodle to make it work on PHP7 and recommendations to plugin developers. Please see also epic issues that combine all the changes that were made in Moodle to ensure PHP compatibility. ''(Note: you must be logged in to tracker to see issues in Epics)''

MDL-50565 - '''PHP 7.0 can be used with Moodle 3.0.1, Moodle 3.1 and later releases.''' It is also the '''minimum''' supported version for Moodle 3.4. See [[Moodle and PHP 7.0 details]] for details.

MDL-55120 - '''PHP 7.1 can be used with Moodle 3.2 and later releases.''' It is also the '''minimum''' supported version for Moodle 3.7.

MDL-60279 - '''PHP 7.2 can be used with Moodle 3.4 and later releases.''' It is also the '''minimum''' supported version for Moodle 3.9.

MDL-63420 - '''PHP 7.3 can be used with Moodle 3.6.4, Moodle 3.7 and later releases.'''

MDL-66260 - '''PHP 7.4 can be used with Moodle 3.8.3, Moodle 3.9 and later releases.'''

[[fr:Moodle et PHP]]

QA testing

2019-12-06T09:55:27Z

Fox: /* See also */

'''Quality Assurance''' tests look at the functionality of Moodle from a user's point of view.

Real users systematically try each feature in Moodle and test that it works in the current version of the Moodle code. These tests are repeated in series of cycles, usually 4 weeks before a major release, once all major features have landed.

<p class="note">'''QA testing latest''': ''A 100% pass rate was obtained in Moodle 3.8 QA testing. Many thanks to all our [[Testing credits|QA testers]].''</p>

==Getting involved==

Would you like to help with QA testing? If so, please make sure you have created an account in the [[Tracker_introduction|Moodle tracker]], then contact [https://moodle.org/user/profile.php?id=24152&course=1 Helen]. Also, make sure you're subscribed to the [https://moodle.org/mod/forum/view.php?id=56 Testing and QA forum] in order to receive QA testing news updates.

All testers are members of the testers group in the Moodle Tracker, enabling them to pass or fail QA tests and add comments.

==Running tests==

# Go to the QA testing dashboard and choose a test from the list of current QA cycle open issues. When viewing a test, if you wish, you can click the 'Assign to me' link on the right, so that nobody else chooses the same test to run. (If you then find you are unable to run the test, you can click the Assign button and set the assignee as 'Unassigned'.) Please note:
#* Only assign an issue to yourself which no one else is testing (Assignee = Unassigned).
#* Only assign one issue at a time unless you plan to test a number of related issues within the next 24 hours. In other words, don't assign several issues to yourself then do nothing for several days. ;-)
#* The label ''test_server_required'' indicates issues that can't be tested on the QA testing site. The label ''credentials_required'' indicates that credentials such as an OAuth 2 service client ID and secret are required.
# Using either the [https://qa.moodledemo.net/ Moodle QA Testing Site] or your own test site running the latest Moodle 3.x dev (available from Git on the integration/master branch ''<nowiki>git://git.moodle.org/integration.git</nowiki>'') with [[:en:Debugging|debugging]] set to developer, perform each of the steps listed in the test. ''If it makes sense, please test using the currently supported themes, Boost and Classic.''
# Choose an appropriate workflow action:
#* ''Pass'' - Test runs perfectly. Add comment such as feedback about a new feature, browsers used for testing (if applicable), or simply "This test passes - yippee!"
#* ''Fail'' - Something doesn't work, or you obtain debugging messages. Add comment describing the step that doesn't work. If in doubt whether to pass a test, give it a fail and add a comment describing your doubts.
#* ''Obsolete'' - Test is no longer relevant in the current Moodle version. Add comment explaining why.

If you notice that the test description is out-of-date, add a comment mentioning that it needs updating. Alternatively, if you'd like to help with updating the test yourself, see below.

===Moodle QA Testing Site===

The [https://qa.moodledemo.net/ Moodle QA Testing Site] is updated daily at around 13:00 UTC with the latest bug fixes to enable you to re-run QA tests.

To prevent the site being used for sending spam, no emails are sent from it. Thus, tests involving email cannot be run using the Moodle QA Testing Site. (If such tests are attempted, an email debug message is displayed. This is not a bug but rather expected behaviour.)

Teacher and student accounts are provided. Please contact [https://moodle.org/user/profile.php?id=24152&course=1 Helen] if you would like admin or manager access to the Moodle QA Testing Site for running certain tests.

==<div id="failedTests">Failed tests</div>==

So you ran a test and it failed? Congratulations on finding a bug! Please do the following.

# Click the Fail button at the top of the page.
# Add a comment to the QA test stating that there was a problem and that you will report it as a Moodle bug.
# Note the MDLQA number; it will be something like <nowiki>MDLQA-448</nowiki>.
# Try searching for whether the bug has been reported previously, and if not create a new issue for it (as described in [[Tracker introduction]]).
# In the new Moodle (MDL) issue select 'Link' from the 'More actions' dropdown menu. <br />[[Image:LinkIssue.png|150px|Linking to the QA issue in the tracker]]
# Link to the QA test by selecting 'blocks' as the link type, entering the MDLQA number that you noted earlier, and optionally adding a comment. <br />[[Image:LinkDetails.png|150px|Adding details for a link to the QA issue]]
# Give the issue the label 'mdlqa'.
# (Optional) Add yourself as a watcher to the MDL issue so that you receive email notification when the issue is fixed.
# When the MDL issue is fixed, hopefully within a day or two, the QA test can be reset and can then be run again.

==Resetting tests==

''Note for integrators:''

After integrating a fix,

# Reset the MDLQA test, adding a comment.
# Remove the 'mdlqa' label from the MDL issue.
# If the issue doesn't have testing instructions, pass it with message "Will be tested by MDLQA-XXXX".

The tester will then receive email notification that the bug is fixed and will hopefully decide to run the test again soon.

==New QA tests required==

''Note for developers:''

If an issue fix cannot be covered by automated tests,

# Add the label 'qa_test_required' to the issue.
# Add a comment explaining why it can't be covered by automated tests and suggesting which steps of the testing instructions should be included in a QA test e.g. steps 6-10 or all steps.

QA tests will then be written and included in the next QA cycle. For issues with long testing instructions, several QA tests will be written to cover the issue. If appropriate, activities etc. will be set up on the [https://qa.moodledemo.net/ Moodle QA Testing Site] to enable the issue to be easily tested in future.

Similarly, for new features and improvements which would benefit from exploratory testing,

# Add the label 'qa_test_required' to the issue.
# Add a comment mentioning that exploratory testing is required.

Exploratory QA tests will then be written and included in the next QA cycle and then removed.

==Updating tests==

QA tests often become out-of-date due to new developments. If you would like to help with updating tests, you'll need to be a member of the test writers group in the Tracker. Please contact Helen about being added.

To update a QA test:

# Search for the master copy of the test - with affects version as 'Master copy' and MDLQA-1 as parent.
# Edit the test description.
# Optional: Add a comment describing your edit.

==Writing new tests==

Would you like to help with writing new QA tests? If so, as for updating tests, you'll need to be a member of the test writers group in the Tracker. Please contact Helen about being added.

To create a new QA test:

# Choose an issue from the [https://tracker.moodle.org/issues/?jql=labels%20%3D%20qa_test_required%20AND%20status%20%3D%20Closed closed qa_test_required-labelled issues]
# Do a quick search of MDLQA-1 to check if there is an existing test which can be updated
# If not, create a sub-task of MDLQA-1
# Select Master copy as affected version
# Select appropriate components including at least one of the following: User, Student, Teacher, Administrator
# Set assignee as unassigned
# Write the test (usually between 3 and 10 steps). It's a good idea to try doing the steps yourself as you write the test.
# For tests which can’t be run on the QA site, label test_server_required. For OAuth 2 tests and any other tests which require a client ID or secret to be entered, label credentials_required.
# For issues which specifically mention in the testing instructions to test in different browsers, use the phrase “Test in as many browsers as possible and mention in a comment which ones you’ve used.”
# Go to the MDL issue and create a ‘has a QA test’ link to the new QA test, adding a comment “Thanks for this improvement which is now covered by the QA test MDLQA....”, and remove the qa_test_required label. ''Make sure that all QA tests are linked back to a corresponding MDL issue.''

New tests will be included in the next QA cycle.

==Feedback==

Feedback on all aspects of our QA testing process is welcome. If you have any questions or comments, please post in the [https://moodle.org/mod/forum/view.php?id=56 Testing and QA forum].

==See also==

* [https://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=11454 QA testing dashboard]
* [[Testing credits]]
* [[MDLQA-features]]
* [https://moodle.org/mod/forum/discuss.php?d=351302 Useful tips for QA testing]

Comments on tests from previous QA cycles:
* [https://tracker.moodle.org/browse/MDLQA-150 Moodle 2.0 QA Cycle 1]
* [https://tracker.moodle.org/browse/MDLQA-328 Moodle 2.0 QA Cycle 2]
* [https://tracker.moodle.org/browse/MDLQA-540 Moodle 2.0.2 QA]
* [https://tracker.moodle.org/browse/MDLQA-944 Moodle 2.1 QA Cycle 1]
* [https://tracker.moodle.org/browse/MDLQA-1190 Moodle 2.2 QA]
* [https://tracker.moodle.org/browse/MDLQA-1814 Moodle 2.3 QA]
* [https://tracker.moodle.org/browse/MDLQA-4602 Moodle 2.4 QA]
* [https://tracker.moodle.org/browse/MDLQA-5267 Moodle 2.5 QA]
* [https://tracker.moodle.org/browse/MDLQA-5740 Moodle 2.6 QA]
* [https://tracker.moodle.org/browse/MDLQA-6693 Moodle 2.7 QA]
* [https://tracker.moodle.org/browse/MDLQA-7170 Moodle 2.8 QA]
* [https://tracker.moodle.org/browse/MDLQA-7660 Moodle 2.9 QA]
* [https://tracker.moodle.org/browse/MDLQA-8205 Moodle 3.0 QA]
* [https://tracker.moodle.org/browse/MDLQA-9267 Moodle 3.1 QA]
* [https://tracker.moodle.org/browse/MDLQA-9827 Moodle 3.2 QA]
* [https://tracker.moodle.org/browse/MDLQA-10403 Moodle 3.3 QA]
* [https://tracker.moodle.org/browse/MDLQA-10999 Moodle 3.4 QA]
* [https://tracker.moodle.org/browse/MDLQA-11698 Moodle 3.5 QA]
* [https://tracker.moodle.org/browse/MDLQA-12282 Moodle 3.6 QA]
* [https://tracker.moodle.org/browse/MDLQA-12911 Moodle 3.7 QA]
* [https://tracker.moodle.org/browse/MDLQA-13517 Moodle 3.8 QA]

[[Category:Quality Assurance]]

Moodle Development kit

2019-12-04T10:22:27Z

Fox: /* Backporting a fix */

Every developer creates simple tools to avoid repeating cumbersome and/or boring tasks, and that is precisely why MDK has been created: to pack all those useful tools in a portable way across systems. Initially developed in Bash, the project moved to Python to avoid dealing with inconsistencies between Unix platforms, and eventually to support Windows.

= Key concept =

The most important concept of MDK is that it works with Moodle instances. An instance of Moodle is a directory in which you have checked out a particular version together with a database using a specific database engine. This means that if you want to work on Moodle 2.3 and 2.4, using both MySQL and PostgreSQL, you will have four separate instance directories. This choice was made because it is the safest, clearest, and most straightforward solution.

= Typical workflows using MDK =

To discover what MDK can do for you, here are a few common tasks it can achieve. More on [https://github.com/FMCorz/mdk/wiki/Typical-workflows MDK's wiki].

== Installing a new instance ==

Say we need to create a new instance of Moodle 2.4 and install it with PostgreSQL. We also want the instance to be ready for development with appropriate config settings. We also want to create a bunch of user accounts.

mdk create -i -v 24 -e pgsql -r dev users
or the equivalent long form:
mdk create --install --version 24 --engine pgsql --run dev users

These options include:
--install: launch the installation script after creating the instance
--engine: database engine to install the instance on (must be used with --install), default: mysqli
--version: version of Moodle create an instance of (default: 'master')
--run: scripts to run after installation (default: none)

More information about scripts is available here: https://github.com/FMCorz/mdk/tree/master/mdk/scripts

The above command is equivalent to doing:

mkdir /dir/to/stable_24/moodle
mkdir /dir/to/stable_24/moodledata
ln -s /dir/to/stable_24/moodle /var/www/stable_24
git clone git://git.moodle.org/moodle.git /dir/to/moodle
cd /dir/to/stable_24/moodle
php admin/cli/install.php --wwwroot="http://localhost/stable_24" --dataroot=/dir/to/stable_24/moodledata --dbtype=pgsql --dbname=stable24 --dbuser=root --dbpass=root --dbhost=localhost --fullname="Stable 24 PostgreSQL" --shortname=stable_24 --adminuser=admin --adminpass=test --allow-unstable --agree-license --non-interactive
vim config.php
# Add the following settings:
# - $CFG->sessioncookiepath: /stable_24/
# - $CFG->debug: DEBUG_DEVELOPER
# - $CFG->debugdisplay: 1
# - $CFG->passwordpolicy: 0
# - $CFG->perfdebug: 15
# - $CFG->debugpageinfo: 1
# - $CFG->allowthemechangeonurl: 1
# - $CFG->cachejs: 0
# - $CFG->yuicomboloading: 0
# Include FirePHP Core
# Login to Moodle
# Create 10 students, 3 teachers and 3 managers

You also can specify the name of the instance using the --name or -n parameter. This is necessary to avoid name conflicts when trying to create same Moodle version with different database engines:

mdk create -i -v 24 -e mysqli -r dev users -n stable_24-mysql

== Fixing an issue ==

mdk fix 12345
# Committing your patch
mdk push -t

This is equivalent to doing:

git branch --track MDL-12345-24 origin/MOODLE_24_STABLE
git checkout MDL-12345-24
# Committing your patch
git push github MDL-12345-24
# Editing the tracker issue to add
# - Git repository URL
# - Git branch for 2.4
# - Git compare URL for 2.4

== Peer reviewing a patch ==

Here we want to pull a patch from a tracker issue into a new testing branch, and then run the PHPUnit tests.

mdk pull 12345 -t
mdk phpunit -r

This is the equivalent to doing:

cd /dir/to/stable_24/moodle
git branch --tracker MDL-12345-24-test MOODLE_24_STABLE
git checkout MDL-12345-24-test
git pull git://github.org/Someone/moodle.git MDL-12345-24
# And now the PHPUnit part
mkdir /dir/to/stable_24/moodledata_phpu
vim config.php
# To add
# - $CFG->phpunit_dataroot = '/dir/to/stable_24/moodledata_phpu';
# - $CFG->phpunit_prefix = 'phpu_';
php admin/tool/phpunit/cli/init.php
phpunit

For executing only the testcases in a file you can use:

mdk phpunit -r -u repository/tests/repository_test.php

== Backporting a fix ==

MDK could handle for you most of the cherry-picking work when you backport a fix. To do so, you need to have installed locally instances called "stable_XX" for each version you want to backport your fix. To do so you can use commands like:

mdk create -v 38 -i -r dev users makecourse -n stable_38
mdk create -v 37 -i -r dev users makecourse -n stable_37

Once you have the stable_XX versions, go to the branch you want to backport and execute:

mdk backport --versions 37 38 --push --update-tracker

The example params are:
* -v 37 38 backports the patch to the versions 3.7 and 3.8
* --push pushes the branch to github
* --update-tracker updates the tracker issue

After the execution, your stable_XX instances will be on the fix branch, commits are pushed to you github project and backport links will be updated in the tracker.

If for some reason one cherry pick could not finish successfully, mdk will ask you if you want to keep this backport or no. If you choose to keep the partial backport, your stable_XX instance will be in cherry-picking state. In that case you need to solve any conflict and use mdk to push your changes:

# go to your stable_XX with cherry pick conflict
# solve conflicts with git mergetool or any other tool
git cherry-pick --continue
# once all conflicts are solved, push to your repository and tracker using
mdk push -t

== Upgrading the instances ==

Say we need to upgrade our instances, as a new weekly release has just been made available.

mdk upgrade -u --all

This is the equivalent to doing:

# For each instance of Moodle...
cd /dir/to/stable_24/moodle
git checkout MOODLE_24_STABLE
git fetch origin
git reset --hard origin/MOODLE_24_STABLE
php admin/cli/upgrade.php --non-interactive --allow-unstable

== Executing behat tests ==

In order to get the instance ready for acceptance testing (Behat) and run the test feature(s):

mdk behat -r --tags=@core_completion

For running only one feature or specific scenario:

mdk behat -r -n "Name of the feature/scenario"

= Features =

For a complete list of the commands MDK has to offer, read through the [https://github.com/FMCorz/mdk#command-list MDK README file] and the [https://github.com/FMCorz/mdk/wiki MDK wiki]. For more detail about each command, simply run them with the flag '--help'.

= Installation =

Please follow the instructions from the [https://github.com/FMCorz/mdk#installation README file].

Note: When you install MDK, you will be asked for the following information (with default responses indicated in square brackets):

* What user are you initialising MDK for? [default - your current username]
* What is the DocumentRoot of your virtual host? [~/www] <- '''See note below'''
* Where do you want to store your Moodle instances? [~/moodles] <- This can be in your home directory (the default) because a symlink will be created using DocumentRoot
* What is your Github username? (Leave blank if not using Github)
* What is your MySQL user? [root]
* What is your MySQL password? [root]
* What is your PostgreSQL user? [root]
* What is your PostgreSQL password? [root]

'''Note''': By default, MDK will install instances to your home directory. A symlink will be created from your DocumentRoot to the install location. You will need to either change the DocumentRoot of your host to the path to your html root directory, e.g. /var/www/html, or create a file in /etc/httpd/conf.d/moodlehq.conf that configures a virtual host in your home directory.

'''Also note that you may need to set the path variable to null:'''
mdk config set path ""

= Upgrading MDK =
Every Moodle release, a new version of MDK is also being released in order to prepare for the development of the next Moodle version. To upgrade MDK:
# Update all of the Moodle instances: ''mdk update --all''
# Check out the master branch for all of your master instances, e.g. in your stable_master branch: ''git checkout master''
# Upgrade MDK
## Via pip: ''sudo pip install moodle-sdk --upgrade''
## Via Homebrew: ''brew upgrade moodle-sdk''
# Run MDK doctor to fix its ''masterBranch'' configuration. ''mdk doctor --fix --masterbranch''
# Run MDK doctor to check the master instances. ''mdk doctor --all''
#* If you don't see an error saying something like “stable_master is on branch master instead of MOODLE_XX_STABLE”, then you're all good. Otherwise, do a hard reset your master instances:
mdk update -c
cd ~/moodles/[integration/stable]_master
git checkout master
git fetch `mdk config show upstreamRemote`
git reset --hard `mdk config show upstreamRemote`/master

= The MDK Suite =

Some other tools have been developed using the name MDK as they are considered as part of the development kit but are often mistaken with the ''real'' MDK. The ''real'' MDK is the command line tool described above.

== MDK Browser Extension ==

Available for both [https://addons.mozilla.org/en-US/firefox/addon/mdk-browser-extension/ Firefox] and [https://chrome.google.com/webstore/detail/mdk-browser-extension/iadpkkojcdoflinpncpkbonnhdlaicnc Chrome], this is a browser extension that allows quick access to useful user-scripts. The scripts add functionality to Moodle.org, Moodle Tracker and your Moodle instances. You can find more information about it on its [https://github.com/danpoltawski/userscripts-moodle public repository].

== MDK Authentication ==

This is an authentication plugin for Moodle 2.x, which not only creates the user if it does not exist in the database yet, but also enrols it as a student, teacher or manager in all the available courses. More information about this plugin is available on the [https://github.com/FMCorz/moodle-auth_mdk public repository].

[[Category:Developer tools]]

Release notes template

2019-11-05T11:58:06Z

Fox: Small cleaning

Copy and paste this wiki code into the new release notes page and replace all the missing bits.
<code text>
[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%22X.X.X%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in X.X.X].

==Server requirements==

===Database requirements===

==Client requirements==

===Browser support===
Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge
* Internet Explorer

Mobile:
* MobileSafari
* Google Chrome

For the best experience and optimum security, we recommend that you keep your browser up to date.

Note: Legacy browsers with known compatibility issues with Moodle X.X:
* Internet Explorer 10 and below
* Safari 7 and below

==Major features==

''Items to be added soon...''

==Other highlights==

''Items to be added soon...''

==For admins==

''Items to be added soon...''

==For developers==

''Items to be added soon...''

==Security issues==

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle X.X.X-1 release notes]]

[[Category:Release notes]]
[[Category:Moodle X.X]]

[[fr:Notes de mise à jour de Moodle X.X.X]]
[[es:Notas de Moodle X.X.X]]

</code>

===Tips===

The following git command can be used to find all upgrade.txt files that were modified since the last release, so that links to them can be provided in the release notes - typically in the For developers section.

$ git log --oneline --pretty="format:" --name-only v3.5.0..v3.6.0-beta | grep upgrade.txt | sort | uniq | while read path; do echo "* [https://git.in.moodle.com/moodle/moodle/blob/v3.6.0-beta/$path $path]"; done

See e.g. [[Moodle 3.6 release notes#Component APIs upgrades]] for how it was used in the past.

[[:es:Plantilla para las notas de versiones|Plantilla en Español]]

[[Category:Release notes]]
[[Category:Processes|Release process]]

Moodle 3.5.7 release notes

2019-07-08T08:15:37Z

Fox: Version officially out now

Moodle 3.6.5 release notes

2019-07-08T08:15:11Z

Fox: Version officially out now

[[Releases]] > {{FULLPAGENAME}}

Release date: 8 July 2019

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.6.5%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.6.5].

===Fixes and improvements===

* MDL-59650 - Calendar export no longer limited to 40 events
* MDL-64935 - Jump to dropdown menu no longer overlaps before / next activity links
* MDL-58315 - Boost theme no longer ignores HTML block custom classes
* MDL-53778 - Quiz with activity completion 'Or all available attempts completed' no longer possible with unlimited attempts
* MDL-65101 - Users with capability moodle/site:messageanyuser can message any user regardless of their privacy settings
* MDL-65581 - Hidden blocks can once again be unhidden
* MDL-65249 - Redis cache store correctly displays exception after failed connections
* MDL-65084 - Recently accessed items block checks for whether a course is deleted before showing items from it
* MDL-57729 - Ampersand in site title no longer breaks LTI provider cartridge XML
* MDL-55821 - Assignment individual grading when using rubric and workflow grade is displayed
* MDL-65696 - PDF annotation comments no longer expand unexpectedly
* MDL-64784 - Enrolled users list sort order no longer changes after adding or removing a user
* MDL-55197 - Multi-lang filter no longer ignores 'en' parent language
* MDL-65829 - Enrolments whose start date is after the analytics analysis start time are no longer discarded
* MDL-65641 - Texts in Moodle format remain in the same format when edited
* MDL-65839 - Improved memory usage of analytics evaluation and initial training processes
* MDL-60347 - SMTP debugging no longer displayed for lower debugging output levels
* MDL-65326 - Restore process no longer displays an error if the capability doesn't exist
* MDL-65665 - Quick reply now respects subscribe on reply user preference
* MDL-65814 - Item counts for action events are now shown in the timeline block
* MDL-65901 - Forum advanced search form styling improvements
* MDL-65634 - Students at risk models correctly discard user enrolments whose start and end dates do not fit into the analysed time interval
* MDL-65297 - Atto 'Manage files' now detects filenames containing a hash symbol (#)
* MDL-65606 - Database activity unapproved entries are once again highlighted

===Security issues===

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.6.4 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.6]]

[[fr:Notes de mise à jour de Moodle 3.6.5]]
[[es:Notas de Moodle 3.6.5]]

Moodle 3.7.1 release notes

2019-07-08T08:14:23Z

Fox: Version officially out now

[[Releases]] > {{FULLPAGENAME}}

Release date: 8 July 2019

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.7.1%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.7.1].

===Fixes and improvements===

* MDL-59650 - Calendar export no longer limited to 40 events
* MDL-64935 - Jump to dropdown menu no longer overlaps before / next activity links
* MDL-53778 - Quiz with activity completion 'Or all available attempts completed' no longer possible with unlimited attempts
* MDL-65101 - Users with capability moodle/site:messageanyuser can message any user regardless of their privacy settings
* MDL-65660 - Guest users prompted to enrol in order to post in a forum
* MDL-65675 - 'Re' no longer duplicated in forum post subject line
* MDL-65249 - Redis cache store correctly displays exception after failed connections
* MDL-65084 - Recently accessed items block checks for whether a course is deleted before showing items from it
* MDL-57729 - Ampersand in site title no longer breaks LTI provider cartridge XML
* MDL-65655 - Forum mailings and maintenance jobs no longer fail with 'Suspended account' exception
* MDL-55821 - Assignment individual grading when using rubric and workflow grade is displayed
* MDL-65696 - PDF annotation comments no longer expand unexpectedly
* MDL-64784 - Enrolled users list sort order no longer changes after adding or removing a user
* MDL-55197 - Multi-lang filter no longer ignores 'en' parent language
* MDL-65829 - Enrolments whose start date is after the analytics analysis start time are no longer discarded
* MDL-65779 - Forum backup and restore retains any private replies as private
* MDL-65708 - Child themes have base layouts loaded
* MDL-65888 - Fix for 'error/usernotconfirmed' exception in forum mailings and maintenance jobs
* MDL-65661 - Long course names in 'Recently accessed courses' block correctly displayed
* MDL-65839 - Improved memory usage of analytics evaluation and initial training processes
* MDL-60347 - SMTP debugging no longer displayed for lower debugging output levels
* MDL-65705 - Badges from other sites which are displayed via a backpack no longer show date in the future
* MDL-65326 - Restore process no longer displays an error if the capability doesn't exist
* MDL-65665 - Quick reply now respects subscribe on reply user preference
* MDL-65814 - Item counts for action events are now shown in the timeline block
* MDL-65666 - Unread forum posts are once again highlighted
* MDL-65883 - Quiz navigation buttons once again scroll to the correct question on the page
* MDL-65901 - Forum advanced search form styling improvements
* MDL-65634 - Students at risk models correctly discard user enrolments whose start and end dates do not fit into the analysed time interval
* MDL-65297 - Atto 'Manage files' now detects filenames containing a hash symbol (#)
* MDL-65591 - Language customisation page once again displays the correct buttons
* MDL-65606 - Database activity unapproved entries are once again highlighted

===Security issues===

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.7 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.7]]

[[fr:Notes de mise à jour de Moodle 3.7.1]]
[[es:Notas de Moodle 3.7.1]]

Moodle 3.7 release notes

2019-06-26T07:10:15Z

Fox:

[[Releases]] > {{FULLPAGENAME}}

Release date: 20 May 2019

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.7%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.7].

See our [https://docs.moodle.org/37/en/New_features New features page] in the user documentation for an introduction to Moodle 3.7 with screenshots.

If you are upgrading from a previous version, please see [[:en:Upgrading|Upgrading]] in the user docs.

==Server requirements==

These are just the minimum supported versions. We recommend keeping all of your software and operating systems up-to-date.

* Moodle upgrade: Moodle 3.2 or later
* PHP version: minimum PHP 7.1.0 ''Note: minimum PHP version has increased since Moodle 3.6''. PHP 7.2.x and 7.3.x are supported too. PHP 7.x could have some [https://docs.moodle.org/dev/Moodle_and_PHP7#Can_I_use_PHP7_yet.3F engine limitations].
* PHP extension '''intl''' is required since Moodle 3.4 (it was recommended in 2.0 onwards)

=== Database requirements ===

Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.

{| class="nicetable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 9.4
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.6
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 5.5.31
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2008
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 11.2
| Latest
|}

==Client requirements==

=== Browser support ===
Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge
* Internet Explorer

Mobile:
* MobileSafari
* Google Chrome

For the best experience and optimum security, we recommend that you keep your browser up to date. https://whatbrowser.org

Note: Legacy browsers with known compatibility issues with Moodle 3.7:
* Internet Explorer 10 and below
* Safari 7 and below

==Major features==

===Forum===
* MDL-22077 - Private reply option
* MDL-65033 - Ability to star discussions
* MDL-64956 - In-page forum post reply
* MDL-65032 - Ability to lock discussions manually
* MDL-65069 - Ability to create discussions without changing page
* MDL-64820 - Forum display updated to use templates
* MDL-65071 - List of discussions is sortable
* MDL-65034 - Accessibility improvements to forum discussions
* MDL-65394 - Forum rendering speed improvements
* MDL-46881 - Forum scheduled task (cron) has been refactored into several smaller cron tasks

===Messaging===
* MDL-65015 - HTML in messages is cleaned according to site/role "trusttext" configuration
* MDL-64715 - Personal space in messaging drawer for draft messages etc.
* MDL-64495 - New settings page for messaging-related settings
* MDL-63620 - Group conversations can be created from both the auto-create groups edit page and the import groups tool
* MDL-63915 - Old messaging user interface removed and replaced with a new widget
* MDL-64773 - Messaging conversations can be muted
* MDL-65132 - New capability for deleting messages for all users within group conversations
* MDL-64017 - Message processors can identify and handle group messages
* MDL-64703 - Updated interface on the messaging index page
* MDL-64137 - Searches highlight text that matches the search term
* MDL-65114 - Timestamps in the main conversation list include days and years
* MDL-64093 - New admin setting to set the site default for using enter key to send messages
* MDL-60680 - Improved push notifications

===Themes===
* MDL-58428 - All Boost templates moved to core
* MDL-64505 - Classic theme introduced to core
* MDL-64506 - Bootstrapbase and related themes (Clean/More) removed from core
* MDL-65449 - Themes can override the course pattern used on the dashboard

===LTI===
* MDL-62599 - LTI 1.3 support introduced

===Open Badges===
* MDL-63262 - Support added for Open Badges 2.0 platforms
* MDL-63876 - Moodle competencies can be linked to criteria for badges in Open Badges 2.0

===Dashboard and Course Overview===
* MDL-63794 - Course categories can be displayed on courses in the course overview block
* MDL-64855 - New admin setting to control the output of the course category in the myoverview block
* MDL-64376 - Scrolling improved in the recently accessed courses block
* MDL-64903 - Course filters are logically grouped in the myoverview block
* MDL-64898 - The completion progress bar is no longer displayed for teachers in the myoverview block

===Learning Analytics===
* MDL-61667 - Improvements to the install/uninstall procedure the Analytics API offers to plugins
* MDL-64783 - New “upcoming activities due” model added
* MDL-65582 - The "upcoming activities due" model is enabled by default
* MDL-64786 - Users can overwrite default model names
* MDL-64693 - New target added for course competencies achievement
* MDL-64636 - New target added for course completion
* MDL-65176 - New target added for students at risk of not getting the minimum grade to pass a course
* MDL-64954 - A "More info" link provides more information about different core analytics elements
* MDL-64777 - Default models can be restored
* MDL-64787 - Analytics models can be evaluated using a trained machine learning backend
* MDL-60944 - Models can be created, deleted, imported and exported
* MDL-64779 - Ability to choose whether to include trained model weights in an export
* MDL-65175 - When evaluating a model, the time-splitting method can be set using the web interface
* MDL-65177 - It is possible to set the frequency of insight generation for models based on assumptions (e.g. the "upcoming activities due" model)
* MDL-60936 - "Enabled time-splitting methods" analytics setting converted to a list of default time-splitting methods for a model's evaluation

===Usability improvements===
* MDL-5311 - Choices can be cleared for single-answer multiple-choice questions
* MDL-43385 - Print output of books has been improved
* MDL-28505 - Course backup and restore can be performed asynchronously
* MDL-61537 - Ability to rotate pages when annotating PDFs in assignment feedback
* MDL-63773 - Assignment settings form hides irrelevant options instead of disabling them
* MDL-64552 - Moodle forms inside the admin top level directory hide irrelevant options instead of disabling them
* MDL-64557 - Moodle forms inside the course directory hide irrelevant options instead of disabling them
* MDL-60474 - The student selection tool in the grading interface reflects the sorting order of the grading table
* MDL-39261 - File support added to lesson essay questions
* MDL-60913 - Global search results can be split into tabs by category
* MDL-50793 - Teachers can see hidden pages in book activities
* MDL-60059 - Workshop activity action events support drag and drop in the calendar
* MDL-62142 - Accessibility improvements for Boost course landing page

==Other Highlights==

===Functional changes===
* MDL-31355 - Forum due dates are added to the calendar
* MDL-36088 - Adding/modifying questions to/in the question bank is logged
* MDL-49673 - Assignment has an option to not display the grader to students
* MDL-31852 - HTML tags allowed in the title of Lesson "content pages"
* MDL-64377 - Ability to delete assignment file submissions
* MDL-64243 - Nextcloud serves "offline" files consistent with other integrations (e.g. OneDrive and Google Docs)
* MDL-53346 - User competencies in courses show the linked learning plans
* MDL-62223 - Improved submission statements for assignments
* MDL-52828 - Competencies can be graded when grading an activity
* MDL-65154 - Course competencies page shows students which competencies are linked to an activity
* MDL-64414 - "AND" and "OR" are available in if-conditions for grade calculations

===For administrators===
* MDL-10965 - There is a new capability available to view the list of non-hidden courses
* MDL-57898 - New custom field types plugin and course custom fields functionality
* MDL-49399 - Output can be captured during cron and task runs
* MDL-62869 - Global search can be configured to include all visible courses
* MDL-64322 - New data privacy capability to restrict submission of deletion requests for other users
* MDL-63569 - A constant can be added to the subject of all emails
* MDL-62907 - The standard log table 'other' field can be set to store in JSON format
* MDL-64281 - Frame embedding is always allowed for requests coming from the Moodle app
* MDL-61164 - Tasks using legacy cron functionality moved to scheduled tasks
* MDL-57900 - Added fields to provide site metadata to support learning analytics
* MDL-63623 - Plugins can be uninstalled via command line
* MDL-64323 - Additional fields are included in user searches when making new data requests on behalf of a user
* MDL-64347 - Improved processing of scheduled and ad-hoc tasks
* MDL-65142 - Tables can be downloaded in PDF format (new dataformat)
* MDL-64314 - Insights notification enable web notifications by default
* MDL-65138 - Course sharing to Moodle.net is disabled by default (configured via a new setting)
* MDL-64454 - Site administration page warns if cron does not run frequently
* MDL-62728 - The language packs page displays a warning when locales are not fully supported
* MDL-64071 - Improved diagnostics when testing LDAP settings
* MDL-64823 - Disabling mobile plugins works as expected
* MDL-44484 - Theme field available in the bulk upload users tool
* MDL-64477 - Learning analytics usage data is included with site usage data
* MDL-64337 - Mobile app enabled sites prompt users that do not use the app to download it in notification emails
* MDL-64339 - User names provided in the comments report are hyperlinked to the user's profile

==For developers==
* MDL-54592 - MongoDB cache store upgraded to use PHP 7 compatible library
* MDL-63977 - Behat testing available for mobile app features and plugins
* MDL-63986 - Behat testing added for the messaging drawer
* MDL-64449 - New debug feature to expose code issues with session locks
* MDL-52167 - Core functionality added to enable site administration settings to be hidden if dependent on another disabled setting
* MDL-63366 - Ability to specify filters for unit testing coverage
* MDL-65130 - Improved unit testing coverage generation by only respecting the @covers annotation
* MDL-60470 - New "after_require_login" hook introduced
* MDL-65204 - Phpunit upgraded to version 7.5.x
* MDL-64348 - Improved AJAX template fetching
* MDL-59986 - External database enrolment sync moved to a scheduled task
* MDL-63880 - Some templates common in dashboard blocks have been moved to increase reusability
* MDL-64587 - New option in the XMLDB editor to add the mandatory persistent fields
* MDL-64324 - ID collisions are avoided when forms are loaded from AJAX
* MDL-64684 - When JavaScript caching is disabled, jQuery and RequireJS are no longer minified

===New web services===
* MDL-64252 - New SCORM web service to return user capabilities
* MDL-64656 - New web service to return the tag associated with an element
* MDL-64655 - New forum web service to return user access information
* MDL-64642 - New web service to call multiple external functions

==See also==
*[[Moodle 3.6 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.7]]

[[fr:Notes de mise à jour de Moodle 3.7]]
[[es:Notas de Moodle 3.7]]

Overview

2019-04-05T12:56:53Z

Fox: Improvments and LTS

A lot of people ask how the development of Moodle operates. This page should give you a working overview that should help in understanding a lot of other developer documentation.

==The key players==

;Martin Dougiamas: Martin is the founder lead developer of Moodle. Generally he tries to facilitate democracy and meritocracy but occasionally has to make executive decisions on things.

;[https://moodle.com/careers/ Moodle HQ]: The team of more than 20 developers who are directly funded by the Moodle project to work full-time on core developments.

;Moodle Partners: Over 50 companies around the world that provide Moodle services. These companies often have their own developers and may contribute to Moodle directly by working on core code or by creating plugins.

;Component leads: A number of people around the world have volunteered to lead various components in Moodle. This involves maintaining existing code as well as listening to the community and improving that component with new features.

There are many other people contributing to Moodle in many ways. For a full list see the [http://moodle.org/local/dev/ Moodle developers] page on moodle.org.

==How we develop the Roadmap==

The [[Roadmap]] lists the new features being developed for the next major version. This list is derived mostly from the issues with large numbers of votes in the Moodle [[Tracker]], so please vote for what you want! Other influences include general discussion, surveys and feature requests at Moodle Moots and in the Moodle forums.

Component leads decide on features in individual components so make your case to them!

==Moodle versions==

Moodle major releases (with big new features) are on a regular 6 month cycle, in May and November, since Moodle 2.6. Each major release increments the version number by 0.1 (eg 3.4 -> 3.5 -> 3.6)) and starts a new branch of minor releases.

Minor releases (with bug fixes only) are on a 2 month cycle, unless a security emergency occurs. They will increment the major release by 0.0.1 (eg 3.5 -> 3.5.1 -> 3.5.2).

The full details of these can be seen in the [[Releases]].

==Support lifetime==

Moodle HQ is committed to supporting major releases for 12 months of general fixes (usually 6 point releases) and 18 months (an additional 6 months) of security fixes.

That means we usually release minor versions for the last three major branches.

Some versions, each two years, are long term supported (LTS) for a total of 36 months, with 18 additional months of security fixes compared to other versions.

==Issue tracking==

Issue tracking is an important part of a continuous quality control process. It involves reporting of problems (bugs), ideas for improvement and new features. Unlike most proprietary software programs, Moodle issue reporting and tracking information is open to everyone. Moodle's issue tracking system is called the [http://tracker.moodle.org/ Tracker].

All Moodle users are encouraged to be active participants when it comes to testing. Anyone with a Tracker user account can create, view, comment on, vote, and watch bugs.

==Processes==

As you might guess, a large software project like Moodle with hundreds of contributors and varied opinions can be difficult to manage.

Over time we have developed a number of well-defined processes for getting code in and out of Moodle and for governing everyone's workflow in a way that is fair and clear.

See our [[Process]] document for full information on our development processes, including how you can contribute to the project.

==Coding Standards==

Over time we have distilled our best practice in writing code down into our [[Coding|Coding Guide]]. These rules cover the formatting and layout of all our code to make it consistent across the code base. If you plan to write Moodle code, you need to read it thoroughly.

==Plugins and APIs==

Although Moodle is open source and you can change anything you want, the best and most maintainable way to extend Moodle is to write a plugin (sometimes called a module). Plugins are a directory of code that can be simply "dropped" in into any Moodle installation and it will be detected, installed and automatically made available as a tool within the Moodle interface.

See our [[Plugins|Plugin documentation]] for full details of the various types of plugin available.

==See also==

* [[Finding your way into the Moodle code]]
* [[Working with the Community]]
* [[Plugin contribution]]
* [http://www.slideshare.net/poltawski/how-to-guarantee-your-change-is-integrated-to-moodle-core How to guarantee your change is integrated to Moodle core] presentation by Dan Poltawski

[[Category:Quality Assurance|Overview]]
[[Category:Processes|Overview]]

Moodle App Plugins Development Guide

2019-03-28T10:33:33Z

Fox: Typos

{{Moodle Mobile}}
{{Moodle Mobile 3.5}}

==Before 3.5==

Since Moodle 3.1 Moodle plugins could be supported in the Mobile app, but only by writing an Angular JS/Ionic module, compiling it to a zip, and including that in your plugin. See [[Moodle Mobile Remote add-ons|Remote add-ons]] for details.

In Moodle 3.5 the app switched to a new way to support plugins that was much easier for developers.
* This new way will allow developers to support plugins using PHP code, templates and Ionic markup (html components).
* The use of JavaScript is optional (but some type of advanced plugins may require it)
* Developers won’t need to set up a Mobile development environment, they will be able to test using the latest version of the official app (although setting up a local Mobile environment is recommended for complex plugins).

This means that remote add-ons won’t be necessary anymore, and developers won’t have to learn Ionic 3 / Angular and set up a new mobile development environment to migrate them. Plugins using the old Remote add-ons mechanism will have to be migrated to the new simpler way (following this documentation)

This new way is natively supported in Moodle 3.5. For previous versions you will need to install the Moodle Mobile Additional Features plugin.

==How it works==

The overall idea is to allow Moodle plugins to extend different areas in the app with ''just PHP server side'' code and Ionic 3 markup (custom html elements that are called components) using a set of custom Ionic directives and components.

Developers will have to:
# Create a db/mobile.php file in their plugins. In this file developers will be able to indicate which areas of the app they want to extend, for example, adding a new option in the main menu, implementing an activity module not supported, including a new option in the course menu, including a new option in the user profile, etc. All the areas supported are described further in this document.
# Create new functions in a reserved namespace that will return the content of the new options. The content should be returned rendered (html). The template should use [https://ionicframework.com/docs/components/ Ionic components] so that it looks native (custom html elements) but it can be generated using mustache templates.

Let’s clarify some points:

* You don’t need to create new Web Service functions (although you will be able to use them for advanced features). You just need plain php functions that will be placed in a reserved namespace.
* Those functions will be exported via the Web Service function tool_mobile_get_content
* As arguments of your functions you will always receive the userid, some relevant details of the app (app version, current language in the app, etc…) and some specific data depending on the type of plugin (courseid, cmid, …).
* We provide a list of custom Ionic components and directives (html tags) that will provide dynamic behaviour, like indicating that you are linking a file that can be downloaded, or to allow a transition to new pages into the app calling a specific function in the server, submit form data to the server etc..

==Types of plugins==

We could classify all the plugins in 3 different types:

===Templates generated and downloaded when the user opens the plugins===

[[File:Templates_downloaded_when_requested.png|thumb]]

With this type of plugin, the template of your plugin will be generated and downloaded when the user opens your plugin in the app. This means that your function will receive some context params. For example, if you're developing a course module plugin you will receive the courseid and the cmid (course module ID). You can see the list of delegates that support this type of plugin in the [[Mobile_support_for_plugins#Delegates|Delegates]] section.

===Templates downloaded on login and rendered using JS data===

[[File:Templates_downloaded_on_login.png|thumb]]

With this type of plugin, the template for your plugin will be downloaded when the user logins in the app and will be stored in the device. This means that your function will not receive any context params, and you need to return a generic template that will be built with JS data like the ones in the Mobile app. When the user opens a page that includes your plugin, your template will receive the required JS data and your template will be rendered. You can see the list of delegates that support this type of plugin in the [[Mobile_support_for_plugins#Delegates|Delegates]] section.

===Pure Javascript plugins===

You can always implement your whole plugin yourself using Javascript instead of using our API. In fact, this is required if you want to implement some features like capturing links in the Mobile app. You can see the list of delegates that only support this type of plugin in the [[Mobile_support_for_plugins#Delegates|Delegates]] section.

==Step by step example==

In this example, we are going to update an existing plugin ([https://github.com/markn86/moodle-mod_certificate Certificate activity module]) that currently uses a Remote add-on.
This is a simple activity module that displays the certificate issued for the current user along with the list of the dates of previously issued certificates. It also stores in the course log that the user viewed a certificate. This module also works offline: when the user downloads the course or activity, the data is pre-fetched and can be viewed offline.

The example code can be downloaded from here (https://github.com/markn86/moodle-mod_certificate/commit/003fbac0d80fd96baf428255500980bf95a7a0d6)

TIP: Make sure to ([https://docs.moodle.org/35/en/Developer_tools#Purge_all_caches purge all cache]) after making an edit to one of the following files for your changes to be taken into account.

===Step 1. Update the db/mobile.php file===
In this case, we are updating an existing file but for new plugins, you should create this new file.

<code php>
$addons = [
'mod_certificate' => [ // Plugin identifier
'handlers' => [ // Different places where the plugin will display content.
'coursecertificate' => [ // Handler unique name (alphanumeric).
'displaydata' => [
'icon' => $CFG->wwwroot . '/mod/certificate/pix/icon.gif',
'class' => '',
],

'delegate' => 'CoreCourseModuleDelegate', // Delegate (where to display the link to the plugin)
'method' => 'mobile_course_view', // Main function in \mod_certificate\output\mobile
'offlinefunctions' => [
'mobile_course_view' => [],
'mobile_issues_view' => [],
]. // Function that needs to be downloaded for offline.
],
],
'lang' => [ // Language strings that are used in all the handlers.
['pluginname', 'certificate'],
['summaryofattempts', 'certificate'],
['getcertificate', 'certificate'],
['requiredtimenotmet', 'certificate'],
['viewcertificateviews', 'certificate'],
],
],
];
</code>

;Plugin identifier:
: A unique name for the plugin, it can be anything (there’s no need to match the module name).

;Handlers (Different places where the plugin will display content):
: A plugin can be displayed in different views in the app. Each view should have a unique name inside the plugin scope (alphanumeric).

; Display data:
: This is only needed for certain types of plugins. Also, depending on the type of delegate it may require additional (or less fields), in this case we are indicating the module icon.

; Delegate
: Where to display the link to the plugin, see the Delegates chapter in this documentation for all the possible options.

; Method:
: This is the method in the Moodle \(component)\output\mobile class to be executed the first time the user clicks in the new option displayed in the app.

; Offlinefunctions
: These are the functions that need to be downloaded for offline usage. This is the list of functions that need to be called and stored when the user downloads a course for offline usage. Please note that you can add functions here that are not even listed in the mobile.php file.
: In our example, downloading for offline access will mean that we'll execute the functions for getting the certificate and issued certificates passing as parameters the current userid (and courseid when we are using the mod or course delegate). If we have the result of those functions stored in the app, we'll be able to display the certificate information even if the user is offline.
: Offline functions will be mostly used to display information for final users, any further interaction with the view won’t be supported offline (for example, trying to send information when the user is offline).
: You can indicate here other Web Services functions, indicating the parameters that they might need from a defined subset (currently userid and courseid)
: Prefetching the module will also download all the files returned by the methods in these offline functions (in the ''files'' array).
: Note: If your functions use additional custom parameters (for example, if you implement multiple pages within a module's view function by using a 'page' parameter in addition to the usual cmid, courseid, userid) then the app will not know which additional parameters to supply. In this case, do not list the function in offlinefunctions; instead, you will need to manually implement a [[#Module_prefetch_handler|module prefetch handler]].

;Lang:
: The language pack string ids used in the plugin by all the handlers. Normally these will be strings from your own plugin, however, you can list any strings you need here (e.g. ['cancel', 'moodle']).
: Please only include the strings you actually need. The Web Service that returns the plugin information will include the translation of each string id for every language installed in the platform, and this will then be cached, so listing too many strings is very wasteful.

There are additional attributes supported by the mobile.php list, see “Mobile.php supported options” section below.

===Step 2. Creating the main function===

The main function displays the current issued certificate (or several warnings if it’s not possible to issue a certificate). It also displays a link to view the dates of previously issued certificates.

All the functions must be created in the plugin or subsystem classes/output directory, the name of the class must be mobile.

For this example (mod_certificate plugin) the namespace name will be mod_certificate\output.

'''File contents: mod/certificate/classes/output/mobile.php'''

<code php>
<?php
namespace mod_certificate\output;

defined('MOODLE_INTERNAL') || die();

use context_module;
use mod_certificate_external;

/**
* Mobile output class for certificate
*
* @package mod_certificate
* @copyright 2018 Juan Leyva
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mobile {

/**
* Returns the certificate course view for the mobile app.
* @param array $args Arguments from tool_mobile_get_content WS
*
* @return array HTML, javascript and otherdata
*/
public static function mobile_course_view($args) {
global $OUTPUT, $USER, $DB;

$args = (object) $args;
$cm = get_coursemodule_from_id('certificate', $args->cmid);

// Capabilities check.
require_login($args->courseid , false , $cm, true, true);

$context = context_module::instance($cm->id);

require_capability ('mod/certificate:view', $context);
if ($args->userid != $USER->id) {
require_capability('mod/certificate:manage', $context);
}
$certificate = $DB->get_record('certificate', array('id' => $cm->instance));

// Get certificates from external (taking care of exceptions).
try {
$issued = mod_certificate_external::issue_certificate($cm->instance);
$certificates = mod_certificate_external::get_issued_certificates($cm->instance);
$issues = array_values($certificates['issues']); // Make it mustache compatible.
} catch (Exception $e) {
$issues = array();
}

// Set timemodified for each certificate.
foreach ($issues as $issue) {
if (empty($issue->timemodified)) {
$issue->timemodified = $issue->timecreated;
}
}

$showget = true;
if ($certificate->requiredtime && !has_capability('mod/certificate:manage', $context)) {
if (certificate_get_course_time($certificate->course) < ($certificate->requiredtime * 60)) {
$showget = false;
}
}

$certificate->name = format_string($certificate->name);
list($certificate->intro, $certificate->introformat) =
external_format_text($certificate->intro, $certificate->introformat, $context->id,'mod_certificate', 'intro');
$data = array(
'certificate' => $certificate,
'showget' => $showget && count($issues) > 0,
'issues' => $issues,
'issue' => $issues[0],
'numissues' => count($issues),
'cmid' => $cm->id,
'courseid' => $args->courseid
);

return [
'templates' => [
[
'id' => 'main',
'html' => $OUTPUT->render_from_template('mod_certificate/mobile_view_page', $data),
],
],
'javascript' => '',
'otherdata' => '',
'files' => $issues,
];
}
}
</code>

Let’s go through the function code to analyse the different parts.

;Function declaration:
: The function name is the same as the one used in the mobile.php file (method field). There is only one argument “$args” which is an array containing all the information sent by the mobile app (the courseid, userid, appid, appversionname, appversioncode, applang, appcustomurlscheme…)

; Function implementation:
: In the first part of the function, we check permissions and capabilities (like a view.php script would do normally). Then we retrieve the certificate information that’s necessary to display the template.

Finally, we return:
* The rendered template (notice that we could return more than one template but we usually would only need one). By default the app will always render the first template received, the rest of the templates can be used if the plugin defines some Javascript code.
* JavaScript: Empty, because we don’t need any in this case
* Other data: Empty as well, because we don’t need any additional data to be used by directives or components in the template. This field will be published as an object supporting 2-way-data-bind to the template.
* Files: A list of files that the app should be able to download (for offline usage mostly)

===Step 3. Creating the template for the main function===

This is the most important part of your plugin because it contains the code that will be rendered on the mobile app.

In this template we’ll be using Ionic and custom directives and components available in the Mobile app.

All the HTML attributes starting with ion- are ionic components. Most of the time the component name is self-explanatory but you may refer to a detailed guide here: https://ionicframework.com/docs/components/

All the HTML attributes starting with ''core-'' are custom components of the Mobile app.

'''File contents: mod/certificate/templates/mobile_view_page.mustache'''

<code xml>
{{=<% %>=}}
<div>
<core-course-module-description description="<% certificate.intro %>" component="mod_certificate" componentId="<% cmid %>"></core-course-module-description>

<ion-list>
<ion-list-header>
<p class="item-heading">{{ 'plugin.mod_certificate.summaryofattempts' | translate }}</p>
</ion-list-header>

<%#issues%>
<ion-item>
<button ion-button block color="light" core-site-plugins-new-content title="<% certificate.name %>" component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}">
{{ 'plugin.mod_certificate.viewcertificateviews' | translate: {$a: <% numissues %>} }}
</button>
</ion-item>
<%/issues%>

<%#showget%>
<ion-item>
<button ion-button block core-course-download-module-main-file moduleId="<% cmid %>" courseId="<% certificate.course %>" component="mod_certificate" [files]="[{fileurl: '<% issue.fileurl %>', filename: '<% issue.filename %>', timemodified: '<% issue.timemodified %>', mimetype: '<% issue.mimetype %>'}]">
<ion-icon name="cloud-download" item-start></ion-icon>
{{ 'plugin.mod_certificate.getcertificate' | translate }}
</button>
</ion-item>
<%/showget%>

<%^showget%>
<ion-item>
<p>{{ 'plugin.mod_certificate.requiredtimenotmet' | translate }}</p>
</ion-item>
<%/showget%>


<span core-site-plugins-call-ws-on-load name="mod_certificate_view_certificate" [params]="{certificateid: <% certificate.id %>}" [preSets]="{getFromCache: 0, saveToCache: 0}"></span>
</ion-list>
</div>
</code>

In the first line of the template we switch delimiters to avoid conflicting with Ionic delimiters (that are curly brackets like mustache).

Then we display the module description using <code><core-course-module-description</code> that is a component used to include the course module description.

For displaying the certificate information we create a list of elements, adding a header on top.
The following line <code>{{ 'plugin.mod_certificate.summaryofattempts' | translate }}</code> indicates that the Mobile app will translate the ''summaryofattempts'' string id (here we could’ve used mustache translation but it is usually better to delegate the strings translations to the app). The string id has this format:

“plugin” + plugin identifier (from mobile.php) + string id (the string must be indicated in the lang field in mobile.php).

Then we display a button to transition to another page if there are certificates issued. The attribute (directive) <code>core-site-plugins-new-content</code> indicates that if the user clicks the button, we need to call the function “mobile_issues_view” in the component “mod_certificate” passing as arguments the cmid and courseid. The content returned by this function will be displayed in a new page (see Step 4 for the code of this new page).

Just after this button we display another one but this time for downloading an issued certificate. The <code>core-course-download-module-main-file</code> directive indicates that clicking this button is for downloading the whole activity and opening the main file. This means that, when the user clicks this button, the whole certificate activity will be available in offline.

Finally, just before the ion-list is closed, we use the <code>core-site-plugins-call-ws-on-load</code> directive to indicate that once the page is loaded, we need to call to a Web Service function in the server, in this case we are calling the ''mod_certificate_view_certificate'' that will log that the user viewed this page.

As you can see, no JavaScript was necessary at all. We used plain HTML elements and attributes that did all the complex dynamic logic (like calling a Web Service) behind the scenes.

===Step 4. Adding an additional page===

'''Partial file contents: mod/certificate/classes/output/mobile.php'''

<code php>
/**
* Returns the certificate issues view for the mobile app.
* @param array $args Arguments from tool_mobile_get_content WS
*
* @return array HTML, javascript and otherdata
*/
public static function mobile_issues_view($args) {
global $OUTPUT, $USER, $DB;

$args = (object) $args;
$cm = get_coursemodule_from_id('certificate', $args->cmid);

// Capabilities check.
require_login($args->courseid , false , $cm, true, true);

$context = context_module::instance($cm->id);

require_capability ('mod/certificate:view', $context);
if ($args->userid != $USER->id) {
require_capability('mod/certificate:manage', $context);
}
$certificate = $DB->get_record('certificate', array('id' => $cm->instance));

// Get certificates from external (taking care of exceptions).
try {
$issued = mod_certificate_external::issue_certificate($cm->instance);
$certificates = mod_certificate_external::get_issued_certificates($cm->instance);
$issues = array_values($certificates['issues']); // Make it mustache compatible.
} catch (Exception $e) {
$issues = array();
}

$data = [
'issues' => $issues
];

return [
'templates' => [
[
'id' => 'main',
'html' => $OUTPUT->render_from_template('mod_certificate/mobile_view_issues', $data),
],
],
'javascript' => '',
'otherdata' => '',
];
}
</code>

This function for the new page was added just after the mobile_course_view function, the code is quite similar: Capabilities checks, retrieves the information required for the template and returns the template rendered.

The code of the mustache template is also very simple:

'''File contents: mod/certificate/templates/mobile_view_issues.mustache'''

<code xml>
{{=<% %>=}}
<div>
<ion-list>
<%#issues%>
<ion-item>
<p class="item-heading">{{ <%timecreated%> | coreToLocaleString }}</p>
<p><%grade%></p>
</ion-item>
<%/issues%>
</ion-list>
</div>
</code>

As we did in the previous template, in the first line of the template we switch delimiters to avoid conflicting with Ionic delimiters (that are curly brackets like mustache).

Here we are creating an ionic list that will display a new item in the list per each issued certificated.

For the issued certificated we’ll display the time when it was created (using the app filter ''coreToLocaleString''). We are also displaying the grade displayed in the certificate (if any).

===Step 5. Plugin webservices, if included===

If your plugin uses its own web services, they will also need to be enabled for mobile access in your db/services.php file.

The following line <code>'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE, 'local_mobile'],</code> should be included in each webservice definition.

'''File contents: mod/certificate/db/services.php'''

<code php>
$functions = [

'mod_certificate_get_certificates_by_courses' => [
'classname' => 'mod_certificate_external',
'methodname' => 'get_certificates_by_courses',
'description' => 'Returns a list of certificate instances...',
'type' => 'read',
'capabilities' => 'mod/certificate:view',
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE, 'local_mobile'],
],
];
</code>

This extra services definition is the reason why you will need to have the local_mobile plugin installed for Moodle versions 3.4 and lower, so that your Moodle site will have all the additional webservices included to deal with all these mobile access calls. This is explained further in the [https://docs.moodle.org/dev/Mobile_support_for_plugins#Moodle_version_requirements Moodle version requirements section] below.

==Getting started==

The first and most important thing to know is that you don’t need a local mobile environment, you can just use the Chrome or Chromium browser to add mobile support to your plugins!

Open this URL (with Chrome or Chromium browser): https://mobileapp.moodledemo.net/ and you will see a web version of the mobile app completely functional (except for some native features). This URL is updated with the latest integration version of the app.

Please test that your site works correctly in the web version before starting any development.

===Moodle version requirements===

If your Moodle version is lower than 3.5 you will need to install the [https://docs.moodle.org/en/Moodle_Mobile_additional_features Moodle Mobile additional features plugin].

Please use this development version for now: https://github.com/moodlehq/moodle-local_mobile/commits/MOODLE_31_STABLE (if your Moodle version is 3.2, 3.3 or 3.4) you will have to use the specific branch for your version but applying manually the [https://github.com/moodlehq/moodle-local_mobile/commits/MOODLE_31_STABLE last commit from the 3.1 branch] (the one with number MOBILE-2362).

Also, when installing the Moodle Mobile Additional features plugin you must follow the installation instructions so the service is set up properly.

Remember to update your plugin documentation to reflect that this plugin is mandatory for Mobile support. We don’t recommend to indicate in your plugin version.php a dependency to local_mobile though.

===Development workflow===

First of all, we recommend creating a simple ''mobile.php'' for displaying a new main menu option (even if your plugin won’t be in the main menu, just to verify that you are able to extend the app plugins). Then open the webapp (https://mobileapp.moodledemo.net/) or refresh the browser if it was already open. Check that you can correctly see the new menu option you included.

Then, develop the main function of the app returning a “Hello world” or basic code (without using templates) to see that everything works together. After adding the classes/output/mobile.php file it is very important to “Purge all caches” to avoid problems with the auto-loading cache.

It is important to remember that:
* Any change in the mobile.php file will require you to refresh the web app page in the browser (remember to disable the cache in the Chrome developer options).
* Any change in an existing template or function won’t require to refresh the browser page. In most cases you should just do a PTR (Pull down To Refresh) in the page that displays the view returned by the function. Be aware that PTR will work only when using the “device” emulation in the browser (see following section).

===Testing and debugging===

To learn how to debug with the web version of the app, please read the following documents:
* [[Moodle Mobile debugging WS requests]] AND
* [[Moodle Mobile development using Chrome or Chromium]] (please, omit the installation section)

For plugins using the Javascript API you may develop making use of the console.log function to add trace messages in your code that will be displayed in the browser console.

Within the app, make sure to turn on the option: '''App settings''' / '''General''' / '''Display debug messages'''. This means popup errors from the app will show more information.

==Mobile.php supported options==

In the Step by Step section we learned about some of the existing options for handlers configuration. This is the full list of supported options:

===Common options===

* '''delegate''' (mandatory): Name of the delegate to register the handler in.
* '''method''' (mandatory): The function to call to retrieve the main page content.
* '''init''' (optional): A function to call to retrieve the initialization JS and the "restrict" to apply to the whole handler. It can also return templates that can be used from the Javascript of the init method or the Javascript of the handler’s method.
* '''restricttocurrentuser''' (optional) Only used if the delegate has a isEnabledForUser function. If true, the handler will only be shown for current user. For more info about displaying the plugin only for certain users, please see [[Mobile_support_for_plugins#Display_the_plugin_only_if_certain_conditions_are_met|Display the plugin only if certain conditions are met]].
* '''restricttoenrolledcourses''' (optional): Only used if the delegate has a isEnabledForCourse function. If true or not defined, the handler will only be shown for courses the user is enrolled in. For more info about displaying the plugin only for certain courses, please see [[Mobile_support_for_plugins#Display_the_plugin_only_if_certain_conditions_are_met|Display the plugin only if certain conditions are met]].
* '''styles''' (optional): An array with two properties: ''url'' and ''version''. The URL should point to a CSS file, either using an absolute URL or a relative URL. This file will be downloaded and applied by the app. It's recommended to include styles that will only affect your plugin templates. The version number is used to determine if the file needs to be downloaded again, you should change the version number everytime you change the CSS file.

===Options only for CoreCourseOptionsDelegate===

* '''displaydata''' (mandatory): title, class.
* '''priority''' (optional): Priority of the handler. Higher priority is displayed first.

===Options only for CoreMainMenuDelegate===

* '''displaydata''' (mandatory): title, icon, class.
* '''priority''' (optional): Priority of the handler. Higher priority is displayed first. Main Menu plugins are always displayed in the "More" tab, they cannot be displayed as tabs in the bottom bar.

===Options only for CoreCourseModuleDelegate===

* '''displaydata''' (mandatory): icon, class.
* '''offlinefunctions''': (optional) List of functions to call when prefetching the module. It can be a get_content method or a WS. You can filter the params received by the WS. By default, WS will receive these params: courseid, cmid, userid. Other valid values that will be added if they are present in the list of params: courseids (it will receive a list with the courses the user is enrolled in), component + 'id' (e.g. certificateid).
* '''downloadbutton''': (optional) Whether to display download button in the module. If not defined, the button will be shown if there is any offlinefunction.
* '''isresource''': (optional) Whether the module is a resource or an activity. Only used if there is any offlinefunction. If your module relies on the "contents" field, then it should be true.
* '''updatesnames''': (optional) Only used if there is any offlinefunction. A Regular Expression to check if there's any update in the module. It will be compared to the result of ''core_course_check_updates''.
* '''displayopeninbrowser''': (optional) Supported from the 3.6 version of the app. Whether the module should display the "Open in browser" option in the top-right menu. This can be done in JavaScript too: this.displayOpenInBrowser = false;
* '''displaydescription''': (optional) Supported from the 3.6 version of the app. Whether the module should display the "Description" option in the top-right menu. This can be done in JavaScript too: this.displayDescription = false;
* '''displayrefresh''': (optional) Supported from the 3.6 version of the app. Whether the module should display the "Refresh" option in the top-right menu. This can be done in JavaScript too: this.displayRefresh = false;
* '''displayprefetch''': (optional) Supported from the 3.6 version of the app. Whether the module should display the download option in the top-right menu. This can be done in JavaScript too: this.displayPrefetch = false;
* '''displaysize''': (optional) Supported from the 3.6 version of the app. Whether the module should display the downloaded size in the top-right menu. This can be done in JavaScript too: this.displaySize = false;

===Options only for CoreCourseFormatDelegate===

* '''canviewallsections''': (optional) Whether the course format allows seeing all sections in a single page. Defaults to true.
* '''displayenabledownload''': (optional) Whether the option to enable section/module download should be displayed. Defaults to true.
* '''displaysectionselector''': (optional) Whether the default section selector should be displayed. Defaults to true.

===Options only for CoreUserDelegate===

* '''displaydata''' (mandatory): title, icon, class.
* '''type''': The type of the addon. Values accepted: 'newpage' (default) or 'communication'.
* '''priority''' (optional): Priority of the handler. Higher priority is displayed first.

===Options only for CoreSettingsDelegate===

* '''displaydata''' (mandatory): title, icon, class.
* '''priority''' (optional): Priority of the handler. Higher priority is displayed first.

===Options only for AddonMessageOutputDelegate===

* '''displaydata''' (mandatory): title, icon.
* '''priority''' (optional): Priority of the handler. Higher priority is displayed first.

==Delegates==

The delegates can be classified by type of plugin. For more info about type of plugins, please see the See [[Mobile_support_for_plugins#Types_of_plugins|Types of plugins]] section.

===Templates generated and downloaded when the user opens the plugins===

====CoreMainMenuDelegate====

You must use this delegate when you want to add new items to the main menu (currently displayed at the bottom of the app).

====CoreCourseOptionsDelegate====

You must use this delegate when you want to add new options in a course (Participants or Grades are examples of this type of delegate).

====CoreCourseModuleDelegate====

You must use this delegate for supporting activity modules or resources.

====CoreUserDelegate====

You must use this delegate when you want to add additional options in the user profile page in the app.

====CoreCourseFormatDelegate====

You must use this delegate for supporting course formats.

====CoreSettingsDelegate====

You must use this delegate to add a new option in the settings page.

====AddonMessageOutputDelegate====

You must use this delegate to support a message output plugin.

===Templates downloaded on login and rendered using JS data===

====CoreQuestionDelegate====

You must use this delegate for supporting question types.
https://docs.moodle.org/dev/Creating_mobile_question_types

====CoreQuestionBehaviourDelegate====

You must use this delegate for supporting question behaviours.

====CoreUserProfileFieldDelegate====

You must use this delegate for supporting user profile fields.

====AddonModQuizAccessRuleDelegate====

You must use this delegate to support a quiz access rule.

====AddonModAssignSubmissionDelegate and AddonModAssignFeedbackDelegate====

You must use these delegates to support assign submission or feedback plugins.

====AddonWorkshopAssessmentStrategyDelegate====

You must use this delegate to support a workshop assessment strategy plugin.

===Pure Javascript plugins===

These delegates require JavaScript to be supported. See [[Mobile_support_for_plugins#Initialization|Initialization]] for more information.

* CoreContentLinksDelegate
* CoreCourseModulePrefetchDelegate
* CoreFileUploaderDelegate
* CorePluginFileDelegate

==Available components and directives==

===Difference between component and directives===

A component (represented as an HTML tag) is used to add custom elements to the app.
Example of components are: ion-list, ion-item, core-search-box

A directive (represented as an HTML attribute) allows you to extend a piece of HTML with additional information or functionality.
Example of directives are: core-auto-focus, *ngIf, ng-repeat

The Mobile app uses Angular, Ionic and custom components and directives, for a full reference of:
* Angular directives, please check: https://angular.io/api?type=directive
* Ionic components, please check: https://ionicframework.com/docs/

===Custom core components and directives===

These are some useful custom components and directives (only available in the mobile app). Please notice that this isn’t the full list of components and directives of the app, it’s just an extract of the most common ones.

====core-format-text====

This directive formats the text and adds some directives needed for the app to work as it should. For example, it treats all links and all the embedded media so they work fine in the app. If some content in your template includes links or embedded media, please use this directive.

This directive automatically applies core-external-content and core-link to all the links and embedded media.

Data that can be passed to the directive:

* '''text''' (string): The text to format.
* '''siteId''' (string): Optional. Site ID to use. If not defined, current site.
* '''component''' (string): Optional. Component to use when downloading embedded files.
* '''componentId''' (string|number): Optional. ID to use in conjunction with the component.
* '''adaptImg''' (boolean): Optional. Whether to adapt images to screen width. Defaults to true.
* '''clean''' (boolean): Optional. Whether all the HTML tags should be removed. Defaults to false.
* '''singleLine''' (boolean): Optional. Whether new lines should be removed (all text in single line). Only if clean=true. Defaults to false.
* '''maxHeight''' (number): Optional. Max height in pixels to render the content box. It should be 50 at least to make sense. Using this parameter will force display: block to calculate height better. If you want to avoid this use class="inline" at the same time to use display: inline-block.
* '''fullOnClick''' (boolean): Optional. Whether it should open a new page with the full contents on click. Only if maxHeight is set and the content has been collapsed. Defaults to false.
* '''fullTitle''' (string): Optional. Title to use in full view. Defaults to "Description".

Example usage:

<code php>
<core-format-text text="<% cm.description %>" component="mod_certificate" componentId="<% cm.id %>"></core-format-text>
</code>

====core-link====

Directive to handle a link. It performs several checks, like checking if the link needs to be opened in the app, and opens the link as it should (without overriding the app).

This directive is automatically applied to all the links and media inside core-format-text.

Data that can be passed to the directive:

* '''capture''' (boolean): Optional. Whether the link needs to be captured by the app (check if the link can be handled by the app instead of opening it in a browser).
* '''inApp''' (boolean): Optional. True to open in embedded browser, false to open in system browser.
* '''autoLogin''' (string): Optional. If the link should be open with auto-login. Accepts the following values:
** "yes" -> Always auto-login.
** "no" -> Never auto-login.
** "check" -> Auto-login only if it points to the current site. Default value.

Example usage:
<code php>
<a href="<% cm.url %>" core-link>
</code>

====core-external-content====

Directive to handle links to files and embedded files. This directive should be used in any link to a file or any embedded file that you want to have available when the app is offline.

If a file is downloaded, its URL will be replaced by the local file URL.

This directive is automatically applied to all the links and media inside core-format-text.

Data that can be passed to the directive:

* '''siteId''' (string): Optional. Site ID to use. If not defined, current site.
* '''component''' (string): Optional. Component to use when downloading embedded files.
* '''componentId''' (string|number): Optional. ID to use in conjunction with the component.

Example usage:
<code php>
<img src="<% event.iconurl %>" core-external-content component="mod_certificate" componentId="<% event.id %>">
</code>

====core-user-link====

Directive to go to user profile on click. When the user clicks the element where this directive is attached, the right user profile will be opened.

Data that can be passed to the directive:

* '''userId''' (number): User id to open the profile.
* '''courseId''' (number): Optional. Course id to show the user info related to that course.

Example usage:
<code php>
<a ion-item core-user-link userId="<% userid %>">
</code>

====core-file====

Component to handle a remote file. It shows the file name, icon (depending on mimetype) and a button to download/refresh it. The user can identify if the file is downloaded or not based on the button.

Data that can be passed to the directive:

* file (object): The file. Must have a property 'filename' and a 'fileurl' or 'url'
* component (string): Optional. Component the file belongs to.
* componentId (string|number): Optional. ID to use in conjunction with the component.
* canDelete (boolean): Optional. Whether file can be deleted.
* alwaysDownload (boolean): Optional. Whether it should always display the refresh button when the file is downloaded. Use it for files that you cannot determine if they're outdated or not.
* canDownload (boolean): Optional. Whether file can be downloaded. Defaults to true.

Example usage:
<code php>
<core-file [file]="{fileurl: '<% issue.url %>', filename: '<% issue.name %>', timemodified: '<% issue.timemodified %>', filesize: '<% issue.size %>'}" component="mod_certificate" componentId="<% cm.id %>"></core-file>
</code>

====core-download-file====

Directive to allow downloading and open a file. When the item with this directive is clicked, the file will be downloaded (if needed) and opened.

It is usually recommended to use the core-file component since it also displays the state of the file.

Data that can be passed to the directive:

* '''core-download-file''' (object): The file to download.
* '''component''' (string): Optional. Component to link the file to.
* '''componentId''' (string|number): Optional. Component ID to use in conjunction with the component.

Example usage: a button to download a file.
<code php>
<button ion-button [core-download-file]="{fileurl: <% issue.url %>, timemodified: <% issue.timemodified %>, filesize: <% issue.size %>}" component="mod_certificate" componentId="<% cm.id %>">
{{ 'plugin.mod_certificate.download | translate }}
</button>
</code>

====core-course-download-module-main-file====

Directive to allow downloading and opening the main file of a module.

When the item with this directive is clicked, the whole module will be downloaded (if needed) and its main file opened. This is meant for modules like mod_resource.

This directive must receive either a module or a moduleId. If no files are provided, it will use module.contents.

Data that can be passed to the directive:

* '''module''' (object): Optional. The module object. Required if module is not supplied.
* '''moduleId''' (number): Optional. The module ID. Required if module is not supplied.
* '''courseId''' (number): The course ID the module belongs to.
* '''component''' (string): Optional. Component to link the file to.
* '''componentId''' (string|number): Optional. Component ID to use in conjunction with the component. If not defined, moduleId.
* '''files''' (object[]): Optional. List of files of the module. If not provided, use module.contents.

Example usage:
<code php>
<button ion-button block core-course-download-module-main-file moduleId="<% cmid %>" courseId="<% certificate.course %>" component="mod_certificate" [files]="[{fileurl: '<% issue.fileurl %>', filename: '<% issue.filename %>', timemodified: '<% issue.timemodified %>', mimetype: '<% issue.mimetype %>'}]">
{{ 'plugin.mod_certificate.getcertificate' | translate }}
</button>
</code>

====core-navbar-buttons====

Component to add buttons to the app's header without having to place them inside the header itself. Using this component in a site plugin will allow adding buttons to the header of the current page.

If this component indicates a position (start/end), the buttons will only be added if the header has some buttons in that position. If no start/end is specified, then the buttons will be added to the first <ion-buttons> found in the header.

You can use the [hidden] input to hide all the inner buttons if a certain condition is met.

Example usage:
<code php>
<core-navbar-buttons end>
<button ion-button icon-only (click)="action()">
<ion-icon name="funnel"></ion-icon>
</button>
</core-navbar-buttons>
</code>

You can also use this to add options to the context menu. Example usage:

<code php>
<core-navbar-buttons>
<core-context-menu>
<core-context-menu-item [priority]="500" [content]="'Nice boat'" (action)="boatFunction()" [iconAction]="'boat'"></core-context-menu-item>
</core-context-menu>
</core-navbar-buttons>
</code>

Note that it is not currently possible to remove or modify options from the context menu without using a nasty hack.

===Specific component and directives for plugins===

These are component and directives created specifically for supporting Moodle plugins.

====core-site-plugins-new-content====

Directive to display a new content when clicked. This new content can be displayed in a new page or in the current page (only if the current page is already displaying a site plugin content).

Data that can be passed to the directive:

* '''component''' (string): The component of the new content.
* '''method''' (string): The method to get the new content.
* '''args''' (object): The params to get the new content.
* '''preSets''' (object): Extra options for the WS call of the new content: whether to use cache or not, etc. This field was added in v3.6.0.
* '''title''' (string): The title to display with the new content. Only if samePage=false.
* '''samePage''' (boolean): Whether to display the content in same page or open a new one. Defaults to new page.
* '''useOtherData''' (any): Whether to include ''otherdata'' (from the ''get_content'' WS call) in the args for the new ''get_content'' call. The format is the same as in ''useOtherDataForWS''. If not supplied, no other data will be added. If supplied but empty (null, false or empty string) all the ''otherdata'' will be added. If it’s an array, it will only copy the properties whose names are in the array.
* '''form''' (string): ID or name to identify a form in the template. The form will be obtained from ''document.forms''. If supplied and form is found, the form data will be retrieved and sent to the new ''get_content'' WS call. If your form contains an ion-radio, ion-checkbox or ion-select, please see [[Mobile_support_for_plugins#Values_of_ion-radio.2C_ion-checkbox_or_ion-select_aren.27t_sent_to_my_WS|Values of ion-radio, ion-checkbox or ion-select aren't sent to my WS]].

Example usages:

A button to go to a new content page:
<code php>
<button ion-button core-site-plugins-new-content title="<% certificate.name %>" component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}">
{{ 'plugin.mod_certificate.viewissued' | translate }}
</button>
</code>

A button to load new content in current page using userid from otherdata:
<code php>
<button ion-button core-site-plugins-new-content component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}" samePage="true" [useOtherData]="['userid']">
{{ 'plugin.mod_certificate.viewissued' | translate }}
</button>
</code>

====core-site-plugins-call-ws====

Directive to call a WS when the element is clicked. The action to do when the WS call is successful depends on the provided data: display a message, go back or refresh current view.

If you want to load a new content when the WS call is done, please see core-site-plugins-call-ws-new-content.

Data that can be passed to the directive:

* '''name''' (string): The name of the WS to call.
* '''params''' (object): The params for the WS call.
* '''preSets''' (object): Extra options for the WS call: whether to use cache or not, etc.
* '''useOtherDataForWS''' (any): Whether to include ''otherdata'' (from the ''get_content'' WS call) in the params for the WS call. If not supplied, no other data will be added. If supplied but empty (null, false or empty string) all the ''otherdata'' will be added. If it’s an array, it will only copy the properties whose names are in the array.
* '''form''' (string): ID or name to identify a form in the template. The form will be obtained from ''document.forms''. If supplied and form is found, the form data will be retrieved and sent to the WS. If your form contains an ion-radio, ion-checkbox or ion-select, please see [[Mobile_support_for_plugins#Values_of_ion-radio.2C_ion-checkbox_or_ion-select_aren.27t_sent_to_my_WS|Values of ion-radio, ion-checkbox or ion-select aren't sent to my WS]].
* '''confirmMessage''' (string): Message to confirm the action when the user clicks the element. If not supplied, no confirmation. If supplied but empty, default message ("Are you sure?").
* '''showError''' (boolean): Whether to show an error message if the WS call fails. Defaults to true. This field was added in v3.5.2.
* '''successMessage''' (string): Message to show on success. If not supplied, no message. If supplied but empty, default message (“Success”).
* '''goBackOnSuccess''' (boolean): Whether to go back if the WS call is successful.
* '''refreshOnSuccess''' (boolean): Whether to refresh the current view if the WS call is successful.
* '''onSuccess''' (Function): A function to call when the WS call is successful (HTTP call successful and no exception returned). This field was added in v3.5.2.
* '''onError''' (Function): A function to call when the WS call fails (HTTP call fails or an exception is returned). This field was added in v3.5.2.
* '''onDone''' (Function): A function to call when the WS call finishes (either success or fail). This field was added in v3.5.2.

Example usages:

A button to send some data to the server without using cache, displaying default messages and refreshing on success:
<code php>
<button ion-button core-site-plugins-call-ws name="mod_certificate_view_certificate" [params]="{certificateid: <% certificate.id %>}" [preSets]="{getFromCache: 0, saveToCache: 0}" confirmMessage successMessage refreshOnSuccess="true">
{{ 'plugin.mod_certificate.senddata' | translate }}
</button>
</code>

A button to send some data to the server using cache without confirming, going back on success and using userid from otherdata:
<code php>
<button ion-button core-site-plugins-call-ws name="mod_certificate_view_certificate" [params]="{certificateid: <% certificate.id %>}" goBackOnSuccess="true" [useOtherData]="['userid']">
{{ 'plugin.mod_certificate.senddata' | translate }}
</button>
</code>

Same example as the previous one but implementing a custom JS code to run on success:

<code php>
<button ion-button core-site-plugins-call-ws name="mod_certificate_view_certificate" [params]="{certificateid: <% certificate.id %>}" [useOtherData]="['userid']" (onSuccess)="certificateViewed($event)">
{{ 'plugin.mod_certificate.senddata' | translate }}
</button>
</code>
<code javascript>
this.certificateViewed = function(result) {
// Code to run when the WS call is successful.
};
</code>

====core-site-plugins-call-ws-new-content====

Directive to call a WS when the element is clicked and load a new content passing the WS result as args. This new content can be displayed in a new page or in the same page (only if current page is already displaying a site plugin content).

If you don't need to load some new content when done, please see core-site-plugins-call-ws.

Data that can be passed to the directive:

* '''name''' (string): The name of the WS to call.
* '''params''' (object): The params for the WS call.
* '''preSets''' (object): Extra options for the WS call: whether to use cache or not, etc.
* '''useOtherDataForWS''' (any): Whether to include ''otherdata'' (from the ''get_content'' WS call) in the params for the WS call. If not supplied, no other data will be added. If supplied but empty (null, false or empty string) all the ''otherdata'' will be added. If it’s an array, it will only copy the properties whose names are in the array.
* '''form''' (string): ID or name to identify a form in the template. The form will be obtained from ''document.forms''. If supplied and form is found, the form data will be retrieved and sent to the WS. If your form contains an ion-radio, ion-checkbox or ion-select, please see [[Mobile_support_for_plugins#Values_of_ion-radio.2C_ion-checkbox_or_ion-select_aren.27t_sent_to_my_WS|Values of ion-radio, ion-checkbox or ion-select aren't sent to my WS]].
* '''confirmMessage''' (string): Message to confirm the action when the user clicks the element. If not supplied, no confirmation. If supplied but empty, default message ("Are you sure?").
* '''showError''' (boolean): Whether to show an error message if the WS call fails. Defaults to true. This field was added in v3.5.2.
* '''component''' (string): The component of the new content.
* '''method''' (string): The method to get the new content.
* '''args''' (object): The params to get the new content.
* '''title''' (string): The title to display with the new content. Only if samePage=false.
* '''samePage''' (boolean): Whether to display the content in same page or open a new one. Defaults to new page.
* '''useOtherData''' (any): Whether to include ''otherdata'' (from the ''get_content'' WS call) in the args for the new ''get_content'' call. The format is the same as in ''useOtherDataForWS''.
* '''jsData''' (any): JS variables to pass to the new page so they can be used in the template or JS. If true is supplied instead of an object, all initial variables from current page will be copied. This field was added in v3.5.2.
* '''newContentPreSets''' (object): Extra options for the WS call of the new content: whether to use cache or not, etc. This field was added in v3.6.0.
* '''onSuccess''' (Function): A function to call when the WS call is successful (HTTP call successful and no exception returned). This field was added in v3.5.2.
* '''onError''' (Function): A function to call when the WS call fails (HTTP call fails or an exception is returned). This field was added in v3.5.2.
* '''onDone''' (Function): A function to call when the WS call finishes (either success or fail). This field was added in v3.5.2.

Example usages:

A button to get some data from the server without using cache, showing default confirm and displaying a new page:
<code php>
<button ion-button core-site-plugins-call-ws-new-content name="mod_certificate_get_issued_certificates" [params]="{certificateid: <% certificate.id %>}" [preSets]="{getFromCache: 0, saveToCache: 0}" confirmMessage title="<% certificate.name %>" component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}">
{{ 'plugin.mod_certificate.getissued' | translate }}
</button>
</code>

A button to get some data from the server using cache, without confirm, displaying new content in same page and using ''userid'' from ''otherdata'':
<code php>
<button ion-button core-site-plugins-call-ws-new-content name="mod_certificate_get_issued_certificates" [params]="{certificateid: <% certificate.id %>}" component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}" samePage="true" [useOtherData]="['userid']">
{{ 'plugin.mod_certificate.getissued' | translate }}
</button>
</code>

Same example as the previous one but implementing a custom JS code to run on success:

<code php>
<button ion-button core-site-plugins-call-ws-new-content name="mod_certificate_get_issued_certificates" [params]="{certificateid: <% certificate.id %>}" component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}" samePage="true" [useOtherData]="['userid']" (onSuccess)="callDone($event)">
{{ 'plugin.mod_certificate.getissued' | translate }}
</button>
</code>
<code javascript>
this.callDone = function(result) {
// Code to run when the WS call is successful.
};
</code>

====core-site-plugins-call-ws-on-load====

Directive to call a WS as soon as the template is loaded. This directive is meant for actions to do in the background, like calling logging Web Services.

If you want to call a WS when the user clicks on a certain element, please see core-site-plugins-call-ws.

Note that this will cause an error to appear on each page load if the user is offline in v3.5.1 and older, the bug was fixed in v3.5.2.

* '''name''' (string): The name of the WS to call.
* '''params''' (object): The params for the WS call.
* '''preSets''' (object): Extra options for the WS call: whether to use cache or not, etc.
* '''useOtherDataForWS''' (any): Whether to include ''otherdata'' (from the ''get_content'' WS call) in the params for the WS call. If not supplied, no other data will be added. If supplied but empty (null, false or empty string) all the ''otherdata'' will be added. If it’s an array, it will only copy the properties whose names are in the array.
* '''form''' (string): ID or name to identify a form in the template. The form will be obtained from ''document.forms''. If supplied and form is found, the form data will be retrieved and sent to the WS. If your form contains an ion-radio, ion-checkbox or ion-select, please see [[Mobile_support_for_plugins#Values_of_ion-radio.2C_ion-checkbox_or_ion-select_aren.27t_sent_to_my_WS|Values of ion-radio, ion-checkbox or ion-select aren't sent to my WS]].
* '''onSuccess''' (Function): A function to call when the WS call is successful (HTTP call successful and no exception returned). This field was added in v3.5.2.
* '''onError''' (Function): A function to call when the WS call fails (HTTP call fails or an exception is returned). This field was added in v3.5.2.
* '''onDone''' (Function): A function to call when the WS call finishes (either success or fail). This field was added in v3.5.2.

Example usage:
<code php>
<span core-site-plugins-call-ws-on-load name="mod_certificate_view_certificate" [params]="{certificateid: <% certificate.id %>}" [preSets]="{getFromCache: 0, saveToCache: 0}" (onSuccess)="callDone($event)"></span>
</code>
<code javascript>
this.callDone = function(result) {
// Code to run when the WS call is successful.
};
</code>

==Advanced features==

===Display the plugin only if certain conditions are met===

You might want to display your plugin in the mobile app only if certain dynamic conditions are met, so the plugin would be displayed only for some users. This can be achieved using the "init" method (for more info, please see the [[Mobile_support_for_plugins#Initialization|Initialization]] section ahead).

All the init methods are called as soon as your plugin is retrieved. If you don't want your plugin to be displayed for the current user, then you should return an exception in this init method. It's recommended to include a message explaining why the plugin isn't available for the current user, this exception will be logged in the Javascript console.

On the other hand, you might want to display a plugin only for certain courses (''CoreCourseOptionsDelegate'') or only if the user is viewing certain users' profiles (''CoreUserDelegate''). This can be achieved with the init method too.

In the init method you can return a "restrict" property with two fields in it: ''courses'' and ''users''. If you return a list of courses IDs in this restrict property, then your plugin will only be displayed when the user views any of those courses. In the same way, if you return a list of user IDs then your plugin will only be displayed when the user views any of those users' profiles.

===Using “otherdata”===

The values returned by the functions in otherdata are added to a variable so they can be used both in Javascript and in templates. The otherdata returned by a init call is added to a variable named INIT_OTHERDATA, while the otherdata returned by a ''get_content'' WS call is added to a variable named CONTENT_OTHERDATA.

The otherdata returned by a init call will be passed to the JS and template of all the get_content calls in that handler. The otherdata returned by a get_content call will only be passed to the JS and template returned by that get_content call.

This means that, in your Javascript, you can access and use these data like this:
<code php>
this.CONTENT_OTHERDATA.myVar
</code>
And in the template you could use it like this:
<code php>
{{ CONTENT_OTHERDATA.myVar }}
</code>
''myVar'' is the name we put to one of our variables, it can be the name you want. In the example above, this is the otherdata returned by the PHP method:

array('myVar' => 'Initial value')

====Example====

In our plugin we want to display an input text with a certain initial value. When the user clicks a button, we want the value in the input to be sent to a certain WebService. This can be done using otherdata.

We will return the initial value of the input in the otherdata of our PHP method:
<code php>
'otherdata' => array('myVar' => 'My initial value'),
</code>
Then in the template we will use it like this:
<code php>
<ion-item text-wrap>
<ion-label stacked>{{ 'plugin.mod_certificate.textlabel | translate }}</ion-label>
<ion-input type="text" [(ngModel)]="CONTENT_OTHERDATA.myVar"></ion-input>
</ion-item>
<ion-item>
<button ion-button block color="light" core-site-plugins-call-ws name="mod_certificate_my_webservice" [useOtherDataForWS]="['myVar']">
{{ 'plugin.mod_certificate.send | translate }}
</button>
</ion-item>
</code>

In the example above, we are creating an input text and we use ''[(ngModel)]'' to use the value in ''myVar'' as the initial value and to store the changes in the same ''myVar'' variable. This means that the initial value of the input will be “My initial value”, and if the user changes the value of the input these changes will be applied to the ''myVar'' variable. This is called 2-way data binding in Angular.

Then we add a button to send this data to a WS, and for that we use the directive core-site-plugins-call-ws. We use the ''useOtherDataForWS'' attribute to specify which variable from ''otherdata'' we want to send to our WebService. So if the user enters “A new value” in the input and then clicks the button, it will call the WebService ''mod_certificate_my_webservice'' and will send as a param: myVar -> “A new value”.

We can achieve the same result using the ''params'' attribute of the core-site-plugins-call-ws directive instead of using ''useOtherDataForWS'':
<code php>
<button ion-button block color="light" core-site-plugins-call-ws name="mod_certificate_my_webservice" [params]="{myVar: CONTENT_OTHERDATA.myVar}">
{{ 'plugin.mod_certificate.send | translate }}
</button>
</code>
The WebService call will be exactly the same with both buttons.

Please notice that this example could be done without using otherdata too, using the “''form''” input of the ''core-site-plugins-call-ws directive''.

===Running JS code after a content template has loaded===

When you return JavaScript code from a handler function using the 'javascript' array key, this code is executed immediately after the web service call returns, which may be before the returned template has been rendered into the DOM.

If your code needs to run after the DOM has been updated, you can use setTimeout to call it. For example:

<code php>
return [
'template' => [ ... ],
'javascript' => 'setTimeout(function() { console.log("DOM is available now"); });',
'otherdata' => '',
'files' => []
];
</code>

''Note: If you wanted to write a lot of code here, you might be better off putting it in a function defined in the response from an init template, so that it does not get loaded again with each page of content.''

===JS functions visible in the templates===

The app provides some Javascript functions that can be used from the templates to update, refresh or view content. These are the functions:

* '''openContent(title: string, args: any, component?: string, method?: string)''': Open a new page to display some new content. You need to specify the ''title'' of the new page and the ''args'' to send to the method. If ''component'' and ''method'' aren't provided, it will use the same as in the current page.
* '''refreshContent(showSpinner = true)''': Refresh the current content. By default it will display a spinner while refreshing, if you don't want it to be displayed you should pass false as a parameter.
* '''updateContent(args: any, component?: string, method?: string)''': Refresh the current content using different params. You need to specify the ''args'' to send to the method. If ''component'' and ''method'' aren't provided, it will use the same as in the current page.

====Examples====

=====Group selector=====

Imagine we have an activity that uses groups and we want to let the user select which group he wants to see. A possible solution would be to return all the groups in the same template (hidden), and then show the group user selects. However, we can make it more dynamic and return only the group the user is requesting.

To do so, we'll use a drop down to select the group. When the user selects a group using this drop down we'll update the page content to display the new group.

The main difficulty in this is to tell the view which group needs to be selected when the view is loaded. There are 2 ways to do it: using plain HTML or using Angular's ''ngModel''.

======Using plain HTML======

We need to add a "''selected''" attribute to the option that needs to be selected. To do so, we need to pre-caclulate the selected option in the PHP code:

<code php>
$groupid = empty($args->group) ? 0 : $args->group; // By default, group 0.
$groups = groups_get_activity_allowed_groups($cm, $user->id);
// Detect which group is selected.
foreach ($groups as $gid=>$group) {
$group->selected = $gid === $groupid;
}

$data = array(
'cmid' => $cm->id,
'courseid' => $args->courseid,
'groups' => $groups
);

return array(
'templates' => array(
array(
'id' => 'main',
'html' => $OUTPUT->render_from_template('mod_certificate/mobile_view_page', $data),
),
),
);
</code>

In the code above, we're retrieving the groups the user can see and then we're adding a "selected" bool to each one to determine which one needs to be selected in the drop down. Finally, we pass the list of groups to the template.

In the template, we display the drop down like this:

<code php>
<ion-select (ionChange)="updateContent({cmid: <% cmid %>, courseid: <% courseid %>, group: $event})" interface="popover">
<%#groups%>
<ion-option value="<% id %>" <%#selected%>selected<%/selected%> ><% name %></ion-option>
<%/groups%>
</ion-select>
</code>

The ''ionChange'' function will be called everytime the user selects a different group with the drop down. We're using the function ''updateContent'' to update the current view using the new group. ''$event'' is an Angular variable that will have the selected value (in our case, the group ID that was just selected). This is enough to make the group selector work.

======Using ngModel======

ngModel is an Angular directive that allows storing the value of a certain input/select in a Javascript variable, and also the opposite way: tell the input/select which value to set. The main problem is that we cannot initialize a Javascript variable from the template (Angular doesn't have ''ng-init'' like in AngularJS), so we'll use "otherdata".

In the PHP function we'll return the group that needs to be selected in the ''otherdata'' array:

<code php>
$groupid = empty($args->group) ? 0 : $args->group; // By default, group 0.
$groups = groups_get_activity_allowed_groups($cm, $user->id);

...

return array(
'templates' => array(
array(
'id' => 'main',
'html' => $OUTPUT->render_from_template('mod_certificate/mobile_view_page', $data),
),
),
'otherdata' => array(
'group' => $groupid
),
);
</code>

In the example above we don't need to iterate over the groups array like in the plain HTML example. However, now we're returning the groupid in the "otherdata" array. As it's explained in the [[Mobile_support_for_plugins#Using_.E2.80.9Cotherdata.E2.80.9D|Using "otherdata"]] section, this "otherdata" is visible in the templates inside a variable named ''CONTENT_OTHERDATA''. So in the template we'll use this variable like this:

<code php>
<ion-select [(ngModel)]="CONTENT_OTHERDATA.group" (ionChange)="updateContent({cmid: <% cmid %>, courseid: <% courseid %>, group: CONTENT_OTHERDATA.group})" interface="popover">
<%#groups%>
<ion-option value="<% id %>"><% name %></ion-option>
<%/groups%>
</ion-select>
</code>

===Use the rich text editor===

The rich text editor included in the app requires a FormControl to work. You can use the library FormBuilder to create this control (or to create a whole FormGroup if you prefer).

With the following Javascript you'll be able to create a FormControl:

<code javascript>
this.control = this.FormBuilder.control(this.CONTENT_OTHERDATA.rte);
</code>

In the example above we're using a value returned in OTHERDATA as the initial value of the rich text editor, but you can use whatever you want.

Then you need to pass this control to the rich text editor in your template:

<code>
<ion-item>
<core-rich-text-editor item-content [control]="control" placeholder="Enter your text here" name="rte_answer"></core-rich-text-editor>
</ion-item>
</code>

Finally, there are several ways to send the value in the rich text editor to a WebService to save it. This is one of the simplest options:

<code>
<button ion-button block type="submit" core-site-plugins-call-ws name="my_webservice" [params]="{rte: control.value}" ....
</code>

As you can see, we're passing the value of the rich text editor as a parameter to our WebService.

===Initialization===

All handlers can specify a “''init''” method in the mobile.php file. This method is meant to return some JavaScript code that needs to be executed as soon as the plugin is retrieved.

When the app retrieves all the handlers, the first thing it will do is call the ''tool_mobile_get_content'' WebService with the init method. This WS call will only receive the default args.

The app will immediately execute the JavaScript code returned by this WS call. This JavaScript can be used to manually register your handlers in the delegates you want, without having to rely on the default handlers built based on the mobile.php data.

The templates returned by this init method will be added to a INIT_TEMPLATES variable that will be passed to all the Javascript code of that handler. This means that the Javascript returned by the init method or the “main” method can access any of the templates HTML like this:
<code javascript>
this.INIT_TEMPLATES[‘main’];
</code>
In this case, “main” is the ID of the template we want to use.

The same happens with the ''otherdata'' returned by this init method, it is added to a INIT_OTHERDATA variable.

The ''restrict'' field returned by this init call will be used to determine if your handler is enabled or not. For example, if your handler is for the delegate ''CoreCourseOptionsDelegate'' and you return a list of courseids in restrict->courses, then your handler will only be enabled in the courses you returned. This only applies to the “default” handlers, if you register your own handler using the Javascript code then you should check yourself if the handler is enabled.

Finally, if you return an object in this init Javascript code, all the properties of that object will be passed to all the Javascript code of that handler so you can use them when the code is run. For example, if your init Javascript code does something like this:
<code javascript>
var result = {
MyAddonClass: new MyAddonClass()
};
result:
</code>
Then, for the rest of Javascript code of your handler (e.g. for the “main” method) you can use this variable like this:
<code javascript>
this.MyAddonClass
</code>

====Examples====

=====Module link handler=====

A link handler allows you to decide what to do when a link with a certain URL is clicked. This is useful, for example, to open your module when a link to the module is clicked. In this example we’ll create a link handler to detect links to a certificate module using a init JavaScript:
<code javascript>
var that = this;

function AddonModCertificateModuleLinkHandler() {
that.CoreContentLinksModuleIndexHandler.call(this, that.CoreCourseHelperProvider, 'mmaModCertificate', 'certificate');

this.name = "AddonModCertificateLinkHandler";
}

AddonModCertificateModuleLinkHandler.prototype = Object.create(this.CoreContentLinksModuleIndexHandler.prototype);
AddonModCertificateModuleLinkHandler.prototype.constructor = AddonModCertificateModuleLinkHandler;

this.CoreContentLinksDelegate.registerHandler(new AddonModCertificateModuleLinkHandler());
</code>

=====Advanced link handler=====
Link handlers have some advanced features that allow you to change how links behave under different conditions.
======Patterns======
You can define a Regular Expression pattern to match certain links. This will apply the handler only to links that match the pattern.
<code javascript>
function AddonModFooLinkHandler() {
....
this.pattern = RegExp('\/mod\/foo\/specialpage.php');
....
}
</code>
======Priority======
Multiple link handlers may apply to a given link. You can define the order of precedence by setting the priority - the handler with the highest priority will be used.
All default handlers have a priority of 0, so 1 or higher will override the default.
<code javascript>
function AddonModFooLinkHandler() {
....
this.priority = 1;
....
}
</code>
======Multiple actions======
Once a link has been matched, the handler's getActions() method determines what the link should do. This method has access to the URL and its parameters.
Different actions can be returned depending on different conditions.
<code javascript>
AddonModFooLinkHandler.prototype.getActions = function(siteIds, url, params) {
return [{
action: function(siteId, navCtrl) {
// The actual behaviour of the link goes here.
},
sites: [...]
}, {
...
}];
}
</code>
Once handlers have been matched for a link, the actions will be fetched for all the matching handlers, in priorty order. The first "valid" action will be used to open the link.
If your handler is matched with a link, but a condition assessed in the getActions() function means you want to revert to the next highest priorty handler, you can "invalidate"
your action by settings its sites propety to an empty array.
======Complex example======
This will match all URLs containing /mod/foo/, and force those with an id parameter that's not in the "supportedModFoos" array to open in the user's browser, rather than the app.

<code javascript>
var that = this;
var supportedModFoos = [...];
function AddonModFooLinkHandler() {
this.pattern = new RegExp('\/mod\/foo\/');
this.name = "AddonModFooLinkHandler";
this.priority = 1;
}
AddonModFooLinkHandler.prototype = Object.create(that.CoreContentLinksHandlerBase.prototype);
AddonModFooLinkHandler.prototype.constructor = AddonModFooLinkHandler;
AddonModFooLinkHandler.prototype.getActions = function(siteIds, url, params) {
var action = {
action: function() {
that.CoreUtilsProvider.openInBrowser(url);
}
};
if (supportedModFoos.indexOf(parseInt(params.id)) !== -1) {
action.sites = [];
}
return [action];
};
that.CoreContentLinksDelegate.registerHandler(new AddonModFooLinkHandler());
</code>

=====Module prefetch handler=====

The ''CoreCourseModuleDelegate'' handler allows you to define a list of ''offlinefunctions'' to prefetch a module. However, you might want to create your own prefetch handler to determine what needs to be downloaded. For example, you might need to chain WS calls (pass the result of a WS call to the next one), and this cannot be done using ''offlinefunctions''.

Here’s an example on how to create a prefetch handler using init JS:
<code javascript>
var that = this;

// Create a class that "inherits" from CoreCourseActivityPrefetchHandlerBase.
function AddonModCertificateModulePrefetchHandler() {
that.CoreCourseActivityPrefetchHandlerBase.call(this, that.TranslateService, that.CoreAppProvider, that.CoreUtilsProvider,
that.CoreCourseProvider, that.CoreFilepoolProvider, that.CoreSitesProvider, that.CoreDomUtilsProvider);

this.name = "AddonModCertificateModulePrefetchHandler";
this.modName = "certificate";
this.component = "mod_certificate"; // This must match the plugin identifier from db/mobile.php, otherwise the download link in the context menu will not update correctly.
this.updatesNames = /^configuration$|^.*files$/;
}

AddonModCertificateModulePrefetchHandler.prototype = Object.create(this.CoreCourseActivityPrefetchHandlerBase.prototype);
AddonModCertificateModulePrefetchHandler.prototype.constructor = AddonModCertificateModulePrefetchHandler;

// Override the prefetch call.
AddonModCertificateModulePrefetchHandler.prototype.prefetch = function(module, courseId, single, dirPath) {
return this.prefetchPackage(module, courseId, single, prefetchCertificate);
};

function prefetchCertificate(module, courseId, single, siteId) {
// Perform all the WS calls.
// You can access most of the app providers using that.ClassName. E.g. that.CoreWSProvider.call().
}

this.CoreCourseModulePrefetchDelegate.registerHandler(new AddonModCertificateModulePrefetchHandler());
</code>

One relatively simple full example is where you have a function that needs to work offline, but it has an additional argument other than the standard ones. You can imagine for this an activity like the book module, where it has multiple pages for the same cmid. The app will not automatically work with this situation - it will call the offline function with the standard arguments only, so you won't be able to prefetch all the possible parameters.

To deal with this, you need to implement a web service in your Moodle component that returns the list of possible extra arguments, and then you can call this web service and loop around doing the same thing the app does when it prefetches the offline functions. Here is an example from a third-party module (showing only the actual prefetch function - the rest of the code is as above) where there are multiple values of a custom 'section' parameter for the mobile function 'mobile_document_view':

<code javascript>
function prefetchOucontent(module, courseId, single, siteId) {
var component = 'mod_oucontent';

// Get the site, first.
return that.CoreSitesProvider.getSite(siteId).then(function(site) {
// Read the list of pages in this document using a web service.
return site.read('mod_oucontent_get_page_list', {'cmid': module.id}).then(function(response) {
var promises = [];

// For each page, read and process the page - this is a copy of logic in the app at
// siteplugins.ts (prefetchFunctions), but modified to add the custom argument.
for(var i = 0; i < response.length; i++) {
var args = {
courseid: courseId,
cmid: module.id,
userid: site.getUserId()
};
if (response[i] !== '') {
args.section = response[i];
}

promises.push(that.CoreSitePluginsProvider.getContent(
component, 'mobile_document_view', args).then(
function(result) {
var subPromises = [];
if (result.files && result.files.length) {
subPromises.push(that.CoreFilepoolProvider.downloadOrPrefetchFiles(
site.id, result.files, true, false, component, module.id));
}
return Promise.all(subPromises);
}));
}

return Promise.all(promises);
});
});
}
</code>

=====Single activity course format=====

In the following example, the value of INIT_TEMPLATES["main"] is:

<core-dynamic-component [component]="componentClass" [data]="data"></core-dynamic-component>

This template is returned by the init method. And this is the JavaScript code returned by the init method:
<code javascript>
var that = this;

function getAddonSingleActivityFormatComponent() {
function AddonSingleActivityFormatComponent() {
this.data = {};
};
AddonSingleActivityFormatComponent.prototype.constructor = AddonSingleActivityFormatComponent;
AddonSingleActivityFormatComponent.prototype.ngOnChanges = function(changes) {
var self = this;

if (this.course && this.sections && this.sections.length) {
var module = this.sections[0] && this.sections[0].modules && this.sections[0].modules[0];
if (module && !this.componentClass) {
that.CoreCourseModuleDelegate.getMainComponent(that.Injector, this.course, module).then((component) => {
self.componentClass = component || that.CoreCourseUnsupportedModuleComponent;
});
}

this.data.courseId = this.course.id;
this.data.module = module;
}
};
AddonSingleActivityFormatComponent.prototype.doRefresh = function(refresher, done) {
return Promise.resolve(this.dynamicComponent.callComponentFunction("doRefresh", [refresher, done]));
};

return AddonSingleActivityFormatComponent;
};

function AddonSingleActivityFormatHandler() {
this.name = "singleactivity";
};

AddonSingleActivityFormatHandler.prototype.constructor = AddonSingleActivityFormatHandler;

AddonSingleActivityFormatHandler.prototype.isEnabled = function() {
return true;
};

AddonSingleActivityFormatHandler.prototype.canViewAllSections = function(course) {
return false;
};

AddonSingleActivityFormatHandler.prototype.getCourseTitle = function(course, sections) {
if (sections && sections[0] && sections[0].modules && sections[0].modules[0]) {
return sections[0].modules[0].name;
}

return course.fullname || "";
};

AddonSingleActivityFormatHandler.prototype.displayEnableDownload = function(course) {
return false;
};

AddonSingleActivityFormatHandler.prototype.displaySectionSelector = function(course) {
return false;
};

AddonSingleActivityFormatHandler.prototype.getCourseFormatComponent = function(injector, course) {
that.Injector = injector || that.Injector;

return that.CoreCompileProvider.instantiateDynamicComponent(that.INIT_TEMPLATES["main"], getAddonSingleActivityFormatComponent(), injector);
};

this.CoreCourseFormatDelegate.registerHandler(new AddonSingleActivityFormatHandler());
</code>

===Using the JavaScript API===

The Javascript API is partly supported right now, only the delegates specified in the section [[Mobile_support_for_plugins#Templates_downloaded_on_login_and_rendered_using_JS_data_2|Templates downloaded on login and rendered using JS data]] supports it now. This API allows you to override any of the functions of the default handler.

The “method” specified in a handler registered in the ''CoreUserProfileFieldDelegate'' will be called immediately after the init method, and the Javascript returned by this method will be run. If this Javascript code returns an object with certain functions, these function will override the ones in the default handler.

For example, if the Javascript returned by the method returns something like this:

<code javascript>
var result = {
getData: function(field, signup, registerAuth, formValues) {
}
};
result;
</code>

The the ''getData'' function of the default handler will be overridden by the returned getData function.

The default handler for ''CoreUserProfileFieldDelegate'' only has 2 functions: ''getComponent'' and ''getData''. In addition, the JavaScript code can return an extra function named ''componentInit'' that will be executed when the component returned by ''getComponent'' is initialized.

Here’s an example on how to support the text user profile field using this API:

<code javascript>
var that = this;

var result = {
componentInit: function() {
if (this.field && this.edit && this.form) {
this.field.modelName = "profile_field_" + this.field.shortname;

if (this.field.param2) {
this.field.maxlength = parseInt(this.field.param2, 10) || "";
}

this.field.inputType = that.CoreUtilsProvider.isTrueOrOne(this.field.param3) ? "password" : "text";

var formData = {
value: this.field.defaultdata,
disabled: this.disabled
};

this.form.addControl(this.field.modelName, that.FormBuilder.control(formData, this.field.required && !this.field.locked ? that.Validators.required : null));
}
},
getData: function(field, signup, registerAuth, formValues) {
var name = "profile_field_" + field.shortname;

return {
type: "text",
name: name,
value: that.CoreTextUtilsProvider.cleanTags(formValues[name])
};
}
};

result;
</code>

===Translate dynamic strings===

If you wish to have an element that displays a localised string based on value from your template you can doing something like:

<code>
<ion-card>
<ion-card-content translate>
plugin.mod_myactivity.<% status %>
</ion-card-content>
</ion-card>
</code>

This could save you from having to write something like when only one value should be displayed:

<code>
<ion-card>
<ion-card-content>
<%#isedting%>{{ 'plugin.mod_myactivity.editing' | translate }}<%/isediting%>
<%#isopen%>{{ 'plugin.mod_myactivity.open' | translate }}<%/isopen%>
<%#isclosed%>{{ 'plugin.mod_myactivity.closed' | translate }}<%/isclosed%>
</ion-card-content>
</ion-card>
</code>

===Using strings with dates===

If you have a string that you wish to pass a formatted date for example in the Moodle language file you have:

<code php>
$string['strwithdate'] = 'This string includes a date of {$a->date} in the middle of it.';
</code>

You can localise the string correctly in your template using something like the following:

<code>
{{ 'plugin.mod_myactivity.strwithdate' | translate: {$a: { date: <% timestamp %> * 1000 | coreFormatDate: "dffulldate" } } }}
</code>

A Unix timestamp must be multiplied by 1000 as the Mobile App expects millisecond timestamps, where as Unix timestamps are in seconds.

==Troubleshooting==

=== Invalid response received ===

You might receive this error when using the "core-site-plugins-call-ws" directive or similar. By default, the app expects all WebService calls to return an object, if your WebService returns another type (string, bool, ...) then you need to specify it using the preSets attribute of the directive. For example, if your WS returns a boolean value, then you should specify it like this:

[preSets]="{typeExpected: 'boolean'}"

In a similar way, if your WebService returns null you need to tell the app not to expect any result using the preSets:

[preSets]="{responseExpected: false}"

=== Values of ion-radio, ion-checkbox or ion-select aren't sent to my WS ===

Some directives allow you to specify a form id or name to send the data from the form to a certain WS. These directives look for HTML inputs to retrieve the data to send. However, ion-radio, ion-checkbox and ion-select don't use HTML inputs, they simulate them, so the directive isn't going to find their data and so it won't be sent to the WebService.

There are 2 workarounds to fix this problem. It seems that the next major release of Ionic framework does use HTML inputs, so these are temporary solutions.

==== Sending the data manually ====

The first solution is to send the missing params manually using the "''params''" property. We will use ''ngModel'' to store the input value in a variable, and this variable will be passed to the params. Please notice that ''ngModel'' '''requires''' the element to have a name, so if you add ''ngModel'' to a certain element you need to add a name too.

For example, if you have a template like this:

<code javascript>
<ion-list radio-group name="responses">
<ion-item>
<ion-label>First value</ion-label>
<ion-radio value="1"></ion-radio>
</ion-item>
</ion-list>

<button ion-button block type="submit" core-site-plugins-call-ws name="myws" [params]="{id: <% id %>}" form="myform">
{{ 'plugin.mycomponent.save' | translate }}
</button>
</code>

Then you should modify it like this:

<code javascript>
<ion-list radio-group [(ngModel)]="responses">
<ion-item>
<ion-label>First value</ion-label>
<ion-radio value="1"></ion-radio>
</ion-item>
</ion-list>

<button ion-button block type="submit" core-site-plugins-call-ws name="myws" [params]="{id: <% id %>, responses: responses}" form="myform">
{{ 'plugin.mycomponent.save' | translate }}
</button>
</code>

Basically, you need to add ''ngModel'' to the affected element (in this case, the ''radio-group''). You can put whatever name you want as the value, we used "responses". With this, everytime the user selects a radio button the value will be stored in a variable named "responses". Then, in the button we are passing this variable to the params of the WebService.

Please notice that the "form" attribute has priority over "params", so if you have an input with name="responses" it will override what you're manually passing to params.

==== Using a hidden input ====

Since the directive is looking for HTML inputs, you need to add one with the value to send to the server. You can use ''ngModel'' to synchronize your ion-radio/ion-checkbox/ion-select with the new hidden input. Please notice that ''ngModel'' '''requires''' the element to have a name, so if you add ''ngModel'' to a certain element you need to add a name too.

For example, if you have a radio button like this:

<code javascript>
<div radio-group name="responses">
<ion-item>
<ion-label>First value</ion-label>
<ion-radio value="1"></ion-radio>
</ion-item>
</div>
</code>

Then you should modify it like this:

<code javascript>
<div radio-group name="responses" [(ngModel)]="responses">
<ion-item>
<ion-label>First value</ion-label>
<ion-radio value="1"></ion-radio>
</ion-item>

<ion-input type="hidden" [ngModel]="responses" name="responses"></ion-input>
</div>
</code>

In the example above, we're using a variable named "responses" to synchronize the data between the ''radio-group'' and the hidden input. You can use whatever name you want.

=== I can't return an object or array in otherdata ===

If you try to return an object or an array in any field inside ''otherdata'', the WebService call will fail with the following error:

''Scalar type expected, array or object received''

Each field in ''otherdata'' must be a string, number or boolean, it cannot be an object or array. To make it work, you need to encode your object or array into a JSON string:

<code php>
'otherdata' => array('data' => json_encode($data))</code>

The app will automatically parse this JSON and convert it back into an array or object.

==Examples==

===Accepting dynamic names in a WebService===

We want to display a form where the names of the fields are dynamic, like it happens in quiz. This data will be sent to a new WebService that we have created.

The first issue we find is that the WebService needs to define the names of the parameters received, but in this case they're dynamic. The solution is to accept an array of objects with name and value. So in the ''_parameters()'' function of our new WebService, we will add this parameter:

<code php>
'data' => new external_multiple_structure(
new external_single_structure(
array(
'name' => new external_value(PARAM_RAW, 'data name'),
'value' => new external_value(PARAM_RAW, 'data value'),
)
),
'The data to be saved', VALUE_DEFAULT, array()
)</code>

Now we need to adapt our form to send the data as the WebService requires it. In our template, we have a button with the directive ''core-site-plugins-call-ws'' that will send the form data to our WebService. To make this work we will have to pass the parameters manually, without using the "''form''" attribute, because we need to format the data before it is sent.

Since we will send the params manually and we want it all to be sent in the same array, we will use ''ngModel'' to store the input data into a variable that we'll call "data", but you can use the name you want. This "data" will be an object that will hold the input data with the format "name->value". For example, if I have an input with name "a1" and value "My answer", the data object will be:

{a1: "My answer"}

So we need to add ''ngModel'' to all the inputs whose values need to be sent to the "data" WS param. Please notice that ''ngModel'' '''requires''' the element to have a name, so if you add ''ngModel'' to a certain element you need to add a name too. For example:

<code javascript><ion-input name="<% name %>" [(ngModel)]="CONTENT_OTHERDATA.data['<% name %>']"></code>

As you can see, we're using ''CONTENT_OTHERDATA'' to store the data. We do it like this because we'll use ''otherdata'' to initialize the form, setting the values the user has already stored. If you don't need to initialize the form, then you can use the variable "dataObject", an empty object that the Mobile app creates for you: [(ngModel)]="dataObject['<% name %>']"

The Mobile app has a function that allows you to convert this data object into an array like the one the WS expects: ''objectToArrayOfObjects''. So in our button we'll use this function to format the data before it's sent:

<code javascript>
<button ion-button block type="submit" core-site-plugins-call-ws name="my_ws_name"
[params]="{id: <% id %>, data: CoreUtilsProvider.objectToArrayOfObjects(CONTENT_OTHERDATA.data, 'name', 'value')}"
successMessage
refreshOnSuccess="true">
</code>

As you can see in the example above, we're specifying that the keys of the "data" object need to be stored in a property named "name", and the values need to be stored in a property named "value". If your WebService expects different names you need to change the parameters of the function ''objectToArrayOfObjects''.

If you open your plugin now in the Mobile app it will display an error in the Javascript console. The reason is that the variable "data" doesn't exist inside ''CONTENT_OTHERDATA''. As it is explained in previous sections, ''CONTENT_OTHERDATA'' holds the data that you return in ''otherdata'' for your method. We'll use ''otherdata'' to initialize the values to be displayed in the form.

If the user hasn't answered the form yet, we can initialize the "data" object as an empty object. Please remember that we cannot return arrays or objects in ''otherdata'', so we'll return a JSON string.

<code php>
'otherdata' => array('data' => '{}')</code>

With the code above, the form will always be empty when the user opens it. But now we want to check if the user has already answered the form and fill the form with the previous values. We will do it like this:

<code php>
$userdata = get_user_responses(); // It will held the data in a format name->value. Example: array('a1' => 'My value').
...
'otherdata' => array('data' => json_encode($userdata))
</code>

Now the user will be able to see previous values when the form is opened, and clicking the button will send the data to our WebService in array format.

==Moodle plugins with mobile support==

* Group choice: [https://moodle.org/plugins/mod_choicegroup Moodle plugins directory entry] and [https://github.com/ndunand/moodle-mod_choicegroup code in github].
* Custom certificate: [https://moodle.org/plugins/mod_customcert Moodle plugins directory entry] and [https://github.com/markn86/moodle-mod_customcert code in github].
* Gapfill question type: [https://moodle.org/plugins/qtype_gapfill Moodle plugins directory entry] and [https://github.com/marcusgreen/moodle-qtype_gapfill in github].
* Wordselect question type: [https://moodle.org/plugins/qtype_wordselect Moodle plugins directory entry] and [https://github.com/marcusgreen/moodle-qtype_wordselect in github].
* RegExp question type: [https://moodle.org/plugins/qtype_regexp Moodle plugins directory entry] and [https://github.com/rezeau/moodle-qtype_regexp in github].
* Certificate: [https://moodle.org/plugins/mod_certificate Moodle plugins directory entry] and [https://github.com/markn86/moodle-mod_certificate in github].
* Attendance [https://moodle.org/plugins/mod_attendance Moodle plugins directory entry] and [https://github.com/danmarsden/moodle-mod_attendance in github].

See the complete list in the plugins database [https://moodle.org/plugins/browse.php?list=award&id=6 here] (it may contain some outdated plugins)
[[Category:Mobile]]

customscripts

2019-03-13T09:56:05Z

Fox: Typos and updating links

==Custom Scripts Mechanism==

Any scripts that are called directly via a url (eg index.php, user/view.php) can now be customised
by placing a file with the same name (including directories) in my_moodle_data_dir/customscripts
For example:
my_moodle_data_dir/customscripts/index.php; my_moodle_data_dir/customscripts/user/view.php

* this is for people making short term changes to VISIBLE web pages in the moodle source code
** need to check relative links ; for example: never require ../config.php
** cannot add new files to customscripts folder because they are not accessible directly via web.
** better to use cvs or cogito for long term management of customisations to Moodle code

* it seems to have been used extensively only by the [[Moodle 2 for mobile|Moodle for Mobiles]] project

* to enable Custom Scripts, add $CFG->customscripts=path/to/customscript/folder (see [[:en:Configuration_file|Configuration file]])

==Things to keep in mind when using customscripts==

* customscripts hook the derivated script from the near end of the setup.php script. This means that the config.php file has already been included by the caller and should
not be called again.
* You cannot override an internal script (MOODLE_INTERNAL) of Moodle, you can only customscript an 'entry' page. If the change you need is deeper in an internal library, you need to override the entry page, and probably all the required path from the entry point down to the function you want to change the behaviour.
* The original script might have pre-required some libraries, or defined some early function or defines that are active before the hooks is invoked, such definitions should not be required or defined again in the customscript.
* When a customscript returns, it gives control back to the setup.php script that will continue executing the original php page.Thus if a customscript replaces the original script, it should end with an exit statement.

==Caveat of customscripting==

Customscripting is efficient to locally hack a behaviour that is not easy to override using class factories provided by the core architecture or renderer overloading, but your site will run using a
copy of the core code that WILL NOT integrate the code updates when you upgrade Moodle to a higher version. So customscripting might be your last choice to get a feature change in Moodle after all
other techniques have been examinated :

* relocate the feature in a plugin
* override core code with proposed factories and overloading mechanisms
* finding a way to get the feature in another way (using other plugins, other method)

==References==
* http://moodle.org/mod/forum/discuss.php?d=31895
* https://tracker.moodle.org/issues/?jql=text%20~%20%22customscripts%22

Creating a theme based on classic

2019-03-06T08:15:39Z

Fox: Docs for Moodle 3.7 and small improvments

{{Moodle 3.7}}
{{Template:Themes}}

This is a tutorial for how to create a new theme based on the Classic theme.

Moodle 3.7 includes a new core theme named "Classic" which is a starting point for themers wanting to build Moodle theme using a 3 column layout without the Boost navdrawer and settings menus.

== Getting started ==
What is a theme? A theme in Moodle is just another type of plugin that can be developed. Themes are responsible for setting up the structure of each page and have the ability to customise the output of any page in Moodle.

This tutorial is based on the tutorial https://docs.moodle.org/dev/Creating_a_theme_based_on_boost. You can download it or view the source code for it here: https://github.com/bmbrands/moodle-theme_picture

=== Choosing a name ===
Your new theme will need a name. Try and think of something short and memorable - and make sure it is not a name that has already been used by someone else. A quick search on the [https://moodle.org/plugins moodle.org/plugins] can save you a lot of work renaming things later.

Let's call our new example theme "picture" as we will add some settings to allow "pictures" in various places in Moodle.

=== Starting files ===
As a plugin, themes must start with the basic structure of a plugin in Moodle. See https://docs.moodle.org/dev/Tutorial#The_skeleton_of_your_plugin for an overview of the files common to all plugins in Moodle.

Following this guide you can start creating your own theme. First, we create the folder for the new theme under under "/theme/" folder in the Moodle root directory.

<code>
/theme/picture/
</code>

Now we need to add some standard plugin files to our theme. First is version.php

''/theme/picture/version.php''

<code php>
<?php
// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// This is the version of the plugin.
$plugin->version = 2019030400;

// This is the version of Moodle this plugin requires.
$plugin->requires = 2018051700;

// This is the component name of the plugin - it always starts with 'theme_'
// for themes and should be the same as the name of the folder.
$plugin->component = 'theme_picture';

// This is a list of plugins, this plugin depends on (and their versions).
$plugin->dependencies = [
'theme_classic' => 2018120700
];

// This is a stable release.
$plugin->maturity = MATURITY_STABLE;

// This is the named version.
$plugin->release = 1.0;
</code>

We also need a language file so that all our strings can be translated into different languages. The name of this file is the component name of our plugin and it sits in the lang/en/ folder for our plugin. We can include translations of our plugin, but we can also provide translations via the https://lang.moodle.org/ website once our plugin has been published to the plugins database at http://www.moodle.org/plugins/.

''/theme/picture/lang/en/theme_picture.php''

<code php>

<?php
// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// A description shown in the admin theme selector.
$string['choosereadme'] = 'Theme picture is a child theme of the Classic. It adds the ability to upload background photos.';
// The name of our plugin.
$string['pluginname'] = 'Picture';
// We need to include a lang string for each block region.
$string['region-side-pre'] = 'Left';
$string['region-side-post'] = 'Right';
</code>

=== Theme specific files ===
Theme plugins have a few more standard files they need to define.

Themes require a favicon file to show in the address bar. See [[http://docs.moodle.org/en/Favicon Favicon]].

''pix/favicon.ico''

(Image file not shown).

Themes also require an example screenshot to be displayed in the theme selector.

''pix/screenshot.jpg''

(Image file not shown).

Themes require a lib.php file. This file contains callbacks used by various API's in Moodle. Initially this file can be empty, but as we add features to our theme we will need to add some functions here.

''lib.php''
<code php>
<?php

// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// We will add callbacks here as we add features to our theme.
</code>

Theme config goes in a config.php file. This is one of the most important files in our theme. Once we add this file we will be ready to test our theme for the first time.

''config.php''

<code php>
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

/**
* Picture config.
*
* @package theme_picture
* @copyright 2016 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// $THEME is defined before this page is included and we can define settings by adding properties to this global object.

// The first setting we need is the name of the theme. This should be the last part of the component name, and the same
// as the directory name for our theme.
$THEME->name = 'picture';

// This setting list the style sheets we want to include in our theme. Because we want to use SCSS instead of CSS - we won't
// list any style sheets. If we did we would list the name of a file in the /styles/ folder for our theme without any css file
// extensions.
$THEME->sheets = [];

// This is a setting that can be used to provide some styling to the content in the TinyMCE text editor. This is no longer the
// default text editor and "Atto" does not need this setting so we won't provide anything. If we did it would work the same
// as the previous setting - listing a file in the /styles/ folder.
$THEME->editor_sheets = [];

// This is a critical setting. We want to inherit from theme_classic because it provides a great starting point for SCSS bootstrap4
// themes. We have added add more than one parent here to inherit from multiple parents, and if we did they would be processed in
// order of importance (later themes overriding earlier ones). Things we will inherit from the parent theme include
// styles and mustache templates and some (not all) settings.
$THEME->parents = ['boost', 'classic'];

// A dock is a way to take blocks out of the page and put them in a persistent floating area on the side of the page.
// does not support a dock so we won't either - but look at bootstrapbase for an example of a theme with a dock.
$THEME->enable_dock = false;

// This is an old setting used to load specific CSS for some YUI JS. We don't need it in Classic based themes because Classic
// provides default styling for the YUI modules that we use. It is not recommended to use this setting anymore.
$THEME->yuicssmodules = array();

// Most themes will use this rendererfactory as this is the one that allows the theme to override any other renderer.
$THEME->rendererfactory = 'theme_overridden_renderer_factory';

$THEME->prescsscallback = 'theme_picture_get_pre_scss';

// Since we are using 2 parent themes the correct location of the layout files needs to be defined. For this theme we need the multiple
// column layouts.
$THEME->layouts = [
// Most backwards compatible layout without the blocks - this is the layout used by default.
'base' => array(
'theme' => 'classic',
'file' => 'columns.php',
'regions' => array(),
),
// Standard layout with blocks, this is recommended for most pages with general information.
'standard' => array(
'theme' => 'classic',
'file' => 'columns.php',
'regions' => array('side-pre', 'side-post'),
'defaultregion' => 'side-pre',
),
// Main course page.
'course' => array(
'theme' => 'classic',
'file' => 'columns.php',
'regions' => array('side-pre', 'side-post'),
'defaultregion' => 'side-pre',
'options' => array('langmenu' => true),
),
'coursecategory' => array(
'theme' => 'classic',
'file' => 'columns.php',
'regions' => array('side-pre'),
'defaultregion' => 'side-pre',
),
// Part of course, typical for modules - default page layout if $cm specified in require_login().
'incourse' => array(
'theme' => 'classic',
'file' => 'columns.php',
'regions' => array('side-pre'),
'defaultregion' => 'side-pre',
),
// The site home page.
'frontpage' => array(
'theme' => 'classic',
'file' => 'columns.php',
'regions' => array('side-pre', 'side-post'),
'defaultregion' => 'side-pre',
'options' => array('nofullheader' => true),
),
// Server administration scripts.
'admin' => array(
'theme' => 'classic',
'file' => 'columns.php',
'regions' => array('side-pre'),
'defaultregion' => 'side-pre',
),
// My dashboard page.
'mydashboard' => array(
'theme' => 'classic',
'file' => 'columns.php',
'regions' => array('side-pre', 'side-post'),
'defaultregion' => 'side-pre',
'options' => array('nonavbar' => true, 'langmenu' => true, 'nocontextheader' => true),
),
// My public page.
'mypublic' => array(
'theme' => 'classic',
'file' => 'columns.php',
'regions' => array('side-pre'),
'defaultregion' => 'side-pre',
),
'login' => array(
'theme' => 'boost',
'file' => 'login.php',
'regions' => array(),
'options' => array('langmenu' => true),
),

// Pages that appear in pop-up windows - no navigation, no blocks, no header.
'popup' => array(
'theme' => 'classic',
'file' => 'contentonly.php',
'regions' => array(),
'options' => array('nofooter' => true, 'nonavbar' => true),
),
// No blocks and minimal footer - used for legacy frame layouts only!
'frametop' => array(
'theme' => 'classic',
'file' => 'contentonly.php',
'regions' => array(),
'options' => array('nofooter' => true, 'nocoursefooter' => true),
),
// Embeded pages, like iframe/object embeded in moodleform - it needs as much space as possible.
'embedded' => array(
'theme' => 'classic',
'file' => 'embedded.php',
'regions' => array()
),
// Used during upgrade and install, and for the 'This site is undergoing maintenance' message.
// This must not have any blocks, links, or API calls that would lead to database or cache interaction.
// Please be extremely careful if you are modifying this layout.
'maintenance' => array(
'theme' => 'classic',
'file' => 'maintenance.php',
'regions' => array(),
),
// Should display the content and basic headers only.
'print' => array(
'theme' => 'classic',
'file' => 'contentonly.php',
'regions' => array(),
'options' => array('nofooter' => true, 'nonavbar' => false),
),
// The pagelayout used when a redirection is occuring.
'redirect' => array(
'file' => 'embedded.php',
'regions' => array(),
),
// The pagelayout used for reports.
'report' => array(
'theme' => 'classic',
'file' => 'columns.php',
'regions' => array('side-pre'),
'defaultregion' => 'side-pre',
),
// The pagelayout used for safebrowser and securewindow.
'secure' => array(
'theme' => 'classic',
'file' => 'secure.php',
'regions' => array('side-pre'),
'defaultregion' => 'side-pre'
)
];
</code>

=== Ready set go! ===
If you have been following along - now we are at the point where we can actually install and test our new theme. Try it now by visiting the admin notifications page to install the new plugin, and then choosing the new theme from the theme selector.

[[https://docs.moodle.org/en/Standard_themes#Theme_selector Theme selector]]

When you choose the new theme - you will find that it looks exactly the same as Classic. At this point with our minimal configuration - we are inheriting almost everything from our parent theme including styles and templates. You will notice though that we don't inherit the settings from our parent theme.

=== Setup your Sass files ===
Once you have a theme that has been installed into your Moodle setup it is time to start styling it. The core Boostrap scss is very well suited for customization using Sass variables and overriding component. On [https://getbootstrap.com/docs/4.3/getting-started/theming/#variable-defaults Get bootstrap.com] there is some documentation on Sass variables and in theme/boost/scss/boostrap/_variables.scss you will see the full list of variables that can be changed.

Before we start the theme needs to be able to return the complete set of Sass files that are required for Moodle and our custom Sass. So as a start we will be editing the config again:

''theme/picture/config.php''
<code php>
// This is the function that returns the SCSS source for the main file in our theme.
$THEME->scss = function($theme) {
return theme_picture_get_main_scss_content($theme);
};
</code>

The variable $THEME->scss is configured to be a callback function that when called returns all the Scss source files from our parent theme and the picture theme. Once the callback function is defined our Theme's lib.php needs to contain the callback function.

''theme/picture/lib.php''
<code php>
/**
* Returns the main SCSS content.
*
* @param theme_config $theme The theme config object.
* @return string All fixed Sass for this theme.
*/
function theme_picture_get_main_scss_content($theme) {
global $CFG;

$scss = '';

$fs = get_file_storage();

// Main CSS - Get the CSS from theme Classic.
$scss .= file_get_contents($CFG->dirroot . '/theme/classic/scss/classic/pre.scss');
$scss .= file_get_contents($CFG->dirroot . '/theme/classic/scss/preset/default.scss');
$scss .= file_get_contents($CFG->dirroot . '/theme/classic/scss/classic/post.scss');

// Pre CSS - this is loaded AFTER any prescss from the setting but before the main scss.
$pre = file_get_contents($CFG->dirroot . '/theme/picture/scss/pre.scss');

// Post CSS - this is loaded AFTER the main scss but before the extra scss from the setting.
$post = file_get_contents($CFG->dirroot . '/theme/picture/scss/post.scss');

// Combine them together.
return $pre . "\n" . $scss . "\n" . $post;
}
</code>

The function theme_picture_get_main_scss_content uses the scss files from classic, the default.scss file from classic contains @import statements to include the files from theme Boost so we can be sure we have all the css we need.

''theme/classic/scss/preset/default.scss''
<code css>
// Import FontAwesome.
@import "fontawesome";

// Import All of Bootstrap
@import "bootstrap";

// Import Core moodle CSS
@import "moodle";
</code>

To complete the setup all we need to do is create the pre.scss and post.scss files that will contain our Sass variables and other Css. The pre.scss file is the file that needs to be loaded first before the files from theme classic are imported. It will contain the variable we configure for things like fonts, colours and spacing. The post.scss file will contain all other custom css.

''theme/picture/scss/pre.scss''
<code css>
// We need larger buttons.
$btn-padding-y: 0.5rem !default;
$btn-padding-x: 1.1rem !default;
</code>

''theme/picture/scss/post.scss''
<code css>
// We like our buttons very round.
.btn {
border-radius: 1.078em;
font-family: $font-family-sans-serif;
font-size: 0.875em;
}
</code>

You might have noticed the "!default" statement after the variables in our pre.scss file. This means the variable is set if the variable has not been defined before. When inspecting the Bootstrap variables defined in theme/boost/scss/bootstrap/_variables.scss you will see all variable have a "!default" statement meaning we can change any variable!

With the preset files in place we can select our theme from the available installed themes (If you did not do that already) and purge changes. You should be able to see the Classic 3 column layout and our round buttons.

=== Adding custom settings to our theme ===

That's it for this tutorial, but there are [[:Category:Themes| more Themes docs]] to browse.

[[Category:Themes]]

Template:Moodle 3.7

2019-03-06T08:11:04Z

Fox: Create template

<span class="small-info-right">Moodle <span class="text-big new">3.7</span></span>
<includeonly>[[Category:Moodle 3.7]]</includeonly>
<noinclude>This template will categorise articles that include it into [[:Category:Moodle 3.7]].</noinclude>

Category:Moodle 3.7

2019-03-06T08:10:33Z

Fox: Create category

Pages that relate to the planning and development of Moodle 3.7 features.

Moving your theme to use boost as a parent theme

2019-03-05T15:08:20Z

Fox: /* Upgrading a theme to use Boost as a parent theme. */ Typo

{{Moodle 3.6}}
{{Template:Themes}}

== Key differences ==

=== Bootstrap version differences ===

The biggest difference between themes Bootstrapbase and Boost are the included [http://getbootstrap.com Bootstrap] libraries. Bootstrapbase uses Bootstrap version 2.3.3, Boost uses Bootstrap version 4.0.0 (at the time of writing this document).

=== CSS extension language differences ===

[http://lesscss.org/ LESS css] is used in Bootstrapbase, Boost uses [https://sass-lang.com/ Sass CSS].

LESS uses a different css syntax than Sass. The most obvious difference is the way variables are defined; LESS uses @, Sass uses $. There are many other differences between LESS and Sass; [https://css-tricks.com/sass-vs-less/ css-tricks] has more information on these differences. The npm package [https://www.npmjs.com/package/less2sass less2sass] can be helpful when migrating your less files.

LESS css is compiled using a core [https://docs.moodle.org/dev/Grunt grunt] task and stored in theme/bootstrapbase/style/moodle.css. Child themes need to specify additional stylesheets using the
<code php>
$THEME->sheets = []
</code>
array or use
<code php>
$THEME->lessfile = ''
</code>
to use the core [https://github.com/oyejorge/LESS.php LESScss] library

Sass css is compiled using a core [http://leafo.github.io/scssphp scssphp] Library for theme Boost and child themes if
<code php>
$THEME->scss = ''
</code>
is used. The compiled css file served to the end user is stored in a Moodle cache and is regenerated each time theme caches are cleared. Using the core scssphp compiler allows for the usage of [https://docs.moodle.org/dev/Boost_Presets Boost Presets]. For information on advanced usage of Sass css see the [https://docs.moodle.org/dev/SCSS SCSS] doc page.

=== Moodle templates differences ===

Theme Boost uses [https://docs.moodle.org/dev/Templates Templates] to render the main layouts. For each of the layout files in theme/boost/layouts/ there is a corresponding layout file in theme/boost/templates.

The layout files found in theme Bootstrapbase are a combination of php and html.

=== Renderers differences ===

In theme Boost all overridden renderers can be found theme/boost/classes/output, in theme Bootstrapbase the overridden renderers are called in /theme/bootstrapbase/renderers.php.

=== Theme config differences ===

The theme configuration for Boost based themes do not differ much from Bootstrapbase based themes. For a full list of option is available in the [https://docs.moodle.org/dev/Themes_overview#Appendix_A Themes Overview] doc page.

These configuration options only apply to theme Bootstrapbase and child themes:

<code php>
$THEME->lessfile = 'moodle';
$THEME->lessvariablescallback = 'theme_more_less_variables';
$THEME->extralesscallback = 'theme_more_extra_less';
$THEME->doctype = 'html5';
</code>

These configuration options only apply to theme Boost and child themes:

<code php>
$THEME->scss = function($theme) {
return theme_boost_get_main_scss_content($theme);
};
$THEME->extrascsscallback = 'theme_boost_get_extra_scss';
$THEME->prescsscallback = 'theme_boost_get_pre_scss';
$THEME->precompiledcsscallback = 'theme_boost_get_precompiled_css';
$THEME->addblockposition = BLOCK_ADDBLOCK_POSITION_FLATNAV;
</code>

== Upgrading a theme to use Boost as a parent theme. ==

There is no fit-for-all tutorial on upgrading your theme since themes can have lots of custom features. The steps specified here are the steps that were taken upgrading the community theme [https://moodle.org/plugins/theme_elegance Elegance] to use theme Boost as its parent and serve as an example.

=== Update the theme config ===

Most of the config file can remain the same. References to less files need to be removed, the theme scss content needs to be specified using a callback.

<code php>
$THEME->scss = function($theme) {
return theme_elegance_get_main_scss_content($theme);
};
</code>
''code snippet from theme/elegance/config.php''

In this example the theme was specialised in rendering custom widgets on the front page, so we only need to specify a different layout file for the front page.

<code php>
$THEME->layouts['frontpage'] = [
'file' => 'frontpage.php',
'regions' => ['side-pre'],
'defaultregion' => 'side-pre',
'options' => ['nonavbar'],
];
</code>
''code snippet from theme/elegance/config.php''

=== Update the theme lib file ===

Add the get_main_scss_content callback function to your theme lib file.

The callback function will need to fetch the Sass files from your parent theme. Use this example when basing your theme of Boost

<code php>
/**
* Returns the main SCSS content.
*
* @param theme_config $theme The theme config object.
* @return string
*/
function theme_elegance_get_main_scss_content($theme) {
global $CFG;

$scss = file_get_contents($CFG->dirroot . '/theme/elegance/scss/variables.scss');
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/fontawesome.scss');
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/bootstrap.scss');
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/moodle.scss');
$scss .= file_get_contents($CFG->dirroot . '/theme/elegance/scss/post.scss');

return $scss;
}
</code>
''code snippet from theme/elegance/lib.php''

Make sure your create these files when using the example above:

* theme/elegance/scss/variables.scss
* theme/elegance/scss/post.scss

=== Create your template and layout files ===

If your theme contains custom layouts it will need a template for each layout.

For theme elegance these layout files and templates were copied

<code>
cp theme/boost/layout/columns2.php theme/elegance/layout/frontpage.php
cp theme/boost/templates/columns2.mustache theme/elegance/templates/layout_frontpage.mustache
</code>

in the new frontpage.php the reference to the template needs updating after copying these:

<code php>
echo $OUTPUT->render_from_template('theme_elegance/layout_frontpage', $templatecontext);
</code>
''code snippet from theme/elegance/layout/frontpage.php''

Now the layout file and the template file are in place custom widget / renderers can be added for the front page.

For theme elegance a carousel slideshow can be configured through the theme settings. The renderer for this carousel is called in theme/elegance/layout/frontpage.php:

<code php>
$renderer = $PAGE->get_renderer('theme_elegance');
$carousel = new \theme_elegance\output\carousel();
$widgets = (object) [
'carousel' => $renderer->render($carousel)
];

$templatecontext = [
..
'widgets' => $widgets,
..
];
</code>
''code snippet from theme/elegance/layout/frontpage.php''

The carousel widget is passed on to the theme/elegance/template/layout_frontpage.mustache template

=== Migrating your LESS files ===

The Bootstrapbase theme css is written in the [http://lesscss.org/ LESS css extention language]. Some child themes of bootstrapbase use LESS to generate their stylesheets. Usually these files are stored in the less/ folder of the child theme.

The Boost theme css is written in the [https://sass-lang.com/ Sass css extention language]. A child theme can extend the Boost Sass files which are usually found in the sass/ folder of the child theme.

The LESS and Sass extention languages are different and not compatible, themes using less will have to migrate their stylesheets. This can be done manually or with the [https://www.npmjs.com/package/less2sass less2sass] tool to translate LESS files into Sass. This tool is a great start when migrating your LESS however, after running less2sass to migrate your stylesheets you will need to inspect them and fix them if needed.

<code css>
/* Icon styles */
// Size of big icons.
@icon-big-width: 64px;
@icon-big-height: 64px;

img.icon {
&.iconsize-big {
width: @icon-big-width;
height: @icon-big-height;
}
}

.groupinfobox {
.well;

}
</code>
''example less from theme/bootstrapbase/less/moodle/core.less''

<code css>
// Size of big icons.
$icon-big-width: 64px;
$icon-big-height: 64px;
.icon {
&.iconsize-big {
width: $icon-big-width;
height: $icon-big-height;
}
}
.groupinfobox {
@extend .card;
}
</code>
''example sass from theme/boost/scss/moodle_core.scss''

The [https://sass-lang.com/ Sass CSS] extension language is not that hard to learn. Make sure you have read [https://sass-lang.com/guide The Sass Basics] and understand how to define and override variables and use mixins.

When you start migrating your LESS file a good starting point is your theme variables.less. Usually child themes define a number of new variables and override some of the variables defined in theme/bootstrapbase/less/bootstrap/variables.less.
Your new variables will probably be okay when migrating to SASS. The overridden bootstrap variables will no longer be valid. So for each overridden variable try to find the new variables name in theme/boost/sass/bootstrap/_variables.scss.

<code css>
// Scaffolding
// -------------------------
@bodyBackground: @white;
@textColor: @grayDark;

// Links
// -------------------------
@linkColor: #08c;
@linkColorHover: darken(@linkColor, 15%);
</code>
''example variables from theme/bootstrapbase/less/bootstrap/variables.less''

<code css>
// Body
//
// Settings for the `<body>` element.

$body-bg: $white !default;
$body-color: $gray-900 !default;

// Links
//
// Style anchor elements.

$link-color: theme-color("primary") !default;
$link-decoration: none !default;
$link-hover-color: darken($link-color, 15%) !default;
$link-hover-decoration: underline !default;
</code>
''example variables form theme/boost/sass/bootstrap/_variables.scss''

=== Using grunt to debug Sass compile issues ===

When you start creating your new Sass files debugging what happens in the Moodle core PHP Sass compiler can take a lot of time. The compiler is run using a caching mechanism and error reporting is poor, when a variable is misspelled the errors are send to your webserver logfiles.

To speed up development The [http://gruntjs.com/ Grunt] Javascript taskrunner that runs on [https://nodejs.org/en/ Node.js] can be very helpful. If you have not tried to get Grunt running for Moodle core tasks make sure you read the [https://docs.moodle.org/dev/Grunt Moodle Grunt] docs page for more info.

You can use Grunt to compile your Sass and check your Sass syntaxs. Once you have Grunt and Node.js up and running you can create your own Gruntfile.js and package.json file.

For theme Elegance these files are found in [https://github.com/bmbrands/moodle-theme_elegance/blob/MOODLE_36_STABLE/Gruntfile.js theme/elegance/Gruntfile.js] and [https://github.com/bmbrands/moodle-theme_elegance/blob/MOODLE_36_STABLE/postcss.js theme/elegance/package.json].

You can copy these into your theme folder and run the Node installer to retreive all Node dependancies.

<code bash>
> nmp install
</code>

Make sure you update the Gruntfile.js to reflect your configuration:

<code javascript>
sass: {
options: {
style: 'expanded'
},
dist: {
files: {
'style/elegance.css': 'scss/gruntcompile.scss'
}
}
},
</code>
''section of the Grunfile.js you will need to change''

Once all dependancies are installed you can run Grunt to watch your Sass files. Each time you make a change in any of the files the the Node compiler will run and create a new stylesheet in your theme's style/ folder

This stylesheet will not be served to the end user unless you change your theme configuration:

<code php>
$THEME->sheets = ['elegance'];

// Commented out to prevent PHP Sass compiling.
//$THEME->scss = function($theme) {
// return theme_elegance_get_main_scss_content($theme);
//};
</code>
''section of theme/elegance/config.php''

=== Migrating your renderer files ===

In Bootstrapbase the overriden renderers were located in theme/boost/renderers/. These renderes are stored in classes/output in the Boost.

In theme Boost the overridden core renderer is located in theme/boost/classes/output/core_renderer.php. If your theme overrides the core renderer (/lib/outputrenderers.php) make sure you override the Boost renderer (In Moodle version 3.6 and below).

<code php>
<?php
// This file is part of the elegance theme for Moodle
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

namespace theme_elegance\output;

use \theme_boost\output\core_renderer as boost_core_renderer;
use stdClass;
use theme_config;

defined('MOODLE_INTERNAL') || die;

/**
* Renderers to align Moodle's HTML with that expected by Bootstrap
*
* @package theme_elegance
* @copyright 2019 Bas Brands
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

class core_renderer extends boost_core_renderer {
/**
* Returns the title to use on the page.
*
* @since Moodle 2.5.1 2.6
* @return string
*/
public function page_title() {
...
}
}
</code>

Move your custom renderers or other overridden renderes to your themes classes/output folder too.

[[Category:Themes]]

Releases

2018-12-10T13:30:21Z

Fox: /* General release calendar */

This page lists all official releases of Moodle, grouped by branch in reverse chronological order.

==Version support==

From Moodle 2.6 onwards, the end of support, both general and security, happens the second Monday of May and November, observing the 12, 18... month periods, no matter if the major release was delayed or not.

The most recent [https://en.wikipedia.org/wiki/Long-term_support long-term support release (LTS)] version is Moodle 3.5.

[[Image:releasescurrent.png]]

==General release calendar==

These are the target dates for releases. These dates may vary slightly due to unforeseen circumstances.

{| class="nicetable"
|-
! Release type
! Frequency
! Months
|-
| [[Process#Major_release_cycles|Major]] (eg. 3.x)
| 6 monthly
| Second Monday of May and November
|-
| [[Process#Stable_maintenance_cycles|Minor]] (Point) (eg. 3.x.y)
| 2 monthly
| Second Monday of July, September, November, January, March and May
|}

All releases are preceded by a one week warning. Upcoming release dates can be found in the [https://www.google.com/calendar/ical/moodle.com_p4c2oe7hsb77ltaro5qtihb5d4%40group.calendar.google.com/public/basic.ics Moodle development calendar] (Note, this is an iCAL link that will try to add the dates to your personal calendar. If you just want to browse the dates online, use [https://calendar.google.com/calendar/embed?src=moodle.com_p4c2oe7hsb77ltaro5qtihb5d4@group.calendar.google.com&pli=1 this link].).

==Moodle 3.6==

{| class="nicetable"
|-
! Moodle 3.6
| 3 December 2018
| 2018120300
| [[Moodle 3.6 release notes|Release Notes]]
| [https://docs.moodle.org/36/en/Upgrading Upgrading to 3.6]
|-
! Moodle 3.6.1
| 5 December 2018
| 2018120301
| [[Moodle 3.6.1 release notes|Release Notes]]
|
|}

Bug fixes for general core bugs in 3.6.x will end 11 November 2019 (12 months).
Bug fixes for security issues in 3.6.x will end 11 May 2020 (18 months).

==Moodle 3.5 (LTS)==

{| class="nicetable"
|-
! Moodle 3.5
| 17 May 2018
| 2018051700
| [[Moodle 3.5 release notes|Release Notes]]
| [https://docs.moodle.org/35/en/Upgrading Upgrading to 3.5]
|-
! Moodle 3.5.1
| 9 July 2018
| 2018051701
| [[Moodle 3.5.1 release notes|Release Notes]]
|
|-
! Moodle 3.5.2
| 10 September 2018
| 2018051702
| [[Moodle 3.5.2 release notes|Release Notes]]
|
|-
! Moodle 3.5.3
| 12 November 2018
| 2018051703
| [[Moodle 3.5.3 release notes|Release Notes]]
|
|}

Bug fixes for general core bugs in 3.5.x will end 13 May 2019 (12 months).
Bug fixes for security issues in 3.5.x will end 10 May 2021 (36 months).

==Moodle 3.4==

{| class="nicetable"
|-
! Moodle 3.4
| 13 November 2017
| 2017111300
| [[Moodle 3.4 release notes|Release Notes]]
| [https://docs.moodle.org/34/en/Upgrading Upgrading to 3.4]
|-
! Moodle 3.4.1
| 15 January 2018
| 2017111301
| [[Moodle 3.4.1 release notes|Release Notes]]
|
|-
! Moodle 3.4.2
| 19 March 2018
| 2017111302
| [[Moodle 3.4.2 release notes|Release Notes]]
|
|-
! Moodle 3.4.3
| 17 May 2018
| 2017111303
| [[Moodle 3.4.3 release notes|Release Notes]]
|
|-
! Moodle 3.4.4
| 9 July 2018
| 2017111304
| [[Moodle 3.4.4 release notes|Release Notes]]
|
|-
! Moodle 3.4.5
| 10 September 2018
| 2017111305
| [[Moodle 3.4.5 release notes|Release Notes]]
|
|-
! Moodle 3.4.6
| 12 November 2018
| 2017111306
| [[Moodle 3.4.6 release notes|Release Notes]]
|
|}

Bug fixes for general core bugs in 3.4.x ended 12 November 2018 (12 months).
Bug fixes for security issues in 3.4.x will end 13 May 2019 (18 months).

==Moodle 3.3==

{| class="nicetable"
|-
! Moodle 3.3
| 15 May 2017
| 2017051500
| [[Moodle 3.3 release notes|Release Notes]]
| [https://docs.moodle.org/33/en/Upgrading Upgrading to 3.3]
|-
! Moodle 3.3.1
| 10 July 2017
| 2017051501
| [[Moodle 3.3.1 release notes|Release Notes]]
|
|-
! Moodle 3.3.2
| 11 September 2017
| 2017051502
| [[Moodle 3.3.2 release notes|Release Notes]]
|
|-
! Moodle 3.3.3
| 13 November 2017
| 2017051503
| [[Moodle 3.3.3 release notes|Release Notes]]
|
|-
! Moodle 3.3.4
| 15 January 2018
| 2017051504
| [[Moodle 3.3.4 release notes|Release Notes]]
|
|-
! Moodle 3.3.5
| 19 March 2018
| 2017051505
| [[Moodle 3.3.5 release notes|Release Notes]]
|
|-
! Moodle 3.3.6
| 17 May 2018
| 2017051506
| [[Moodle 3.3.6 release notes|Release Notes]]
|
|-
! Moodle 3.3.7
| 9 July 2018
| 2017051507
| [[Moodle 3.3.7 release notes|Release Notes]]
|
|-
! Moodle 3.3.8
| 10 September 2018
| 2017051508
| [[Moodle 3.3.8 release notes|Release Notes]]
|
|-
! Moodle 3.3.9
| 12 November 2018
| 2017051509
| [[Moodle 3.3.9 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 3.3.x ended 17 May 2018 (12 months).
Bug fixes for security issues in 3.3.x ended 12 November 2018 (18 months).

==Moodle 3.2==

{| class="nicetable"
|-
! Moodle 3.2
| 5 December 2016
| 2016120500
| [[Moodle 3.2 release notes|Release Notes]]
| [https://docs.moodle.org/32/en/Upgrading Upgrading to 3.2]
|-
! Moodle 3.2.1
| 9 January 2017
| 2016120501
| [[Moodle 3.2.1 release notes|Release Notes]]
|
|-
! Moodle 3.2.2
| 13 March 2017
| 2016120502
| [[Moodle 3.2.2 release notes|Release Notes]]
|
|-
! Moodle 3.2.3
| 8 May 2017
| 2016120503
| [[Moodle 3.2.3 release notes|Release Notes]]
|
|-
! Moodle 3.2.4
| 10 July 2017
| 2016120504
| [[Moodle 3.2.4 release notes|Release Notes]]
|
|-
! Moodle 3.2.5
| 11 September 2017
| 2016120505
| [[Moodle 3.2.5 release notes|Release Notes]]
|
|-
! Moodle 3.2.6
| 13 November 2017
| 2016120506
| [[Moodle 3.2.6 release notes|Release Notes]]
|
|-
! Moodle 3.2.7
| 15 January 2018
| 2016120507
| [[Moodle 3.2.7 release notes|Release Notes]]
|
|-
! Moodle 3.2.8
| 19 March 2018
| 2016120508
| [[Moodle 3.2.8 release notes|Release Notes]]
|
|-
! Moodle 3.2.9
| 17 May 2018
| 2016120509
| [[Moodle 3.2.9 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 3.2.x ended 13 November 2017 (12 months).
Bug fixes for security issues in 3.2.x ended 17 May 2018 (18 months).

==Moodle 3.1 (LTS)==

{| class="nicetable"
|-
! Moodle 3.1
| 23 May 2016
| 2016052300
| [[Moodle 3.1 release notes|Release Notes]]
| [https://docs.moodle.org/31/en/Upgrading Upgrading to 3.1]
|-
! Moodle 3.1.1
| 11 July 2016
| 2016052301
| [[Moodle 3.1.1 release notes|Release Notes]]
|
|-
! Moodle 3.1.2
| 12 September 2016
| 2016052302
| [[Moodle 3.1.2 release notes|Release Notes]]
|
|-
! Moodle 3.1.3
| 14 November 2016
| 2016052303
| [[Moodle 3.1.3 release notes|Release Notes]]
|
|-
! Moodle 3.1.4
| 9 January 2017
| 2016052304
| [[Moodle 3.1.4 release notes|Release Notes]]
|
|-
! Moodle 3.1.5
| 13 March 2017
| 2016052305
| [[Moodle 3.1.5 release notes|Release Notes]]
|
|-
! Moodle 3.1.6
| 8 May 2017
| 2016052306
| [[Moodle 3.1.6 release notes|Release Notes]]
|
|-
! Moodle 3.1.7
| 10 July 2017
| 2016052307
| [[Moodle 3.1.7 release notes|Release Notes]]
|
|-
! Moodle 3.1.8
| 11 September 2017
| 2016052308
| [[Moodle 3.1.8 release notes|Release Notes]]
|
|-
! Moodle 3.1.9
| 13 November 2017
| 2016052309
| [[Moodle 3.1.9 release notes|Release Notes]]
|
|-
! Moodle 3.1.10
| 15 January 2018
| 2016052310
| [[Moodle 3.1.10 release notes|Release Notes]]
|
|-
! Moodle 3.1.11
| 19 March 2018
| 2016052311
| [[Moodle 3.1.11 release notes|Release Notes]]
|
|-
! Moodle 3.1.12
| 17 May 2018
| 2016052312
| [[Moodle 3.1.12 release notes|Release Notes]]
|
|-
! Moodle 3.1.13
| 9 July 2018
| 2016052313
| [[Moodle 3.1.13 release notes|Release Notes]]
|
|-
! Moodle 3.1.14
| 10 September 2018
| 2016052314
| [[Moodle 3.1.14 release notes|Release Notes]]
|
|-
! Moodle 3.1.15
| 12 November 2018
| 2016052315
| [[Moodle 3.1.15 release notes|Release Notes]]
|
|}

Bug fixes for general core bugs in 3.1.x ended 8 May 2017 (12 months).
Bug fixes for security issues in 3.1.x will end 13 May 2019 (36 months).

==Moodle 3.0==

{| class="nicetable"
|-
! Moodle 3.0
| 16 November 2015
| 2015111600
| [[Moodle 3.0 release notes|Release Notes]]
| [https://docs.moodle.org/30/en/Upgrading Upgrading to 3.0]
|-
! Moodle 3.0.1
| 21 December 2015
| 2015111601
| [[Moodle 3.0.1 release notes|Release Notes]]
|
|-
! Moodle 3.0.2
| 11 January 2016
| 2015111602
| [[Moodle 3.0.2 release notes|Release Notes]]
|
|-
! Moodle 3.0.3
| 14 March 2016
| 2015111603
| [[Moodle 3.0.3 release notes|Release Notes]]
|
|-
! Moodle 3.0.4
| 9 May 2016
| 2015111604
| [[Moodle 3.0.4 release notes|Release Notes]]
|
|-
! Moodle 3.0.5
| 11 July 2016
| 2015111605
| [[Moodle 3.0.5 release notes|Release Notes]]
|
|-
! Moodle 3.0.6
| 12 September 2016
| 2015111606
| [[Moodle 3.0.6 release notes|Release Notes]]
|
|-
! Moodle 3.0.7
| 14 November 2016
| 2015111607
| [[Moodle 3.0.7 release notes|Release Notes]]
|
|-
! Moodle 3.0.8
| 9 January 2017
| 2015111608
| [[Moodle 3.0.8 release notes|Release Notes]]
|
|-
! Moodle 3.0.9
| 13 March 2017
| 2015111609
| [[Moodle 3.0.9 release notes|Release Notes]]
|
|-
! Moodle 3.0.10
| 8 May 2017
| 2015111610
| [[Moodle 3.0.10 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 3.0.x ended 14 November 2016 (12 months).
Bug fixes for security issues in 3.0.x ended 8 May 2017 (18 months).

==Moodle 2.9==

{| class="nicetable"
|-
! Moodle 2.9
| 11 May 2015
| 2015051100
| [[Moodle 2.9 release notes|Release Notes]]
| [https://docs.moodle.org/29/en/Upgrading_to_Moodle_2.9 Upgrading to 2.9]
|-
! Moodle 2.9.1
| 6 July 2015
| 2015051101
| [[Moodle 2.9.1 release notes|Release Notes]]
|
|-
! Moodle 2.9.2
| 14 September 2015
| 2015051102
| [[Moodle 2.9.2 release notes|Release Notes]]
|
|-
! Moodle 2.9.3
| 9 November 2015
| 2015051103
| [[Moodle 2.9.3 release notes|Release Notes]]
|
|-
! Moodle 2.9.4
| 11 January 2016
| 2015051104
| [[Moodle 2.9.4 release notes|Release Notes]]
|
|-
! Moodle 2.9.5
| 14 March 2016
| 2015051105
| [[Moodle 2.9.5 release notes|Release Notes]]
|
|-
! Moodle 2.9.6
| 9 May 2016
| 2015051106
| [[Moodle 2.9.6 release notes|Release Notes]]
|
|-
! Moodle 2.9.7
| 11 July 2016
| 2015051107
| [[Moodle 2.9.7 release notes|Release Notes]]
|
|-
! Moodle 2.9.8
| 12 September 2016
| 2015051108
| [[Moodle 2.9.8 release notes|Release Notes]]
|
|-
! Moodle 2.9.9
| 14 November 2016
| 2015051109
| [[Moodle 2.9.9 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.9.x ended 9 May 2016 (12 months).
Bug fixes for security issues in 2.9.x ended 14 November 2016 (18 months).

==Moodle 2.8==

{| class="nicetable"
|-
! Moodle 2.8
| 10 November 2014
| 2014111000
| [[Moodle 2.8 release notes|Release Notes]]
| [https://docs.moodle.org/28/en/Upgrading_to_Moodle_2.8 Upgrading to 2.8]
|-
! Moodle 2.8.1
| 13 November 2014
| 2014111001
| [[Moodle 2.8.1 release notes|Release Notes]]
|
|-
! Moodle 2.8.2
| 12 January 2015
| 2014111002
| [[Moodle 2.8.2 release notes|Release Notes]]
|
|-
! Moodle 2.8.3
| 2 February 2015
| 2014111003
| [[Moodle 2.8.3 release notes|Release Notes]]
|
|-
! Moodle 2.8.4
| 9 March 2015
| 2014111004
| [[Moodle 2.8.4 release notes|Release Notes]]
|
|-
! Moodle 2.8.5
| 10 March 2015
| 2014111005
| [[Moodle 2.8.5 release notes|Release Notes]]
|
|-
! Moodle 2.8.6
| 11 May 2015
| 2014111006
| [[Moodle 2.8.6 release notes|Release Notes]]
|
|-
! Moodle 2.8.7
| 6 July 2015
| 2014111007
| [[Moodle 2.8.7 release notes|Release Notes]]
|
|-
! Moodle 2.8.8
| 14 September 2015
| 2014111008
| [[Moodle 2.8.8 release notes|Release Notes]]
|
|-
! Moodle 2.8.9
| 9 November 2015
| 2014111009
| [[Moodle 2.8.9 release notes|Release Notes]]
|
|-
! Moodle 2.8.10
| 11 January 2016
| 2014111010
| [[Moodle 2.8.10 release notes|Release Notes]]
|
|-
! Moodle 2.8.11
| 14 March 2016
| 2014111011
| [[Moodle 2.8.11 release notes|Release Notes]]
|
|-
! Moodle 2.8.12
| 9 May 2016
| 2014111012
| [[Moodle 2.8.12 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.8.x ended 9 November 2015 (12 months).
Bug fixes for security issues in 2.8.x ended 9 May 2016 (18 months).

==Moodle 2.7 (LTS)==

{| class="nicetable"
|-
! Moodle 2.7
| 12 May 2014
| 2014051200
| [[Moodle 2.7 release notes|Release Notes]]
| [https://docs.moodle.org/27/en/Upgrading_to_Moodle_2.7 Upgrading to 2.7]
|-
! Moodle 2.7.1
| 14 July 2014
| 2014051201
| [[Moodle 2.7.1 release notes|Release Notes]]
|
|-
! Moodle 2.7.2
| 8 September 2014
| 2014051202
| [[Moodle 2.7.2 release notes|Release Notes]]
|
|-
! Moodle 2.7.3
| 10 November 2014
| 2014051203
| [[Moodle 2.7.3 release notes|Release Notes]]
|
|-
! Moodle 2.7.4
| 12 January 2015
| 2014051204
| [[Moodle 2.7.4 release notes|Release Notes]]
|
|-
! Moodle 2.7.5
| 2 February 2015
| 2014051205
| [[Moodle 2.7.5 release notes|Release Notes]]
|
|-
! Moodle 2.7.6
| 9 March 2015
| 2014051206
| [[Moodle 2.7.6 release notes|Release Notes]]
|
|-
! Moodle 2.7.7
| 10 March 2015
| 2014051207
| [[Moodle 2.7.7 release notes|Release Notes]]
|
|-
! Moodle 2.7.8
| 11 May 2015
| 2014051208
| [[Moodle 2.7.8 release notes|Release Notes]]
|
|-
! Moodle 2.7.9
| 6 July 2015
| 2014051209
| [[Moodle 2.7.9 release notes|Release Notes]]
|
|-
! Moodle 2.7.10
| 14 September 2015
| 2014051210
| [[Moodle 2.7.10 release notes|Release Notes]]
|
|-
! Moodle 2.7.11
| 9 November 2015
| 2014051211
| [[Moodle 2.7.11 release notes|Release Notes]]
|
|-
! Moodle 2.7.12
| 11 January 2016
| 2014051212
| [[Moodle 2.7.12 release notes|Release Notes]]
|
|-
! Moodle 2.7.13
| 14 March 2016
| 2014051213
| [[Moodle 2.7.13 release notes|Release Notes]]
|
|-
! Moodle 2.7.14
| 9 May 2016
| 2014051214
| [[Moodle 2.7.14 release notes|Release Notes]]
|
|-
! Moodle 2.7.15
| 11 July 2016
| 2014051215
| [[Moodle 2.7.15 release notes|Release Notes]]
|
|-
! Moodle 2.7.16
| 12 September 2016
| 2014051216
| [[Moodle 2.7.16 release notes|Release Notes]]
|
|-
! Moodle 2.7.17
| 14 November 2016
| 2014051217
| [[Moodle 2.7.17 release notes|Release Notes]]
|
|-
! Moodle 2.7.18
| 9 January 2017
| 2014051218
| [[Moodle 2.7.18 release notes|Release Notes]]
|
|-
! Moodle 2.7.19
| 13 March 2017
| 2014051219
| [[Moodle 2.7.19 release notes|Release Notes]]
|
|-
! Moodle 2.7.20
| 8 May 2017
| 2014051220
| [[Moodle 2.7.20 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.7.x ended 11 May 2015 (12 months).
Bug fixes for security issues in 2.7.x ended 8 May 2017 (36 months).

==Moodle 2.6==

{| class="nicetable"
|-
! Moodle 2.6
| 18 November 2013
| 2013111800
| [[Moodle 2.6 release notes|Release Notes]]
| [https://docs.moodle.org/26/en/Upgrading_to_Moodle_2.6 Upgrading to 2.6]
|-
! Moodle 2.6.1
| 13 January 2014
| 2013111801
| [[Moodle 2.6.1 release notes|Release Notes]]
|
|-
! Moodle 2.6.2
| 10 March 2014
| 2013111802
| [[Moodle 2.6.2 release notes|Release Notes]]
|
|-
! Moodle 2.6.3
| 12 May 2014
| 2013111803
| [[Moodle 2.6.3 release notes|Release Notes]]
|
|-
! Moodle 2.6.4
| 14 July 2014
| 2013111804
| [[Moodle 2.6.4 release notes|Release Notes]]
|
|-
! Moodle 2.6.5
| 8 September 2014
| 2013111805
| [[Moodle 2.6.5 release notes|Release Notes]]
|
|-
! Moodle 2.6.6
| 10 November 2014
| 2013111806
| [[Moodle 2.6.6 release notes|Release Notes]]
|
|-
! Moodle 2.6.7
| 12 January 2015
| 2013111807
| [[Moodle 2.6.7 release notes|Release Notes]]
|
|-
! Moodle 2.6.8
| 2 February 2015
| 2013111808
| [[Moodle 2.6.8 release notes|Release Notes]]
|
|-
! Moodle 2.6.9
| 9 March 2015
| 2013111809
| [[Moodle 2.6.9 release notes|Release Notes]]
|
|-
! Moodle 2.6.10
| 10 March 2015
| 2013111810
| [[Moodle 2.6.10 release notes|Release Notes]]
|
|-
! Moodle 2.6.11
| 11 May 2015
| 2013111811
| [[Moodle 2.6.11 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.6.x ended 10 November 2014 (12 months).
Bug fixes for security issues in 2.6.x ended 11 May 2015 (18 months).

==Moodle 2.5==

{| class="nicetable"
|-
! Moodle 2.5
| 14 May 2013
| 2013051400
| [[Moodle 2.5 release notes|Release Notes]]
| [https://docs.moodle.org/25/en/Upgrading_to_Moodle_2.5 Upgrading to 2.5]
|-
! Moodle 2.5.1
| 8 July 2013
| 2013051401
| [[Moodle 2.5.1 release notes|Release Notes]]
|
|-
! Moodle 2.5.2
| 9 September 2013
| 2013051402
| [[Moodle 2.5.2 release notes|Release Notes]]
|
|-
! Moodle 2.5.3
| 11 November 2013
| 2013051403
| [[Moodle 2.5.3 release notes|Release Notes]]
|
|-
! Moodle 2.5.4
| 13 January 2014
| 2013051404
| [[Moodle 2.5.4 release notes|Release Notes]]
|
|-
! Moodle 2.5.5
| 10 March 2014
| 2013051405
| [[Moodle 2.5.5 release notes|Release Notes]]
|
|-
! Moodle 2.5.6
| 12 May 2014
| 2013051406
| [[Moodle 2.5.6 release notes|Release Notes]]
|
|-
! Moodle 2.5.7
| 14 July 2014
| 2013051407
| [[Moodle 2.5.7 release notes|Release Notes]]
|
|-
! Moodle 2.5.8
| 8 September 2014
| 2013051408
| [[Moodle 2.5.8 release notes|Release Notes]]
|
|-
! Moodle 2.5.9
| 10 November 2014
| 2013051409
| [[Moodle 2.5.9 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.5.x ended May 2014 (12 months).
Bug fixes for security issues in 2.5.x ended 10 November 2014 (18 months).

==Moodle 2.4==

{| class="nicetable"
|-
! Moodle 2.4
| 3 December 2012
| 2012120300
| [[Moodle 2.4 release notes|Release Notes]]
| [https://docs.moodle.org/24/en/Upgrading_to_Moodle_2.4 Upgrading to 2.4]
|-
! Moodle 2.4.1
| 14 January 2013
| 2012120301
| [[Moodle 2.4.1 release notes|Release Notes]]
|
|-
! Moodle 2.4.2
| 11 March 2013
| 2012120302
| [[Moodle 2.4.2 release notes|Release Notes]]
|
|-
! Moodle 2.4.3
| 18 March 2013
| 2012120303
| [[Moodle 2.4.3 release notes|Release Notes]]
|
|-
! Moodle 2.4.4
| 14 May 2013
| 2012120304
| [[Moodle 2.4.4 release notes|Release Notes]]
|
|-
! Moodle 2.4.5
| 8 July 2013
| 2012120305
| [[Moodle 2.4.5 release notes|Release Notes]]
|
|-
! Moodle 2.4.6
| 9 September 2013
| 2012120306
| [[Moodle 2.4.6 release notes|Release Notes]]
|
|-
! Moodle 2.4.7
| 11 November 2013
| 2012120307
| [[Moodle 2.4.7 release notes|Release Notes]]
|
|-
! Moodle 2.4.8
| 13 January 2014
| 2012120308
| [[Moodle 2.4.8 release notes|Release Notes]]
|
|-
! Moodle 2.4.9
| 10 March 2014
| 2012120309
| [[Moodle 2.4.9 release notes|Release Notes]]
|
|-
! Moodle 2.4.10
| 12 May 2014
| 2012120310
| [[Moodle 2.4.10 release notes|Release Notes]]
|
|-
! Moodle 2.4.11
| 14 July 2014
| 2012120311
| [[Moodle 2.4.11 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.4.x ended December 2013 (12 months).
Bug fixes for security issues in 2.4.x ended June 2014 (18 months).

==Moodle 2.3==

{| class="nicetable"
|-
! Moodle 2.3
| 25 June 2012
| 2012062500
| [[Moodle 2.3 release notes|Release Notes]]
| [https://docs.moodle.org/23/en/Upgrading_to_Moodle_2.3 Upgrading to 2.3]
|-
! Moodle 2.3.1
| 9 July 2012
| 2012062501
| [[Moodle 2.3.1 release notes|Release Notes]]
|
|-
! Moodle 2.3.2
| 10 September 2012
| 2012062502
| [[Moodle 2.3.2 release notes|Release Notes]]
|
|-
! Moodle 2.3.3
| 12 November 2012
| 2012062503
| [[Moodle 2.3.3 release notes|Release Notes]]
|
|-
! Moodle 2.3.4
| 14 January 2013
| 2012062504
| [[Moodle 2.3.4 release notes|Release Notes]]
|
|-
! Moodle 2.3.5
| 11 March 2013
| 2012062505
| [[Moodle 2.3.5 release notes|Release Notes]]
|
|-
! Moodle 2.3.6
| 18 March 2013
| 2012062506
| [[Moodle 2.3.6 release notes|Release Notes]]
|
|-
! Moodle 2.3.7
| 14 May 2013
| 2012062507
| [[Moodle 2.3.7 release notes|Release Notes]]
|
|-
! Moodle 2.3.8
| 8 July 2013
| 2012062508
| [[Moodle 2.3.8 release notes|Release Notes]]
|
|-
! Moodle 2.3.9
| 9 September 2013
| 2012062509
| [[Moodle 2.3.9 release notes|Release Notes]]
|
|-
! Moodle 2.3.10
| 11 November 2013
| 2012062510
| [[Moodle 2.3.10 release notes|Release Notes]]
|
|-
! Moodle 2.3.11
| 13 January 2014
| 2012062511
| [[Moodle 2.3.11 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.3.x ended June 2013 (12 months).
Bug fixes for security issues in 2.3.x ended December 2013 (18 months).

==Moodle 2.2==

{| class="nicetable"
|-
! Moodle 2.2
| 5 December 2011
| 2011120500
| [[Moodle 2.2 release notes|Release Notes]]
| [https://docs.moodle.org/22/en/Upgrading_to_Moodle_2.2 Upgrading to 2.2]
|-
! Moodle 2.2.1
| 9 January 2012
| 2011120501
| [[Moodle 2.2.1 release notes|Release Notes]]
|
|-
! Moodle 2.2.2
| 12 March 2012
| 2011120502
| [[Moodle 2.2.2 release notes|Release Notes]]
|
|-
! Moodle 2.2.3
| 14 May 2012
| 2011120503
| [[Moodle 2.2.3 release notes|Release Notes]]
|
|-
! Moodle 2.2.4
| 9 July 2012
| 2011120504
| [[Moodle 2.2.4 release notes|Release Notes]]
|
|-
! Moodle 2.2.5
| 10 September 2012
| 2011120505
| [[Moodle 2.2.5 release notes|Release Notes]]
|
|-
! Moodle 2.2.6
| 12 November 2012
| 2011120506
| [[Moodle 2.2.6 release notes|Release Notes]]
|
|-
! Moodle 2.2.7
| 14 January 2013
| 2011120507
| [[Moodle 2.2.7 release notes|Release Notes]]
|
|-
! Moodle 2.2.8
| 11 March 2013
| 2011120508
| [[Moodle 2.2.8 release notes|Release Notes]]
|
|-
! Moodle 2.2.9
| 18 March 2013
| 2011120509
| [[Moodle 2.2.9 release notes|Release Notes]]
|
|-
! Moodle 2.2.10
| 14 May 2013
| 2011120510
| [[Moodle 2.2.10 release notes|Release Notes]]
|
|-
! Moodle 2.2.11
| 8 July 2013
| 2011120511
| [[Moodle 2.2.11 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.2.x ended December 2012 (12 months).
Bug fixes for security issues in 2.2.x ended June 2013 (18 months).

==Moodle 2.1==

{| class="nicetable"
|-
! Moodle 2.1
| 1 July 2011
| 2011070100
| [[Moodle 2.1 release notes|Release Notes]]
| [https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1 Upgrading to 2.1]
|-
! Moodle 2.1.1
| 1 August 2011
| 2011070101
| [[Moodle 2.1.1 release notes|Release Notes]]
|
|-
! Moodle 2.1.2
| 10 October 2011
| 2011070102
| [[Moodle 2.1.2 release notes|Release Notes]]
|
|-
! Moodle 2.1.3
| 28 November 2011
| 2011070103
| [[Moodle 2.1.3 release notes|Release Notes]]
|
|-
! Moodle 2.1.4
| 9 January 2012
| 2011070104
| [[Moodle 2.1.4 release notes|Release Notes]]
|
|-
! Moodle 2.1.5
| 12 March 2012
| 2011070105
| [[Moodle 2.1.5 release notes|Release Notes]]
|
|-
! Moodle 2.1.6
| 14 May 2012
| 2011070106
| [[Moodle 2.1.6 release notes|Release Notes]]
|
|-
! Moodle 2.1.7
| 9 July 2012
| 2011070107
| [[Moodle 2.1.7 release notes|Release Notes]]
|
|-
! Moodle 2.1.8
| 10 September 2012
| 2011070108
| [[Moodle 2.1.8 release notes|Release Notes]]
|
|-
! Moodle 2.1.9
| 12 November 2012
| 2011070109
| [[Moodle 2.1.9 release notes|Release Notes]]
|
|-
! Moodle 2.1.10
| 14 January 2013
| 20110701010
| [[Moodle 2.1.10 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.1.x ended June 2012 (12 months).
Bug fixes for security issues in 2.1.x ended December 2012 (18 months).

==Moodle 2.0==
{| class="nicetable"
|-
! Moodle 2.0
| 24 November 2010
| 2010112400
| [[Moodle 2.0 release notes|Release Notes]]
| [https://docs.moodle.org/20/en/Upgrading_to_Moodle_2.0 Upgrading to 2.0]
|-
! Moodle 2.0.1
| 25 December 2010
| 2010122500
| [[Moodle 2.0.1 release notes|Release Notes]]
|
|-
! Moodle 2.0.2
| 21 February 2011
| 2011022100
| [[Moodle 2.0.2 release notes|Release Notes]]
|
|-
! Moodle 2.0.3
| 5 May 2011
| 2011033003
| [[Moodle 2.0.3 release notes|Release Notes]]
|
|-
! Moodle 2.0.4
| 1 August 2011
| 2011033004
| [[Moodle 2.0.4 release notes|Release Notes]]
|
|-
! Moodle 2.0.5
| 10 October 2011
| 2011033005
| [[Moodle 2.0.5 release notes|Release Notes]]
|
|-
! Moodle 2.0.6
| 28 November 2011
| 2011033006
| [[Moodle 2.0.6 release notes|Release Notes]]
|
|-
! Moodle 2.0.7
| 9 January 2012
| 2011033007
| [[Moodle 2.0.7 release notes|Release Notes]]
|
|-
! Moodle 2.0.8
| 12 March 2012
| 2011033008
| [[Moodle 2.0.8 release notes|Release Notes]]
|
|-
! Moodle 2.0.9
| 14 May 2012
| 2011033009
| [[Moodle 2.0.9 release notes|Release Notes]]
|
|-
! Moodle 2.0.10
| 9 July 2012
| 2011033010
| [[Moodle 2.0.10 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 2.0.x ended December 2011 (12 months).
Bug fixes for security issues in 2.0.x ended June 2012 (18 months).

==Moodle 1.9==

{| class="nicetable"
|-
! Moodle 1.9
| 3 March 2008
| 2007101509
| [[Moodle 1.9 release notes|Release Notes]]
| [https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.9 Upgrading to 1.9]
|-
! Moodle 1.9.1
| 15 May 2008
| 2007101512
| [[Moodle 1.9.1 release notes|Release Notes]]
|
|-
! Moodle 1.9.2
| 11 July 2008
| 2007101520
| [[Moodle 1.9.2 release notes|Release Notes]]
|
|-
! Moodle 1.9.3
| 15 October 2008
| 2007101530
| [[Moodle 1.9.3 release notes|Release Notes]]
|
|-
! Moodle 1.9.4
| 28 January 2009
| 2007101540
| [[Moodle 1.9.4 release notes|Release Notes]]
|
|-
! Moodle 1.9.5
| 13 May 2009
| 2007101550
| [[Moodle 1.9.5 release notes|Release Notes]]
|
|-
! Moodle 1.9.6
| 21 October 2009
| 2007101560
| [[Moodle 1.9.6 release notes|Release Notes]]
|
|-
! Moodle 1.9.7
| 25 November 2009
| 2007101570
| [[Moodle 1.9.7 release notes|Release Notes]]
|
|-
! Moodle 1.9.8
| 25 March 2010
| 2007101580.00
| [[Moodle 1.9.8 release notes|Release Notes]]
|
|-
! Moodle 1.9.9
| 8 June 2010
| 2007101590.00
| [[Moodle 1.9.9 release notes|Release Notes]]
|
|-
! Moodle 1.9.10
| 25 October 2010
| 2007101591.00
| [[Moodle 1.9.10 release notes|Release Notes]]
|
|-
! Moodle 1.9.11
| 21 February 2011
| 2007101591.02
| [[Moodle 1.9.11 release notes|Release Notes]]
|
|-
! Moodle 1.9.12
| 10 May 2011
| 2007101591.03
| [[Moodle 1.9.12 release notes|Release Notes]]
|
|-
! Moodle 1.9.13
| 1 August 2011
| 2007101591.04
| [[Moodle 1.9.13 release notes|Release Notes]]
|
|-
! Moodle 1.9.14
| 10 October 2011
| 2007101591.06
| [[Moodle 1.9.14 release notes|Release Notes]]
|
|-
! Moodle 1.9.15
| 28 November 2011
| 2007101591.07
| [[Moodle 1.9.15 release notes|Release Notes]]
|
|-
! Moodle 1.9.16
| 9 January 2012
| 2007101591.10
| [[Moodle 1.9.16 release notes|Release Notes]]
|
|-
! Moodle 1.9.17
| 12 March 2012
| 2007101591.12
| [[Moodle 1.9.17 release notes|Release Notes]]
|
|-
! Moodle 1.9.18
| 14 May 2012
| 2007101591.16
| [[Moodle 1.9.18 release notes|Release Notes]]
|
|-
! Moodle 1.9.19
| 9 July 2012
| 2007101592.00
| [[Moodle 1.9.19 release notes|Release Notes]]
| Support has ended
|}

Bug fixes for general core bugs in 1.9.x has ended June 2011 (3.5 years).
Bug fixes for security issues in 1.9.x by Moodle HQ ended June 2012 (4.5 years).
Bug fixes for security issues in 1.9.19+ branch by [http://catalyst.net.nz Catalyst IT] ended [http://moodle.org/mod/forum/discuss.php?d=199706 Dec 2013] (6 years).

==Moodle 1.8==
*[[Moodle 1.8 release notes|Moodle 1.8]] - 30 March 2007
*[[Moodle 1.8.1 release notes|Moodle 1.8.1]] - 14 June 2007
*[[Moodle 1.8.2 release notes|Moodle 1.8.2]] - 8 July 2007
*[[Moodle 1.8.3 release notes|Moodle 1.8.3]] - 11 October 2007
*[[Moodle 1.8.4 release notes|Moodle 1.8.4]] - 11 January 2008
*[[Moodle 1.8.5 release notes|Moodle 1.8.5]] - 8 April 2008
*[[Moodle 1.8.6 release notes|Moodle 1.8.6]] - 11 July 2008
*[[Moodle 1.8.7 release notes|Moodle 1.8.7]] - 15 October 2008
*[[Moodle 1.8.8 release notes|Moodle 1.8.8]] - 28 January 2009
*[[Moodle 1.8.9 release notes|Moodle 1.8.9]] - 15 May 2009
*[[Moodle 1.8.10 release notes|Moodle 1.8.10]] - 26 October 2009
*[[Moodle 1.8.11 release notes|Moodle 1.8.11]] - 25 November 2009
*[[Moodle 1.8.12 release notes|Moodle 1.8.12]] - 27 March 2010
*[[Moodle 1.8.13 release notes|Moodle 1.8.13]] - 8 June 2010
*[[Moodle 1.8.14 release notes|Moodle 1.8.14]] - 3 December 2010
*Support has ended

==Moodle 1.7==
*[[Moodle 1.7 release notes|Moodle 1.7]] - 7 November 2006
*[[Moodle 1.7.1 release notes|Moodle 1.7.1]] - 17 January 2007
*[[Moodle 1.7.2 release notes|Moodle 1.7.2]] - 30 March 2007
*[[Moodle 1.7.3 release notes|Moodle 1.7.3]] - 11 October 2007
*[[Moodle 1.7.4 release notes|Moodle 1.7.4]] - 11 January 2008
*[[Moodle 1.7.5 release notes|Moodle 1.7.5]] - 11 July 2008
*[[Moodle 1.7.6 release notes|Moodle 1.7.6]] - 15 October 2008
*[[Moodle 1.7.7 release notes|Moodle 1.7.7]] - 28 January 2009
*Support has ended

==Moodle 1.6==
*[[Moodle 1.6 release notes|Moodle 1.6]] - 20 June 2006
*[[Moodle 1.6.1 release notes|Moodle 1.6.1]] - 20 July 2006
*[[Moodle 1.6.2 release notes|Moodle 1.6.2]] - 12 September 2006
*[[Moodle 1.6.3 release notes|Moodle 1.6.3]] - 10 October 2006
*[[Moodle 1.6.4 release notes|Moodle 1.6.4]] - 17 January 2007
*[[Moodle 1.6.5 release notes|Moodle 1.6.5]] - 30 March 2007
*Moodle 1.6.6 - 11 January 2008
*Moodle 1.6.7 - 11 July 2008
*[[Moodle 1.6.8 release notes|Moodle 1.6.8]] - 15 October 2008
*[[Moodle 1.6.9 release notes|Moodle 1.6.9]] - 28 January 2009
* Support has ended

==Moodle 1.5==
*[[Moodle 1.5 release notes|Moodle 1.5]] - 5 June 2005
*[[Moodle 1.5.1 release notes|Moodle 1.5.1]] - 8 July 2005
*[[Moodle 1.5.2 release notes|Moodle 1.5.2]] - 16 July 2005
*[[Moodle 1.5.3 release notes|Moodle 1.5.3]] - 11 November 2005
*[[Moodle 1.5.4 release notes|Moodle 1.5.4]] - 21 May 2006
* Support has ended

==Moodle 1.4==
*Moodle 1.4 - 31 August 2004
*Moodle 1.4.1 - 12 September 2004
*Moodle 1.4.2 - 5 November 2004
*Moodle 1.4.3 - 21 December 2004
*Moodle 1.4.4 - 7 March 2005
*[[Moodle 1.4.5 release notes|Moodle 1.4.5]] - 7 May 2005
* Support has ended

==Moodle 1.3==
*Moodle 1.3 - 25 May 2004
*Moodle 1.3.1 - 4 June 2004
*Moodle 1.3.2 - 9 July 2004
*Moodle 1.3.3 - 16 July 2004
*Moodle 1.3.4 - 11 August 2004
*Moodle 1.3.5 - 9 September 2004
* Support has ended

==Moodle 1.2==
*Moodle 1.2 - 20 March 2004
*Moodle 1.2.1 - 25 March 2004
* Support has ended

==Moodle 1.1==
*Moodle 1.1 - 29 August 2003
*Moodle 1.1.1 - 11 September 2003
* Support has ended

==Moodle 1.0==
*Moodle 1.0 - 20 August 2002
*Moodle 1.0.1 - 26 August 2002
*Moodle 1.0.2 - 2 September 2002
*Moodle 1.0.3 - 5 September 2002
*Moodle 1.0.4 - 10 September 2002
*Moodle 1.0.5 - 27 September 2002
*Moodle 1.0.6 - 26 October 2002
:: 1.0.6.1 - 6 November 2002
:: 1.0.6.2 - 11 November 2002
:: 1.0.6.3 - 14 November 2002
:: 1.0.6.4 - 25 November 2002
*Moodle 1.0.7 - 9 December 2002
*Moodle 1.0.8 - 7 January 2003
*Moodle 1.0.9 - 30 May 2003
* Support has ended

==See also==
*[[Roadmap]] - future versions
*[[Moodle versions]] - an explanation of how our versions work plus version numbers for each release (for $plugin->requires)

[[Category:Release notes]]
[[Category:Core development]]

[[fr:Historique des versions]]
[[es:dev/Historia de las versiones]]
[[de:Versionshistorie]]

Moodle 3.6 release notes

2018-11-15T15:36:30Z

Fox: Database versions

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for 26 November 2018

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.6%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.6].

If you are upgrading from a previous version, please see [[:en:Upgrading|Upgrading]] in the user docs. ''In particular, for sites using a custom theme or login form, from 3.6 onwards, the login form must include a new login token field. See [[Login token]] for details.''

==Server requirements==

These are just the minimum supported versions. We recommend keeping all of your software and operating systems up-to-date.

* Moodle upgrade: Moodle 3.1 or later
* PHP version: minimum PHP 7.0.0 ''Note: minimum PHP version has increased since Moodle 3.3''. PHP 7.1.x and 7.2.x are supported too. PHP 7.x could have some [https://docs.moodle.org/dev/Moodle_and_PHP7#Can_I_use_PHP7_yet.3F engine limitations].
* PHP extension '''intl''' is required since Moodle 3.4 (it was recommended in 2.0 onwards)

=== Database requirements ===

Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.

{| class="nicetable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 9.4
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.6
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 5.5.31
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2008
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 11.2
| Latest
|}

==Client requirements==

=== Browser support ===
Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge
* Internet Explorer

Mobile:
* MobileSafari
* Google Chrome

For the best experience and optimum security, we recommend that you keep your browser up to date. https://whatbrowser.org

Note: Legacy browsers with known compatibility issues with Moodle 3.5:
* Internet Explorer 10 and below
* Safari 7 and below

==Major features==

==Other Highlights==

===Security issues===

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

===For developers===

==See also==
*[[Moodle 3.5 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.6]]

[[fr:Notes de mise à jour de Moodle 3.6]]
[[es:Notas de Moodle 3.6]]

Implementing Reset course functionality in a module

2018-11-08T10:19:16Z

Fox: Typos

The course reset code is triggered from /course/reset.php. To have your module included, you need to implement the three functions described below. To work out how to do this, a good example is to look at the implementations in /mod/forum/lib.php

==''mymodule''_reset_course_form_definition(&$mform)==

This is called directly by /course/reset.php. It needs to output some form controls to control different options for resetting your module. You should use Form API for create form.

The convention is to call settings relating your your module reset_''mymodule''_''something''.

The forum implementation is a good model:

<pre><nowiki>
/**
* Called by course/reset.php
*/
function forum_reset_course_form_definition(&$mform) {
$mform->addElement('header', 'forumheader', get_string('modulenameplural', 'forum'));

$mform->addElement('checkbox', 'reset_forum_all', get_string('resetforumsall','forum'));

$mform->addElement('select', 'reset_forum_types', get_string('resetforums', 'forum'), forum_get_forum_types_all(), array('multiple' => 'multiple'));
$mform->setAdvanced('reset_forum_types');
$mform->disabledIf('reset_forum_types', 'reset_forum_all', 'checked');

$mform->addElement('checkbox', 'reset_forum_subscriptions', get_string('resetsubscriptions','forum'));
$mform->setAdvanced('reset_forum_subscriptions');

$mform->addElement('checkbox', 'reset_forum_track_prefs', get_string('resettrackprefs','forum'));
$mform->setAdvanced('reset_forum_track_prefs');
$mform->disabledIf('reset_forum_track_prefs', 'reset_forum_all', 'checked');

$mform->addElement('checkbox', 'reset_forum_ratings', get_string('deleteallratings'));
$mform->disabledIf('reset_forum_ratings', 'reset_forum_all', 'checked');
}
</nowiki></pre>

==''mymodule''_reset_userdata($data)==

This actually does the resetting. It is called indirectly, /course/reset.php calls reset_course_userdata() in /lib/moodlelib.php, which then calls the functions for each module.

The $data parameter is what came back from the form printed by forum_reset_course. In particular, $data->courseid is the id of the course we are cleaning up.

The forum implementation is again a good one to study, here is a very simple example:

<pre><nowiki>
function example_reset_userdata($data) {
if (!empty($data->reset_example_frogs)) {
if (delete_records('example_frogs', 'couresid', $data->courseid) and $showfeedback) {
notify(get_string('frogsdeleted', 'example'), 'notifysuccess');
}
}
if (!empty($data->reset_example_newts)) {
if (delete_records('example_newts', 'couresid', $data->courseid) and $showfeedback) {
notify(get_string('newtsdeleted', 'example'), 'notifysuccess');
}
}
}
</nowiki></pre>

==''mymodule''_reset_course_form_defaults($course)==

Used for set default values to form's elements displayed by ''mymodule''_reset_course_form_definition. The forum implementation:

<pre><nowiki>
function forum_reset_course_form_defaults($course) {
return array('reset_forum_all'=>1, 'reset_forum_subscriptions'=>0, 'reset_forum_track_prefs'=>0, 'reset_forum_ratings'=>1);
}
</nowiki></pre>

[[ja:開発:コースのリセット機能をモジュールに実装する]]

Moodle App Plugins Development Guide

2018-06-12T14:49:35Z

Fox: /* New approach */

{{Moodle Mobile}}

==Context==
Since Moodle 3.1 it is possible to support different types of Moodle plugins in the Mobile app via the [[Moodle Mobile Remote add-ons|Remote add-ons]] functionality.

Remote add-ons allow a developer to add complete support to their plugins in the Mobile app, but they have some disadvantages:
* Remote add-ons are not easy to develop and test since they are required to be developed as an Angular JS/Ionic module.
* A zip file containing the plugin must be downloaded from the server to be lazy-loaded.
* It is not easy to maintain or upgrade them.
* Developers had to set up a local Mobile development environment

In order to allow plugin developers to make their plugins compatible with the app, the Mobile team has been thinking in a new way to extend the mobile app features following these premises:
* It has to be easy to develop
* It should work without developing Angular/Ionic code
* It has to be easy to maintain
* It has to be supported since Moodle 3.1 at least
* Should support all the different types of Moodle plugins supported by the app
* Should work in any type of device
* Should not require JavaScript at all, although in some cases it will be needed. In the latter case, we’ll try to simplify the required JavaScript

==New approach==

We published an initial draft specification, and last month we started its implementation. During the implementation process we decided to make the following changes to the initial plans in order to make developers life easier:

* There will be just one way to support plugins in the app.
* This new way will allow developers to support plugins using PHP code, templates and Ionic markup (html components).
* The use of JavaScript will be optional (but some type of advanced plugins may require it)
* Developers won’t need to set up a Mobile development environment, they will be able to test using the latest version of the official app (although setting up a local Mobile environment is recommended for complex plugins).

This means that remote add-ons won’t be necessary anymore, and developers won’t have to learn Ionic 3 / Angular and set up a new mobile development environment to migrate them.

Important notes:
* Moodle Mobile 3.5 (to be released June 2018) will be the first version of the Mobile app supporting this new type of plugins.
* Remote add-ons will have to be migrated to the new simpler way (following this documentation)
* These features are natively supported in Moodle 3.5, but for previous versions you will need to install the Moodle Mobile Additional Features plugin.

==How it works==

The overall idea is to allow Moodle plugins to extend different areas in the app with ''just PHP server side'' code and Ionic 3 markup (custom html elements that are called components) using a set of custom Ionic directives and components.

Developers will have to:
# Create a db/mobile.php file in their plugins. In this file developers will be able to indicate which areas of the app they want to extend, for example, adding a new option in the main menu, implementing an activity module not supported, including a new option in the course menu, including a new option in the user profile, etc. All the areas supported are described further in this document.
# Create new functions in a reserved namespace that will return the content of the new options. The content should be returned rendered (html). The template should use [https://ionicframework.com/docs/components/ Ionic components] so that it looks native (custom html elements) but it can be generated using mustache templates.

Let’s clarify some points:

* You don’t need to create new Web Service functions (although you will be able to use them for advanced features). You just need plain php functions that will be placed in a reserved namespace.
* Those functions will be exported via the Web Service function tool_mobile_get_content
* As arguments of your functions you will always receive the userid, some relevant details of the app (app version, current language in the app, etc…) and some specific data depending on the type of plugin (courseid, cmid, …).
* We provide a list of custom Ionic components and directives (html tags) that will provide dynamic behaviour, like indicating that you are linking a file that can be downloaded, or to allow a transition to new pages into the app calling a specific function in the server, submit form data to the server etc..

==Step by step example==

In this example, we are going to update an existing plugin ([https://github.com/markn86/moodle-mod_certificate Certificate activity module]) that currently uses a Remote add-on.
This is a simple activity module that displays the certificate issued for the current user along with the list of the dates of previously issued certificates. It also stores in the course log that the user viewed a certificate. This module also works offline: when the user downloads the course or activity, the data is pre-fetched and can be viewed offline.

The example code can be downloaded from here (see last commit) https://github.com/jleyva/moodle-mod_certificate/commits/MOBILE-2363

===Step 1. Update the db/mobile.php file===
In this case, we are updating an existing file but for new plugins, you should create this new file.

<code php>
$addons = array(
"mod_certificate" => array( // Plugin identifier
'handlers' => array( // Different places where the plugin will display content.
'coursecertificate' => array( // Handler unique name (alphanumeric).
'displaydata' => array(
'icon' => $CFG->wwwroot . '/mod/certificate/pix/icon.gif',
'class' => '',
),

'delegate' => 'CoreCourseModuleDelegate', // Delegate (where to display the link to the plugin)
'method' => 'mobile_course_view', // Main function in \mod_certificate\output\mobile
'offlinefunctions' => array(
'mobile_course_view' => array(),
'mobile_issues_view' => array()
) // Function that needs to be downloaded for offline.
)
),
'lang' => array( // Language strings that are used in all the handlers.
array('pluginname', 'certificate),
array('summaryofattempts', 'certificate),
array('getcertificate', 'certificate),
array('requiredtimenotmet', 'certificate),
array('viewcertificateviews', 'certificate')
),
)
);
</code>

;Plugin identifier:
: A unique name for the plugin, it can be anything (there’s no need to match the module name).

;Handlers (Different places where the plugin will display content):
: A plugin can be displayed in different views in the app. Each view should have a unique name inside the plugin scope (alphanumeric).

; Display data:
: This is only needed for certain types of plugins. Also, depending on the type of delegate it may require additional (or less fields), in this case we are indicating the module icon.

; Delegate
: Where to display the link to the plugin, see the Delegates chapter in this documentation for all the possible options.

; Method:
: This is the function in the Moodle component/lib.php file to be executed the first time the user clicks in the new option displayed in the app. The function should be a method of a Mobile class under the output/mobile namespace.

; Offlinefunctions
: These are the functions that need to be downloaded for offline usage. This is the list of functions that need to be called and stored when the user downloads a course for offline usage. Please note that you can add functions here that are not even listed in the mobile.php file.
: In our example, downloading for offline access will mean that we'll execute the functions for getting the certificate and issued certificates passing as parameters the current userid (and courseid when we are using the mod or course delegate). If we have the result of those functions stored in the app, we'll be able to display the certificate information even if the user is offline.
: Offline functions will be mostly used to display information for final users, any further interaction with the view won’t be supported offline (for example, trying to send information when the user is offline).
: You can indicate here other Web Services functions, indicating the parameters that they might need from a defined subset (currently userid and courseid)
: Prefetching the module will also download all the files returned by the methods in these offline functions (in the ''files'' array).

;Lang:
: The language pack string ids used in the plugin by all the handlers. Please note that you should avoid adding all the plugin string ids (including those unused) because the Web Service that returns the plugin information will include the translation of each string id for every language installed in the platform.

There are additional attributes supported by the mobile.php list, see “Mobile.php supported options” section below.

===Step 2. Creating the main function===

The main function displays the current issued certificate (or several warnings if it’s not possible to issue a certificate). It also displays a link to view the dates of previously issued certificates.

All the functions must be created in the plugin or subsystem classes/output directory, the name of the class must be mobile.

For this example (mod_certificate plugin) the namespace name will be mod_certificate\output.

'''File contents: mod/certificate/classes/output/mobile.php'''

<code php>
<?php
namespace mod_certificate\output;

defined('MOODLE_INTERNAL') || die();

use context_module;
use mod_certificate_external;

/**
* Mobile output class for certificate
*
* @package mod_certificate
* @copyright 2018 Juan Leyva
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mobile {

/**
* Returns the certificate course view for the mobile app.
* @param array $args Arguments from tool_mobile_get_content WS
*
* @return array HTML, javascript and otherdata
*/
public static function mobile_course_view($args) {
global $OUTPUT, $USER, $DB;

$args = (object) $args;
$cm = get_coursemodule_from_id('certificate', $args->cmid);

// Capabilities check.
require_login($args->courseid , false , $cm, true, true);

$context = context_module::instance($cm->id);

require_capability ('mod/certificate:view', $context);
if ($args->userid != $USER->id) {
require_capability('mod/certificate:manage', $context);
}
$certificate = $DB->get_record('certificate', array('id' => $cm->instance));

// Get certificates from external (taking care of exceptions).
try {
$issued = mod_certificate_external::issue_certificate($cm->instance);
$certificates = mod_certificate_external::get_issued_certificates($cm->instance);
$issues = array_values($certificates['issues']); // Make it mustache compatible.
} catch (Exception $e) {
$issues = array();
}

// Set timemodified for each certificate.
foreach ($issues as $issue) {
if (empty($issue->timemodified)) {
$issue->timemodified = $issue->timecreated;
}
}

$showget = true;
if ($certificate->requiredtime && !has_capability('mod/certificate:manage', $context)) {
if (certificate_get_course_time($certificate->course) < ($certificate->requiredtime * 60)) {
$showget = false;
}
}

$certificate->name = format_string($certificate->name);
list($certificate->intro, $certificate->introformat) =
external_format_text($certificate->intro, $certificate->introformat, $context->id,'mod_certificate', 'intro');
$data = array(
'certificate' => $certificate,
'showget' => $showget && count($issues) > 0,
'issues' => $issues,
'issue' => $issues[0],
'numissues' => count($issues),
'cmid' => $cm->id,
'courseid' => $args->courseid
);

return array(
'templates' => array(
array(
'id' => 'main',
'html' => $OUTPUT->render_from_template('mod_certificate/mobile_view_page', $data),
),
),
'javascript' => '',
'otherdata' => '',
'files' => $issues
);
}
}
</code>

Let’s go through the function code to analyse the different parts.

;Function declaration:
: The function name is the same as the one used in the mobile.php file (method field). There is only one argument “$args” which is an array containing all the information sent by the mobile app (the courseid, userid, appid, appversionname, appversioncode, applang, appcustomurlscheme…)

; Function implementation:
: In the first part of the function, we check permissions and capabilities (like a view.php script would do normally). Then we retrieve the certificate information that’s necessary to display the template.

Finally, we return:
* The rendered template (notice that we could return more than one template but we usually would only need one). By default the app will always render the first template received, the rest of the templates can be used if the plugin defines some Javascript code.
* JavaScript: Empty, because we don’t need any in this case
* Other data: Empty as well, because we don’t need any additional data to be used by directives or components in the template. This field will be published as an object supporting 2-way-data-bind to the template.
* Files: A list of files that the app should be able to download (for offline usage mostly)

===Step 3. Creating the template for the main function===

This is the most important part of your plugin because it contains the code that will be rendered on the mobile app.

In this template we’ll be using Ionic and custom directives and components available in the Mobile app.

All the HTML attributes starting with ion- are ionic components. Most of the time the component name is self-explanatory but you may refer to a detailed guide here: https://ionicframework.com/docs/components/

All the HTML attributes starting with ''core-'' are custom components of the Mobile app.

'''File contents: mod/certificate/templates/mobile_view_page.mustache'''

<code php>
{{=<% %>=}}
<div>
<core-course-module-description description="<% certificate.intro %>" component="mod_certificate" componentId="<% cmid %>"></core-course-module-description>

<ion-list>
<ion-list-header>
<p class="item-heading">{{ 'plugin.mod_certificate.summaryofattempts' | translate }}</p>
</ion-list-header>

<%#issues%>
<ion-item>
<button ion-button block color="light" core-site-plugins-new-content title="<% certificate.name %>" component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}">
{{ 'plugin.mod_certificate.viewcertificateviews' | translate: {$a: <% numissues %>} }}
</button>
</ion-item>
<%/issues%>

<%#showget%>
<ion-item>
<button ion-button block core-course-download-module-main-file moduleId="<% cmid %>" courseId="<% certificate.course %>" component="mod_certificate" [files]="[{fileurl: '<% issue.fileurl %>', filename: '<% issue.filename %>', timemodified: '<% issue.timemodified %>', mimetype: '<% issue.mimetype %>'}]">
<ion-icon name="cloud-download" item-start></ion-icon>
{{ 'plugin.mod_certificate.getcertificate' | translate }}
</button>
</ion-item>
<%/showget%>

<%^showget%>
<ion-item>
<p>{{ 'plugin.mod_certificate.requiredtimenotmet' | translate }}</p>
</ion-item>
<%/showget%>


<span core-site-plugins-call-ws-on-load name="mod_certificate_view_certificate" [params]="{certificateid: <% certificate.id %>}" [preSets]="{getFromCache: 0, saveToCache: 0}"></span>
</ion-list>
</div>
</code>

In the first line of the template we switch delimiters to avoid conflicting with Ionic delimiters (that are curly brackets like mustache).

Then we display the module description using <code><core-course-module-description</code> that is a component used to include the course module description.

For displaying the certificate information we create a list of elements, adding a header on top.
The following line <code>{{ 'plugin.mod_certificate.summaryofattempts' | translate }}</code> indicates that the Mobile app will translate the ''summaryofattempts'' string id (here we could’ve used mustache translation but it is usually better to delegate the strings translations to the app). The string id has this format:

“plugin” + plugin identifier (from mobile.php) + string id (the string must be indicated in the lang field in mobile.php).

Then we display a button to transition to another page if there are certificates issued. The attribute (directive) <code>core-site-plugins-new-content</code> indicates that if the user clicks the button, we need to call the function “mobile_issues_view” in the component “mod_certificate” passing as arguments the cmid and courseid. The content returned by this function will be displayed in a new page (see Step 4 for the code of this new page).

Just after this button we display another one but this time for downloading an issued certificate. The <code>core-course-download-module-main-file</code> directive indicates that clicking this button is for downloading the whole activity and opening the main file. This means that, when the user clicks this button, the whole certificate activity will be available in offline.

Finally, just before the ion-list is closed, we use the <code>core-site-plugins-call-ws-on-load</code> directive to indicate that once the page is loaded, we need to call to a Web Service function in the server, in this case we are calling the ''mod_certificate_view_certificate'' that will log that the user viewed this page.

As you can see, no JavaScript was necessary at all. We used plain HTML elements and attributes that did all the complex dynamic logic (like calling a Web Service) behind the scenes.

===Step 4. Adding an additional page===

'''Partial file contents: mod/certificate/classes/output/mobile.php'''

<code php>
/**
* Returns the certificate issues view for the mobile app.
* @param array $args Arguments from tool_mobile_get_content WS
*
* @return array HTML, javascript and otherdata
*/
public static function mobile_issues_view($args) {
global $OUTPUT, $USER, $DB;

$args = (object) $args;
$cm = get_coursemodule_from_id('certificate', $args->cmid);

// Capabilities check.
require_login($args->courseid , false , $cm, true, true);

$context = context_module::instance($cm->id);

require_capability ('mod/certificate:view', $context);
if ($args->userid != $USER->id) {
require_capability('mod/certificate:manage', $context);
}
$certificate = $DB->get_record('certificate', array('id' => $cm->instance));

// Get certificates from external (taking care of exceptions).
try {
$issued = mod_certificate_external::issue_certificate($cm->instance);
$certificates = mod_certificate_external::get_issued_certificates($cm->instance);
$issues = array_values($certificates['issues']); // Make it mustache compatible.
} catch (Exception $e) {
$issues = array();
}

$data = array(
'issues' => $issues
);

return array(
'templates' => array(
array(
'id' => 'main',
'html' => $OUTPUT->render_from_template('mod_certificate/mobile_view_issues', $data),
),
),
'javascript' => '',
'otherdata' => ''
);
}
</code>

This function for the new page was added just after the mobile_course_view function, the code is quite similar: Capabilities checks, retrieves the information required for the template and returns the template rendered.

The code of the mustache template is also very simple:

'''File contents: mod/certificate/templates/mobile_view_issues.mustache'''

<code php>
{{=<% %>=}}
<div>
<ion-list>
<%#issues%>
<ion-item>
<p class="item-heading">{{ <%timecreated%> | coreToLocaleString }}</p>
<p><%grade%></p>
</ion-item>
<%/issues%>
</ion-list>
</div>
</code>

As we did in the previous template, in the first line of the template we switch delimiters to avoid conflicting with Ionic delimiters (that are curly brackets like mustache).

Here we are creating an ionic list that will display a new item in the list per each issued certificated.

For the issued certificated we’ll display the time when it was created (using the app filter ''coreToLocaleString''). We are also displaying the grade displayed in the certificate (if any).

==Getting started==

The first and most important thing to know is that you don’t need a local mobile environment, you can just use the Chrome or Chromium browser to add mobile support to your plugins!

Open this URL (with Chrome or Chromium browser): https://mobileapp.moodledemo.net/ and you will see a web version of the mobile app completely functional (except for some native features). This URL is updated with the latest integration version of the app.

Please test that your site works correctly in the web version before starting any development.

===Moodle version requirements===

If your Moodle version is lower than 3.5 (to be released in May) you will need to install the [https://docs.moodle.org/en/Moodle_Mobile_additional_features Moodle Mobile additional features plugin].

Please use this development version for now: https://github.com/moodlehq/moodle-local_mobile/commits/MOODLE_31_STABLE (if your Moodle version is 3.2, 3.3 or 3.4) you will have to use the specific branch for your version but applying manually the [https://github.com/moodlehq/moodle-local_mobile/commits/MOODLE_31_STABLE last commit from the 3.1 branch] (the one with number MOBILE-2362).

Also, when installing the Moodle Mobile Additional features plugin you must follow the installation instructions so the service is set up properly.

Remember to update your plugin documentation to reflect that this plugin is mandatory for Mobile support. We don’t recommend to indicate in your plugin version.php a dependency to local_mobile though.

===Development workflow===

First of all, we recommend creating a simple ''mobile.php'' for displaying a new main menu option (even if your plugin won’t be in the main menu, just to verify that you are able to extend the app plugins). Then open the webapp (https://mobileapp.moodledemo.net/) or refresh the browser if it was already open. Check that you can correctly see the new menu option you included.

Then, develop the main function of the app returning a “Hello world” or basic code (without using templates) to see that everything works together. After adding the classes/output/mobile.php file it is very important to “Purge all caches” to avoid problems with the auto-loading cache.

It is important to remember that:
* Any change in the mobile.php file will require you to refresh the web app page in the browser (remember to disable the cache in the Chrome developer options).
* Any change in an existing template or function won’t require to refresh the browser page. In most cases you should just do a PTR (Pull down To Refresh) in the page that displays the view returned by the function. Be aware that PTR will work only when using the “device” emulation in the browser (see following section).

===Testing and debugging===

To learn how to debug with the web version of the app, please read the following documents:
* [[Moodle Mobile debugging WS requests]] AND
* [[Moodle Mobile development using Chrome or Chromium]] (please, omit the installation section)

For plugins using the Javascript API you may develop making use of the console.log function to add trace messages in your code that will be displayed in the browser console.

==Mobile.php supported options==

In the Step by Step section we learned about some of the existing options for handlers configuration. This is the full list of supported options:

===Common options===

* '''displaydata''' (mandatory for certain types): Data used to display the handler. It will vary depending on the delegate, and some delegates won’t need it at all (like course format). Attributes usually required in the ''displaydata'': title, icon, class.
* '''delegate''' (mandatory): Name of the delegate to register the handler in.
* '''method''' (mandatory): The function to call to retrieve the main page content.
* '''priority''' (optional): Priority of the handler. Only for certain delegates. Higher priority is displayed first.
* '''lang''' (optional): List of language strings.
* '''init''' (optional): A function to call to retrieve the initialization JS and the "restrict" to apply to the whole handler. It can also return templates that can be used from the Javascript of the init method or the Javascript of the handler’s method.
* '''restricttocurrentuser''' (optional) Only used if the delegate has a isEnabledForUser function. If true, the handler will only be shown for current user. For more info about displaying the plugin only for certain users, please see [[Mobile_support_for_plugins#Display_the_plugin_only_if_certain_conditions_are_met|Display the plugin only if certain conditions are met]].
* '''restricttoenrolledcourses''' (optional): Only used if the delegate has a isEnabledForCourse function. If true or not defined, the handler will only be shown for courses the user is enrolled in. For more info about displaying the plugin only for certain courses, please see [[Mobile_support_for_plugins#Display_the_plugin_only_if_certain_conditions_are_met|Display the plugin only if certain conditions are met]].
* '''styles''' (optional): An array with two properties: ''url'' and ''version''. The URL should point to a CSS file, either using an absolute URL or a relative URL. This file will be downloaded and applied by the app. It's recommended to include styles that will only affect your plugin templates. The version number is used to determine if the file needs to be downloaded again, you should change the version number everytime you change the CSS file.

===Options only for CoreCourseModuleDelegate===

* '''offlinefunctions''': (optional) List of functions to call when prefetching the module. It can be a get_content method or a WS. You can filter the params received by the WS. By default, WS will receive these params: courseid, cmid, userid. Other valid values that will be added if they are present in the list of params: courseids (it will receive a list with the courses the user is enrolled in), component + 'id' (e.g. certificateid).
* '''downloadbutton''': (optional) Whether to display download button in the module. If not defined, the button will be shown if there is any offlinefunction.
* '''isresource''': (optional) Whether the module is a resource or an activity. Only used if there is any offlinefunction. If your module relies on the "contents" field, then it should be true.
* '''updatesnames''': (optional) Only used if there is any offlinefunction. A Regular Expression to check if there's any update in the module. It will be compared to the result of ''core_course_check_updates''.

===Options only for CoreCourseFormatDelegate===

* '''canviewallsections''': (optional) Whether the course format allows seeing all sections in a single page. Defaults to true.
* '''displayenabledownload''': (optional) Whether the option to enable section/module download should be displayed. Defaults to true.
* '''displaysectionselector''': (optional) Whether the default section selector should be displayed. Defaults to true.

===Options only for CoreUserDelegate===

* '''type''': The type of the addon. Values accepted: 'newpage' (default) or 'communication'.

==Delegates==

===CoreMainMenuDelegate===

You must use this delegate when you want to add new items to the main menu (currently displayed at the bottom of the app).

===CoreCourseOptionsDelegate===

You must use this delegate when you want to add new options in a course (Participants or Grades are examples of this type of delegate).

===CoreCourseModuleDelegate===

You must use this delegate for supporting activity modules or resources, please review the specific options for this delegate in the “Options only for CoreCourseModuleDelegate” section.

===CoreUserDelegate===

You must use this delegate when you want to add additional options in the user profile page in the app. Options can be of different types (newpage, communication or action).

===CoreCourseFormatDelegate===

You must use this delegate for supporting course formats, please review the specific options for this delegate in the “Options only for CoreCourseFormatDelegate” section.

===Other advanced delegates===

This delegates require JavaScript to be supported. See [[Mobile_support_for_plugins#Initialization|Initialization]] for more information.

* CoreContentLinksDelegate
* CoreUserProfileFieldDelegate
* CoreCourseModulePrefetchDelegate
* CoreFileUploaderDelegate
* CorePluginFileDelegate

==Available components and directives==

===Difference between component and directives===

A component (represented as an HTML tag) is used to add custom elements to the app.
Example of components are: ion-list, ion-item, core-search-box

A directive (represented as an HTML attribute) allows you to extend a piece of HTML with additional information or functionality.
Example of directives are: core-auto-focus, *ngIf, ng-repeat

The Mobile app uses Angular, Ionic and custom components and directives, for a full reference of:
* Angular directives, please check: https://angular.io/api?type=directive
* Ionic components, please check: https://ionicframework.com/docs/

===Custom core components and directives===

These are some useful custom components and directives (only available in the mobile app). Please notice that this isn’t the full list of components and directives of the app, it’s just an extract of the most common ones.

====core-format-text====

This directive formats the text and adds some directives needed for the app to work as it should. For example, it treats all links and all the embedded media so they work fine in the app. If some content in your template includes links or embedded media, please use this directive.

This directive automatically applies core-external-content and core-link to all the links and embedded media.

Data that can be passed to the directive:

* '''text''' (string): The text to format.
* '''siteId''' (string): Optional. Site ID to use. If not defined, current site.
* '''component''' (string): Optional. Component to use when downloading embedded files.
* '''componentId''' (string|number): Optional. ID to use in conjunction with the component.
* '''adaptImg''' (boolean): Optional. Whether to adapt images to screen width. Defaults to true.
* '''clean''' (boolean): Optional. Whether all the HTML tags should be removed. Defaults to false.
* '''singleLine''' (boolean): Optional. Whether new lines should be removed (all text in single line). Only if clean=true. Defaults to false.
* '''maxHeight''' (number): Optional. Max height in pixels to render the content box. It should be 50 at least to make sense. Using this parameter will force display: block to calculate height better. If you want to avoid this use class="inline" at the same time to use display: inline-block.
* '''fullOnClick''' (boolean): Optional. Whether it should open a new page with the full contents on click. Only if maxHeight is set and the content has been collapsed. Defaults to false.
* '''fullTitle''' (string): Optional. Title to use in full view. Defaults to "Description".

Example usage:

<code php>
<core-format-text text="<% cm.description %>" component="mod_certificate" componentId="<% cm.id %>"></core-format-text>
</code>

====core-link====

Directive to handle a link. It performs several checks, like checking if the link needs to be opened in the app, and opens the link as it should (without overriding the app).

This directive is automatically applied to all the links and media inside core-format-text.

Data that can be passed to the directive:

* '''capture''' (boolean): Optional. Whether the link needs to be captured by the app (check if the link can be handled by the app instead of opening it in a browser).
* '''inApp''' (boolean): Optional. True to open in embedded browser, false to open in system browser.
* '''autoLogin''' (string): Optional. If the link should be open with auto-login. Accepts the following values:
** "yes" -> Always auto-login.
** "no" -> Never auto-login.
** "check" -> Auto-login only if it points to the current site. Default value.

Example usage:
<code php>
<a href="<% cm.url %>" core-link>
</code>

====core-external-content====

Directive to handle links to files and embedded files. This directive should be used in any link to a file or any embedded file that you want to have available when the app is offline.

If a file is downloaded, its URL will be replaced by the local file URL.

This directive is automatically applied to all the links and media inside core-format-text.

Data that can be passed to the directive:

* '''siteId''' (string): Optional. Site ID to use. If not defined, current site.
* '''component''' (string): Optional. Component to use when downloading embedded files.
* '''componentId''' (string|number): Optional. ID to use in conjunction with the component.

Example usage:
<code php>
<img src="<% event.iconurl %>" core-external-content component="mod_certificate" componentId="<% event.id %>">
</code>

====core-user-link====

Directive to go to user profile on click. When the user clicks the element where this directive is attached, the right user profile will be opened.

Data that can be passed to the directive:

* '''userId''' (number): User id to open the profile.
* '''courseId''' (number): Optional. Course id to show the user info related to that course.

Example usage:
<code php>
<a ion-item core-user-link userId="<% userid %>">
</code>

====core-file====

Component to handle a remote file. It shows the file name, icon (depending on mimetype) and a button to download/refresh it. The user can identify if the file is downloaded or not based on the button.

Data that can be passed to the directive:

* file (object): The file. Must have a property 'filename' and a 'fileurl' or 'url'
* component (string): Optional. Component the file belongs to.
* componentId (string|number): Optional. ID to use in conjunction with the component.
* canDelete (boolean): Optional. Whether file can be deleted.
* alwaysDownload (boolean): Optional. Whether it should always display the refresh button when the file is downloaded. Use it for files that you cannot determine if they're outdated or not.
* canDownload (boolean): Optional. Whether file can be downloaded. Defaults to true.

Example usage:
<code php>
<core-file [file]="{fileurl: <% issue.url %>, filename: <% issue.name %>, timemodified: <% issue.timemodified %>, filesize: <% issue.size %>}" component="mod_certificate" componentId="<% cm.id %>"></core-file>
</code>

====core-download-file====

Directive to allow downloading and open a file. When the item with this directive is clicked, the file will be downloaded (if needed) and opened.

It is usually recommended to use the core-file component since it also displays the state of the file.

Data that can be passed to the directive:

* '''core-download-file''' (object): The file to download.
* '''component''' (string): Optional. Component to link the file to.
* '''componentId''' (string|number): Optional. Component ID to use in conjunction with the component.

Example usage: a button to download a file.
<code php>
<button ion-button [core-download-file]="{fileurl: <% issue.url %>, timemodified: <% issue.timemodified %>, filesize: <% issue.size %>}" component="mod_certificate" componentId="<% cm.id %>">
{{ 'plugin.mod_certificate.download | translate }}
</button>
</code>

====core-course-download-module-main-file====

Directive to allow downloading and opening the main file of a module.

When the item with this directive is clicked, the whole module will be downloaded (if needed) and its main file opened. This is meant for modules like mod_resource.

This directive must receive either a module or a moduleId. If no files are provided, it will use module.contents.

Data that can be passed to the directive:

* '''module''' (object): Optional. The module object. Required if module is not supplied.
* '''moduleId''' (number): Optional. The module ID. Required if module is not supplied.
* '''courseId''' (number): The course ID the module belongs to.
* '''component''' (string): Optional. Component to link the file to.
* '''componentId''' (string|number): Optional. Component ID to use in conjunction with the component. If not defined, moduleId.
* '''files''' (object[]): Optional. List of files of the module. If not provided, use module.contents.

Example usage:
<code php>
<button ion-button block core-course-download-module-main-file moduleId="<% cmid %>" courseId="<% certificate.course %>" component="mod_certificate" [files]="[{fileurl: '<% issue.fileurl %>', filename: '<% issue.filename %>', timemodified: '<% issue.timemodified %>', mimetype: '<% issue.mimetype %>'}]">
{{ 'plugin.mod_certificate.getcertificate' | translate }}
</button>
</code>

====core-navbar-buttons====

Component to add buttons to the app's header without having to place them inside the header itself. Using this component in a site plugin will allow adding buttons to the header of the current page.

If this component indicates a position (start/end), the buttons will only be added if the header has some buttons in that position. If no start/end is specified, then the buttons will be added to the first <ion-buttons> found in the header.

You can use the [hidden] input to hide all the inner buttons if a certain condition is met.

Example usage:
<code php>
<core-navbar-buttons end>
<button ion-button icon-only (click)="action()">
<ion-icon name="funnel"></ion-icon>
</button>
</core-navbar-buttons>
</code>

===Specific component and directives for plugins===

These are component and directives created specifically for supporting Moodle plugins.

====core-site-plugins-new-content====

Directive to display a new content when clicked. This new content can be displayed in a new page or in the current page (only if the current page is already displaying a site plugin content).

Data that can be passed to the directive:

* '''component''' (string): The component of the new content.
* '''method''' (string): The method to get the new content.
* '''args''' (object): The params to get the new content.
* '''title''' (string): The title to display with the new content. Only if samePage=false.
* '''samePage''' (boolean): Whether to display the content in same page or open a new one. Defaults to new page.
* '''useOtherData''' (any): Whether to include ''otherdata'' (from the ''get_content'' WS call) in the args for the new ''get_content'' call. The format is the same as in ''useOtherDataForWS''. If not supplied, no other data will be added. If supplied but empty (null, false or empty string) all the ''otherdata'' will be added. If it’s an array, it will only copy the properties whose names are in the array.
* '''form''' (string): ID or name to identify a form in the template. The form will be obtained from ''document.forms''. If supplied and form is found, the form data will be retrieved and sent to the new ''get_content'' WS call. If your form contains an ion-radio, ion-checkbox or ion-select, please see [[Mobile_support_for_plugins##Values_of_ion-radio.2C_ion-checkbox_or_ion-select_aren.27t_sent_to_my_WS|Values of ion-radio, ion-checkbox or ion-select aren't sent to my WS]].

Example usages:

A button to go to a new content page:
<code php>
<button ion-button core-site-plugins-new-content title="<% certificate.name %>" component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}">
{{ 'plugin.mod_certificate.viewissued' | translate }}
</button>
</code>

A button to load new content in current page using userid from otherdata:
<code php>
<button ion-button core-site-plugins-new-content component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}" samePage="true" [useOtherData]="['userid']">
{{ 'plugin.mod_certificate.viewissued' | translate }}
</button>
</code>

====core-site-plugins-call-ws====

Directive to call a WS when the element is clicked. The action to do when the WS call is successful depends on the provided data: display a message, go back or refresh current view.

If you want to load a new content when the WS call is done, please see core-site-plugins-call-ws-new-content.

Data that can be passed to the directive:

* '''name''' (string): The name of the WS to call.
* '''params''' (object): The params for the WS call.
* preSets (object): Extra options for the WS call: whether to use cache or not, etc.
* '''useOtherDataForWS''' (any): Whether to include ''otherdata'' (from the ''get_content'' WS call) in the params for the WS call. If not supplied, no other data will be added. If supplied but empty (null, false or empty string) all the ''otherdata'' will be added. If it’s an array, it will only copy the properties whose names are in the array.
* '''form''' (string): ID or name to identify a form in the template. The form will be obtained from ''document.forms''. If supplied and form is found, the form data will be retrieved and sent to the WS. If your form contains an ion-radio, ion-checkbox or ion-select, please see [[Mobile_support_for_plugins##Values_of_ion-radio.2C_ion-checkbox_or_ion-select_aren.27t_sent_to_my_WS|Values of ion-radio, ion-checkbox or ion-select aren't sent to my WS]].
* '''confirmMessage''' (string): Message to confirm the action when the user clicks the element. If not supplied, no confirmation. If supplied but empty, default message ("Are you sure?").
* '''successMessage''' (string): Message to show on success. If not supplied, no message. If supplied but empty, default message (“Success”).
* '''goBackOnSuccess''' (boolean): Whether to go back if the WS call is successful.
* '''refreshOnSuccess''' (boolean): Whether to refresh the current view if the WS call is successful.

Example usages:

A button to send some data to the server without using cache, displaying default messages and refreshing on success:
<code php>
<button ion-button core-site-plugins-call-ws name="mod_certificate_view_certificate" [params]="{certificateid: <% certificate.id %>}" [preSets]="{getFromCache: 0, saveToCache: 0}" confirmMessage successMessage refreshOnSuccess="true">
{{ 'plugin.mod_certificate.senddata' | translate }}
</button>
</code>

A button to send some data to the server using cache without confirming, going back on success and using userid from otherdata:
<code php>
<button ion-button core-site-plugins-call-ws name="mod_certificate_view_certificate" [params]="{certificateid: <% certificate.id %>}" goBackOnSuccess="true" [useOtherData]="['userid']">
{{ 'plugin.mod_certificate.senddata' | translate }}
</button>
</code>

====core-site-plugins-call-ws-new-content====

Directive to call a WS when the element is clicked and load a new content passing the WS result as args. This new content can be displayed in a new page or in the same page (only if current page is already displaying a site plugin content).

If you don't need to load some new content when done, please see core-site-plugins-call-ws.

Data that can be passed to the directive:

* '''name''' (string): The name of the WS to call.
* '''params''' (object): The params for the WS call.
* '''preSets''' (object): Extra options for the WS call: whether to use cache or not, etc.
* '''useOtherDataForWS''' (any): Whether to include ''otherdata'' (from the ''get_content'' WS call) in the params for the WS call. If not supplied, no other data will be added. If supplied but empty (null, false or empty string) all the ''otherdata'' will be added. If it’s an array, it will only copy the properties whose names are in the array.
* '''form''' (string): ID or name to identify a form in the template. The form will be obtained from ''document.forms''. If supplied and form is found, the form data will be retrieved and sent to the WS. If your form contains an ion-radio, ion-checkbox or ion-select, please see [[Mobile_support_for_plugins##Values_of_ion-radio.2C_ion-checkbox_or_ion-select_aren.27t_sent_to_my_WS|Values of ion-radio, ion-checkbox or ion-select aren't sent to my WS]].
* '''confirmMessage''' (string): Message to confirm the action when the user clicks the element. If not supplied, no confirmation. If supplied but empty, default message ("Are you sure?").
* '''component''' (string): The component of the new content.
* '''method''' (string): The method to get the new content.
* '''args''' (object): The params to get the new content.
* '''title''' (string): The title to display with the new content. Only if samePage=false.
* '''samePage''' (boolean): Whether to display the content in same page or open a new one. Defaults to new page.
* '''useOtherData''' (any): Whether to include ''otherdata'' (from the ''get_content'' WS call) in the args for the new ''get_content'' call. The format is the same as in ''useOtherDataForWS''.

Example usages:

A button to get some data from the server without using cache, showing default confirm and displaying a new page:
<code php>
<button ion-button core-site-plugins-call-ws-new-content name="mod_certificate_get_issued_certificates" [params]="{certificateid: <% certificate.id %>}" [preSets]="{getFromCache: 0, saveToCache: 0}" confirmMessage title="<% certificate.name %>" component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}">
{{ 'plugin.mod_certificate.getissued' | translate }}
</button>
</code>

A button to get some data from the server using cache, without confirm, displaying new content in same page and using ''userid'' from ''otherdata'':
<code php>
<button ion-button core-site-plugins-call-ws-new-content name="mod_certificate_get_issued_certificates" [params]="{certificateid: <% certificate.id %>}" component="mod_certificate" method="mobile_issues_view" [args]="{cmid: <% cmid %>, courseid: <% courseid %>}" samePage="true" [useOtherData]="['userid']">
{{ 'plugin.mod_certificate.getissued' | translate }}
</button>
</code>

====core-site-plugins-call-ws-on-load====

Directive to call a WS as soon as the template is loaded. This directive is meant for actions to do in the background, like calling logging Web Services.

If you want to call a WS when the user clicks on a certain element, please see core-site-plugins-call-ws.

* '''name''' (string): The name of the WS to call.
* '''params''' (object): The params for the WS call.
* '''preSets''' (object): Extra options for the WS call: whether to use cache or not, etc.
* '''useOtherDataForWS''' (any): Whether to include ''otherdata'' (from the ''get_content'' WS call) in the params for the WS call. If not supplied, no other data will be added. If supplied but empty (null, false or empty string) all the ''otherdata'' will be added. If it’s an array, it will only copy the properties whose names are in the array.
* '''form''' (string): ID or name to identify a form in the template. The form will be obtained from ''document.forms''. If supplied and form is found, the form data will be retrieved and sent to the WS. If your form contains an ion-radio, ion-checkbox or ion-select, please see [[Mobile_support_for_plugins##Values_of_ion-radio.2C_ion-checkbox_or_ion-select_aren.27t_sent_to_my_WS|Values of ion-radio, ion-checkbox or ion-select aren't sent to my WS]].

Example usage:
<code php>
<span core-site-plugins-call-ws-on-load name="mod_certificate_view_certificate" [params]="{certificateid: <% certificate.id %>}" [preSets]="{getFromCache: 0, saveToCache: 0}"></span>
</code>

==Advanced features==

===Display the plugin only if certain conditions are met===

You might want to display your plugin in the mobile app only if certain dynamic conditions are met, so the plugin would be displayed only for some users. This can be achieved using the "init" method (for more info, please see the [[Mobile_support_for_plugins#Initialization|Initialization]] section ahead).

All the init methods are called as soon as your plugin is retrieved. If you don't want your plugin to be displayed for the current user, then you should return an exception in this init method. It's recommended to include a message explaining why the plugin isn't available for the current user, this exception will be logged in the Javascript console.

On the other hand, you might want to display a plugin only for certain courses (''CoreCourseOptionsDelegate'') or only if the user is viewing certain users' profiles (''CoreUserDelegate''). This can be achieved with the init method too.

In the init method you can return a "restrict" property with two fields in it: ''courses'' and ''users''. If you return a list of courses IDs in this restrict property, then your plugin will only be displayed when the user views any of those courses. In the same way, if you return a list of user IDs then your plugin will only be displayed when the user views any of those users' profiles.

===Using “otherdata”===

The values returned by the functions in otherdata are added to a variable so they can be used both in Javascript and in templates. The otherdata returned by a init call is added to a variable named INIT_OTHERDATA, while the otherdata returned by a ''get_content'' WS call is added to a variable named CONTENT_OTHERDATA.

The otherdata returned by a init call will be passed to the JS and template of all the get_content calls in that handler. The otherdata returned by a get_content call will only be passed to the JS and template returned by that get_content call.

This means that, in your Javascript, you can access and use these data like this:
<code php>
this.CONTENT_OTHERDATA.myVar
</code>
And in the template you could use it like this:
<code php>
{{ CONTENT_OTHERDATA.myVar }}
</code>
''myVar'' is the name we put to one of our variables, it can be the name you want. In the example above, this is the otherdata returned by the PHP method:

array('myVar' => 'Initial value')

====Example====

In our plugin we want to display an input text with a certain initial value. When the user clicks a button, we want the value in the input to be sent to a certain WebService. This can be done using otherdata.

We will return the initial value of the input in the otherdata of our PHP method:
<code php>
'otherdata' => array('myVar' => 'My initial value'),
</code>
Then in the template we will use it like this:
<code php>
<ion-item text-wrap>
<ion-label stacked>{{ 'plugin.mod_certificate.textlabel | translate }}</ion-label>
<ion-input type="text" [(ngModel)]="CONTENT_OTHERDATA.myVar"></ion-input>
</ion-item>
<ion-item>
<button ion-button block color="light" core-site-plugins-call-ws name="mod_certificate_my_webservice" [useOtherDataForWS]="['myVar']">
{{ 'plugin.mod_certificate.send | translate }}
</button>
</ion-item>
</code>

In the example above, we are creating an input text and we use ''[(ngModel)]'' to use the value in ''myVar'' as the initial value and to store the changes in the same ''myVar'' variable. This means that the initial value of the input will be “My initial value”, and if the user changes the value of the input these changes will be applied to the ''myVar'' variable. This is called 2-way data binding in Angular.

Then we add a button to send this data to a WS, and for that we use the directive core-site-plugins-call-ws. We use the ''useOtherDataForWS'' attribute to specify which variable from ''otherdata'' we want to send to our WebService. So if the user enters “A new value” in the input and then clicks the button, it will call the WebService ''mod_certificate_my_webservice'' and will send as a param: myVar -> “A new value”.

We can achieve the same result using the ''params'' attribute of the core-site-plugins-call-ws directive instead of using ''useOtherDataForWS'':
<code php>
<button ion-button block color="light" core-site-plugins-call-ws name="mod_certificate_my_webservice" [params]="{myVar: CONTENT_OTHERDATA.myVar}">
{{ 'plugin.mod_certificate.send | translate }}
</button>
</code>
The WebService call will be exactly the same with both buttons.

Please notice that this example could be done without using otherdata too, using the “''form''” input of the ''core-site-plugins-call-ws directive''.

===JS functions visible in the templates===

The app provides some Javascript functions that can be used from the templates to update, refresh or view content. These are the functions:

* '''openContent(title: string, args: any, component?: string, method?: string)''': Open a new page to display some new content. You need to specify the ''title'' of the new page and the ''args'' to send to the method. If ''component'' and ''method'' aren't provided, it will use the same as in the current page.
* '''refreshContent(showSpinner = true)''': Refresh the current content. By default it will display a spinner while refreshing, if you don't want it to be displayed you should pass false as a parameter.
* '''updateContent(args: any, component?: string, method?: string)''': Refresh the current content using different params. You need to specify the ''args'' to send to the method. If ''component'' and ''method'' aren't provided, it will use the same as in the current page.

====Examples====

=====Group selector=====

Imagine we have an activity that uses groups and we want to let the user select which group he wants to see. A possible solution would be to return all the groups in the same template (hidden), and then show the group user selects. However, we can make it more dynamic and return only the group the user is requesting.

To do so, we'll use a drop down to select the group. When the user selects a group using this drop down we'll update the page content to display the new group.

The main difficulty in this is to tell the view which group needs to be selected when the view is loaded. There are 2 ways to do it: using plain HTML or using Angular's ''ngModel''.

======Using plain HTML======

We need to add a "''selected''" attribute to the option that needs to be selected. To do so, we need to pre-caclulate the selected option in the PHP code:

<code php>
$groupid = empty($args->group) ? 0 : $args->group; // By default, group 0.
$groups = groups_get_activity_allowed_groups($cm, $user->id);
// Detect which group is selected.
foreach ($groups as $gid=>$group) {
$group->selected = $gid === $groupid;
}

$data = array(
'cmid' => $cm->id,
'courseid' => $args->courseid,
'groups' => $groups
);

return array(
'templates' => array(
array(
'id' => 'main',
'html' => $OUTPUT->render_from_template('mod_certificate/mobile_view_page', $data),
),
),
);
</code>

In the code above, we're retrieving the groups the user can see and then we're adding a "selected" bool to each one to determine which one needs to be selected in the drop down. Finally, we pass the list of groups to the template.

In the template, we display the drop down like this:

<code php>
<ion-select (ionChange)="updateContent({cmid: <% cmid %>, courseid: <% courseid %>, group: $event})" interface="popover">
<%#groups%>
<ion-option value="<% id %>" <%#selected%>selected<%/selected%> ><% name %></ion-option>
<%/groups%>
</ion-select>
</code>

The ''ionChange'' function will be called everytime the user selects a different group with the drop down. We're using the function ''updateContent'' to update the current view using the new group. ''$event'' is an Angular variable that will have the selected value (in our case, the group ID that was just selected). This is enough to make the group selector work.

======Using ngModel======

ngModel is an Angular directive that allows storing the value of a certain input/select in a Javascript variable, and also the opposite way: tell the input/select which value to set. The main problem is that we cannot initialize a Javascript variable from the template (Angular doesn't have ''ng-init'' like in AngularJS), so we'll use "otherdata".

In the PHP function we'll return the group that needs to be selected in the ''otherdata'' array:

<code php>
$groupid = empty($args->group) ? 0 : $args->group; // By default, group 0.
$groups = groups_get_activity_allowed_groups($cm, $user->id);

...

return array(
'templates' => array(
array(
'id' => 'main',
'html' => $OUTPUT->render_from_template('mod_certificate/mobile_view_page', $data),
),
),
'otherdata' => array(
'group' => $groupid
),
);
</code>

In the example above we don't need to iterate over the groups array like in the plain HTML example. However, now we're returning the groupid in the "otherdata" array. As it's explained in the [[Mobile_support_for_plugins#Using_.E2.80.9Cotherdata.E2.80.9D|Using "otherdata"]] section, this "otherdata" is visible in the templates inside a variable named ''CONTENT_OTHERDATA''. So in the template we'll use this variable like this:

<code php>
<ion-select [(ngModel)]="CONTENT_OTHERDATA.group" (ionChange)="updateContent({cmid: <% cmid %>, courseid: <% courseid %>, group: CONTENT_OTHERDATA.group})" interface="popover">
<%#groups%>
<ion-option value="<% id %>"><% name %></ion-option>
<%/groups%>
</ion-select>
</code>

===Initialization===

All handlers can specify a “''init''” method in the mobile.php file. This method is meant to return some JavaScript code that needs to be executed as soon as the plugin is retrieved.

When the app retrieves all the handlers, the first thing it will do is call the ''tool_mobile_get_content'' WebService with the init method. This WS call will only receive the default args.

The app will immediately execute the JavaScript code returned by this WS call. This JavaScript can be used to manually register your handlers in the delegates you want, without having to rely on the default handlers built based on the mobile.php data.

The templates returned by this init method will be added to a INIT_TEMPLATES variable that will be passed to all the Javascript code of that handler. This means that the Javascript returned by the init method or the “main” method can access any of the templates HTML like this:
<code javascript>
this.INIT_TEMPLATES[‘main’];
</code>
In this case, “main” is the ID of the template we want to use.

The same happens with the ''otherdata'' returned by this init method, it is added to a INIT_OTHERDATA variable.

The ''restrict'' field returned by this init call will be used to determine if your handler is enabled or not. For example, if your handler is for the delegate ''CoreCourseOptionsDelegate'' and you return a list of courseids in restrict->courses, then your handler will only be enabled in the courses you returned. This only applies to the “default” handlers, if you register your own handler using the Javascript code then you should check yourself if the handler is enabled.

Finally, if you return an object in this init Javascript code, all the properties of that object will be passed to all the Javascript code of that handler so you can use them when the code is run. For example, if your init Javascript code does something like this:
<code javascript>
var result = {
MyAddonClass: new MyAddonClass()
};
result:
</code>
Then, for the rest of Javascript code of your handler (e.g. for the “main” method) you can use this variable like this:
<code javascript>
this.MyAddonClass
</code>

====Examples====

=====Module link handler=====

A link handler allows you to decide what to do when a link with a certain URL is clicked. This is useful, for example, to open your module when a link to the module is clicked. In this example we’ll create a link handler to detect links to a certificate module using a init JavaScript:
<code javascript>
var that = this;

function AddonModCertificateModuleLinkHandler() {
that.CoreContentLinksModuleIndexHandler.call(this, that.CoreCourseHelperProvider, 'mmaModCertificate', 'certificate');

this.name = "AddonModCertificateLinkHandler";
}

AddonModCertificateModuleLinkHandler.prototype = Object.create(this.CoreContentLinksModuleIndexHandler.prototype);
AddonModCertificateModuleLinkHandler.prototype.constructor = AddonModCertificateModuleLinkHandler;

this.CoreContentLinksDelegate.registerHandler(new AddonModCertificateModuleLinkHandler());
</code>

=====Module prefetch handler=====

The ''CoreCourseModuleDelegate'' handler allows you to define a list of ''offlinefunctions'' to prefetch a module. However, you might want to create your own prefetch handler to determine what needs to be downloaded. For example, you might need to chain WS calls (pass the result of a WS call to the next one), and this cannot be done using ''offlinefunctions''.

Here’s an example on how to create a prefetch handler using init JS:
<code javascript>
var that = this;

function AddonModCertificateModulePrefetchHandler() {
that.CoreCourseModulePrefetchHandlerBase.call(this, that.injector);

this.name = "certificate";
this.component = "mmaModCertificate";
this.updatesNames = /^configuration$|^.*files$/;
}

AddonModCertificateModulePrefetchHandler.prototype = Object.create(this.CoreCourseModulePrefetchHandlerBase.prototype);
AddonModCertificateModulePrefetchHandler.prototype.constructor = AddonModCertificateModulePrefetchHandler;

AddonModCertificateModulePrefetchHandler.prototype.downloadOrPrefetch = function(module, courseId, prefetch, dirPath) {

var promises = [];

promises.push(that.CoreCourseModulePrefetchHandlerBase.prototype.downloadOrPrefetch.call(this, module, courseId, prefetch, dirPath));

promises.push(that.sitesProvider.getCurrentSite().read("mod_certificate_get_certificates_by_courses", {courseids: [courseId]}));

return Promise.all(promises);
};

this.CoreCourseModulePrefetchDelegate.registerHandler(new AddonModCertificateModulePrefetchHandler());
</code>

=====Single activity course format=====

In the following example, the value of INIT_TEMPLATES["main"] is:

<core-dynamic-component [component]="componentClass" [data]="data"></core-dynamic-component>

This template is returned by the init method. And this is the JavaScript code returned by the init method:
<code javascript>
var that = this;

function getAddonSingleActivityFormatComponent() {
function AddonSingleActivityFormatComponent() {
this.data = {};
};
AddonSingleActivityFormatComponent.prototype.constructor = AddonSingleActivityFormatComponent;
AddonSingleActivityFormatComponent.prototype.ngOnChanges = function(changes) {
var self = this;

if (this.course && this.sections && this.sections.length) {
var module = this.sections[0] && this.sections[0].modules && this.sections[0].modules[0];
if (module && !this.componentClass) {
that.CoreCourseModuleDelegate.getMainComponent(that.Injector, this.course, module).then((component) => {
self.componentClass = component || that.CoreCourseUnsupportedModuleComponent;
});
}

this.data.courseId = this.course.id;
this.data.module = module;
}
};
AddonSingleActivityFormatComponent.prototype.doRefresh = function(refresher, done) {
return Promise.resolve(this.dynamicComponent.callComponentFunction("doRefresh", [refresher, done]));
};

return AddonSingleActivityFormatComponent;
};

function AddonSingleActivityFormatHandler() {
this.name = "singleactivity";
};

AddonSingleActivityFormatHandler.prototype.constructor = AddonSingleActivityFormatHandler;

AddonSingleActivityFormatHandler.prototype.isEnabled = function() {
return true;
};

AddonSingleActivityFormatHandler.prototype.canViewAllSections = function(course) {
return false;
};

AddonSingleActivityFormatHandler.prototype.getCourseTitle = function(course, sections) {
if (sections && sections[0] && sections[0].modules && sections[0].modules[0]) {
return sections[0].modules[0].name;
}

return course.fullname || "";
};

AddonSingleActivityFormatHandler.prototype.displayEnableDownload = function(course) {
return false;
};

AddonSingleActivityFormatHandler.prototype.displaySectionSelector = function(course) {
return false;
};

AddonSingleActivityFormatHandler.prototype.getCourseFormatComponent = function(injector, course) {
that.Injector = injector || that.Injector;

return that.CoreCompileProvider.instantiateDynamicComponent(that.INIT_TEMPLATES["main"], getAddonSingleActivityFormatComponent(), injector);
};

this.CoreCourseFormatDelegate.registerHandler(new AddonSingleActivityFormatHandler());
</code>

===Using the JavaScript API===

The Javascript API is partly supported right now, only the ''CoreUserProfileFieldDelegate'' supports it now. This API allows you to override any of the functions of the default handler.

The “method” specified in a handler registered in the ''CoreUserProfileFieldDelegate'' will be called immediately after the init method, and the Javascript returned by this method will be run. If this Javascript code returns an object with certain functions, these function will override the ones in the default handler.

For example, if the Javascript returned by the method returns something like this:

<code javascript>
var result = {
getData: function(field, signup, registerAuth, formValues) {
}
};
result;
</code>

The the ''getData'' function of the default handler will be overridden by the returned getData function.

The default handler for ''CoreUserProfileFieldDelegate'' only has 2 functions: ''getComponent'' and ''getData''. In addition, the JavaScript code can return an extra function named ''componentInit'' that will be executed when the component returned by ''getComponent'' is initialized.

Here’s an example on how to support the text user profile field using this API:

<code javascript>
var that = this;

var result = {
componentInit: function() {
if (this.field && this.edit && this.form) {
this.field.modelName = "profile_field_" + this.field.shortname;

if (this.field.param2) {
this.field.maxlength = parseInt(this.field.param2, 10) || "";
}

this.field.inputType = that.CoreUtilsProvider.isTrueOrOne(this.field.param3) ? "password" : "text";

var formData = {
value: this.field.defaultdata,
disabled: this.disabled
};

this.form.addControl(this.field.modelName, that.FormBuilder.control(formData, this.field.required && !this.field.locked ? that.Validators.required : null));
}
},
getData: function(field, signup, registerAuth, formValues) {
var name = "profile_field_" + field.shortname;

return {
type: "text",
name: name,
value: that.CoreTextUtilsProvider.cleanTags(formValues[name])
};
}
};

result;
</code>

==Troubleshooting==

=== Invalid response received ===

You might receive this error when using the "core-site-plugins-call-ws" directive or similar. By default, the app expects all WebService calls to return an object, if your WebService returns another type (string, bool, ...) then you need to specify it using the preSets attribute of the directive. For example, if your WS returns a boolean value, then you should specify it like this:

[preSets]="{typeExpected: 'boolean'}"

In a similar way, if your WebService returns null you need to tell the app not to expect any result using the preSets:

[preSets]="{responseExpected: false}"

=== Values of ion-radio, ion-checkbox or ion-select aren't sent to my WS ===

Some directives allow you to specify a form id or name to send the data from the form to a certain WS. These directives look for HTML inputs to retrieve the data to send. However, ion-radio, ion-checkbox and ion-select don't use HTML inputs, they simulate them, so the directive isn't going to find their data and so it won't be sent to the WebService.

There are 2 workarounds to fix this problem. It seems that the next major release of Ionic framework does use HTML inputs, so these are temporary solutions.

==== Sending the data manually ====

The first solution is to send the missing params manually using the "''params''" property. We will use ''ngModel'' to store the input value in a variable, and this variable will be passed to the params. Please notice that ''ngModel'' '''requires''' the element to have a name, so if you add ''ngModel'' to a certain element you need to add a name too.

For example, if you have a template like this:

<code javascript>
<div radio-group name="responses">
<ion-item>
<ion-label>First value</ion-label>
<ion-radio value="1"></ion-radio>
</ion-item>
</div>

<button ion-button block type="submit" core-site-plugins-call-ws name="myws" [params]="{id: <% id %>}" form="myform">
{{ 'plugin.mycomponent.save' | translate }}
</button>
</code>

Then you should modify it like this:

<code javascript>
<div radio-group name="responses" [(ngModel)]="responses">
<ion-item>
<ion-label>First value</ion-label>
<ion-radio value="1"></ion-radio>
</ion-item>
</div>

<button ion-button block type="submit" core-site-plugins-call-ws name="myws" [params]="{id: <% id %>, responses: responses}" form="myform">
{{ 'plugin.mycomponent.save' | translate }}
</button>
</code>

Basically, you need to add ''ngModel'' to the affected element (in this case, the ''radio-group''). You can put whatever name you want as the value, we used "responses". With this, everytime the user selects a radio button the value will be stored in a variable named "responses". Then, in the button we are passing this variable to the params of the WebService.

Please notice that the "form" attribute has priority over "params", so if you have an input with name="responses" it will override what you're manually passing to params.

==== Using a hidden input ====

Since the directive is looking for HTML inputs, you need to add one with the value to send to the server. You can use ''ngModel'' to synchronize your ion-radio/ion-checkbox/ion-select with the new hidden input. Please notice that ''ngModel'' '''requires''' the element to have a name, so if you add ''ngModel'' to a certain element you need to add a name too.

For example, if you have a radio button like this:

<code javascript>
<div radio-group name="responses">
<ion-item>
<ion-label>First value</ion-label>
<ion-radio value="1"></ion-radio>
</ion-item>
</div>
</code>

Then you should modify it like this:

<code javascript>
<div radio-group name="responses" [(ngModel)]="responses">
<ion-item>
<ion-label>First value</ion-label>
<ion-radio value="1"></ion-radio>
</ion-item>

<ion-input type="hidden" [ngModel]="responses" name="responses"></ion-input>
</div>
</code>

In the example above, we're using a variable named "responses" to synchronize the data between the ''radio-group'' and the hidden input. You can use whatever name you want.

=== I can't return an object or array in otherdata ===

If you try to return an object or an array in any field inside ''otherdata'', the WebService call will fail with the following error:

''Scalar type expected, array or object received''

Each field in ''otherdata'' must be a string, number or boolean, it cannot be an object or array. To make it work, you need to encode your object or array into a JSON string:

<code php>
'otherdata' => array('data' => json_encode($data))</code>

The app will automatically parse this JSON and convert it back into an array or object.

==Examples==

===Accepting dynamic names in a WebService===

We want to display a form where the names of the fields are dynamic, like it happens in quiz. This data will be sent to a new WebService that we have created.

The first issue we find is that the WebService needs to define the names of the parameters received, but in this case they're dynamic. The solution is to accept an array of objects with name and value. So in the ''_parameters()'' function of our new WebService, we will add this parameter:

<code php>
'data' => new external_multiple_structure(
new external_single_structure(
array(
'name' => new external_value(PARAM_RAW, 'data name'),
'value' => new external_value(PARAM_RAW, 'data value'),
)
),
'The data to be saved', VALUE_DEFAULT, array()
)</code>

Now we need to adapt our form to send the data as the WebService requires it. In our template, we have a button with the directive ''core-site-plugins-call-ws'' that will send the form data to our WebService. To make this work we will have to pass the parameters manually, without using the "''form''" attribute, because we need to format the data before it is sent.

Since we will send the params manually and we want it all to be sent in the same array, we will use ''ngModel'' to store the input data into a variable that we'll call "data", but you can use the name you want. This "data" will be an object that will hold the input data with the format "name->value". For example, if I have an input with name "a1" and value "My answer", the data object will be:

{a1: "My answer"}

So we need to add ''ngModel'' to all the inputs whose values need to be sent to the "data" WS param. Please notice that ''ngModel'' '''requires''' the element to have a name, so if you add ''ngModel'' to a certain element you need to add a name too. For example:

<code javascript><ion-input name="<% name %>" [(ngModel)]="CONTENT_OTHERDATA.data['<% name %>']"></code>

As you can see, we're using ''CONTENT_OTHERDATA'' to store the data. We do it like this because we'll use ''otherdata'' to initialize the form, setting the values the user has already stored. If you don't need to initialize the form, then you can use the variable "dataObject", an empty object that the Mobile app creates for you: [(ngModel)]="dataObject['<% name %>']"

The Mobile app has a function that allows you to convert this data object into an array like the one the WS expects: ''objectToArrayOfObjects''. So in our button we'll use this function to format the data before it's sent:

<code javascript>
<button ion-button block type="submit" core-site-plugins-call-ws name="my_ws_name"
[params]="{id: <% id %>, data: CoreUtilsProvider.objectToArrayOfObjects(CONTENT_OTHERDATA.data, 'name', 'value')}"
successMessage
refreshOnSuccess="true">
</code>

As you can see in the example above, we're specifying that the keys of the "data" object need to be stored in a property named "name", and the values need to be stored in a property named "value". If your WebService expects different names you need to change the parameters of the function ''objectToArrayOfObjects''.

If you open your plugin now in the Mobile app it will display an error in the Javascript console. The reason is that the variable "data" doesn't exist inside ''CONTENT_OTHERDATA''. As it is explained in previous sections, ''CONTENT_OTHERDATA'' holds the data that you return in ''otherdata'' for your method. We'll use ''otherdata'' to initialize the values to be displayed in the form.

If the user hasn't answered the form yet, we can initialize the "data" object as an empty object. Please remember that we cannot return arrays or objects in ''otherdata'', so we'll return a JSON string.

<code php>
'otherdata' => array('data' => '{}')</code>

With the code above, the form will always be empty when the user opens it. But now we want to check if the user has already answered the form and fill the form with the previous values. We will do it like this:

<code php>
$userdata = get_user_responses(); // It will held the data in a format name->value. Example: array('a1' => 'My value').
...
'otherdata' => array('data' => json_encode($userdata))
</code>

Now the user will be able to see previous values when the form is opened, and clicking the button will send the data to our WebService in array format.

[[Category:Mobile]]

Moodle App Release Process

2018-06-12T14:03:34Z

Fox: Typos

== 4-7 days before (when possible) ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Create an issue in the tracker for the release, like: MOBILE-1248
| Integration Lead
|-
| 2.
| Update the local_moodlemobileapp plugin with new strings in moodle.org/plugins (only for Moodle version 2.6). Use the moodlemobile-scripts/json-to-string2.php to convert the build lang file to a valid string file.
| Integration Lead
|-
| 3.
| Ask someone from sites or community team to review the new english strings.
| Community or Sites team
|-
| 4.
| Announce in the moodletranslation forums the new strings available: https://lang.moodle.org/mod/forum/view.php?id=5. This will allow translators to add the new strings during the days prior to the release.
| Integration Lead
|-
| 5.
| Add the release notes in the release issue created (search for the [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20labels%20%3D%20release_notes release_notes tag]). Ask someone from the documentation team or Martin to review the release notes.
| Integration Lead
|-
| 6.
| Contact the marketing announcing the new release and highlights.
| Integration Lead
|}

== 7 days before (testing days) ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Create a new local branch (based on moodlehq/moodlemobile2:integration) with the release tracker issue number for integrating all the version and string changes.
| Integration Lead
|-
| 2.
| Run gulp and then execute detect-string-core-changes.php and auto-translate strings with the script auto-translate2.php, commiting the results.
| Integration Lead
|-
| 3.
| Run gulp and update language strings from AMOS using the fetch-langpacks2.sh script, commit the result.
| Integration Lead
|-
| 4.
| Bump version numbers in config.xml, www/config.json, package.json, desktop/assets/windows/AppXManifest.xml and in www/errorreport.js (is hardcoded there).
Push all this changes using the release issue number and integrate them into the integration branch.
| Integration Lead
|-
| 5.
| Execute the prepare-release-integration.sh script to update the moodlehq/moodlemobile-phonegap build:integration branch with a built version of the app ready for PhonegapBuild.
Push all this changes to moodlehq/moodlemobile-phonegapbuild:integration.
| Integration Lead
|-
| 6.
| Bump version numbers in moodlehq/moodlemobile-phonegapbuild:integration/config.xml and push the changes.
| Integration Lead
|-
| 7.
| Create a build in Phonegap Build using the Development certificate for iOs and the production keystore for Android pointing to moodlehq/moodlemobile-phonegap build:integration
And '''Start testing'''
| All the team
|}

== 1 day before ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Backport to local_mobile (all branches) all the new required Web Services by new features.
Check if existing Web Services should be added to the local_mobile service (because they were added to the Mobile app service).

Once all the Web Services are backported and tested, publish a new version in the plugins database (via TAGS) so admin can updates their sites.
| Integration Lead
|}

== The release day ==

{| class="table table-striped table-bordered"
|-
! style="width:20px" | #
! Task
! style="width:12%" | Responsibility
|-
| 1.
| Integrate the [https://github.com/moodlehq/moodlemobile2/compare/master...integration integration branch onto the master one]. Execute the prepare-release-version.sh script.
| Integration Lead
|-
| 2.
| Bump the versions in the config.xml file and then PUSH the master branch of the moodlemobile-phonegapbuild repository.
| Integration Lead
|-
| 3.
| Build the app for Android and iOs using the Distribution certificate. Remember to do two different builds (pointing to the ios and android branches).
| Integration Lead
|-
| 4.
| Send the applications to the stores for review. Update the download.php for desktop apps (including new version number).
| Integration Lead
|-
| 5.
| Update release notes [[Moodle_Mobile_Release_Notes]] and [[Moodle_Desktop_release_notes]] with the notes reviewed in the issue.
| Integration Lead
|-
| 6.
| Create a TAG/Release in github ([https://github.com/moodlehq/moodlemobile2/releases moodlehq/moodlemobile2]) with the version number.
| Integration Lead
|-
| 7.
| Update the [https://moodle.org/plugins/view/local_mobile local mobile plugin] short description to indicate which is the latest Moodle Mobile version supported and date.
| Integration Lead
|-
| 8.
| Mark the issue and the [https://tracker.moodle.org/projects/MOBILE?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page version] as released in the tracker.
| Integration Lead
|-
| 9.
| Social media announcements (Forum and Twitter).
| All the team & Marketing team
|-
| 10.
| Post in moodle.org/news.
| Team Lead
|-
| 11.
| Review the users and developers documentation (check that everything is in order). Review the [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE%20AND%20labels%20in%20%28docs_required%2C%20dev_docs_required%29 docs_required and dev_docs_required_tags]. Review the [https://docs.moodle.org/en/Moodle_Mobile_features Mobile features wiki documentation].
| All the team
|-
| 12.
| Provide the APK file for including in [https://download.moodle.org/mobile/ Moodle downloads: Moodle mobile].
| Integration Lead
|}

[[Category:Processes]]
[[Category:Mobile]]

Moodle 3.4.3 release notes

2018-05-16T09:13:00Z

Fox: Correct language links

[[Releases]] > {{FULLPAGENAME}}

Release date: 14 May 2018 (Not yet released)

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.4.3%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.4.3].

===GDPR preparation===

Plugins are available for Moodle 3.3 and 3.4 to help Moodle sites to comply with GDPR - [https://moodle.org/plugins/tool_dataprivacy Data privacy], [https://moodle.org/plugins/tool_policy Policies]. In Moodle 3.5 they will be included in the standard distribution. Work on changes in core is almost completed, the new minor release with the remaining components will follow in several days.
* MDL-61306 - Implement privacy API in various components and standard plugins for user data export and deletion

===Fixes and improvements===

* MDL-58697 - Assignment: Fixed incorrect "No submission" status if group submission changed to individual submission
* MDL-61724 - File resource: Fixed download problem for files with long names
* MDL-61519 - Performance improvement in Calendar in case of big number of course categories
* MDL-55532 - Show grade category name in Grades Export
* MDL-61714 - GDPR and privacy: Change default age of digital consent according to current legislation on each country
* MDL-52989 - Lesson: Fixed regression in cluster navigation
* MDL-61183 - Display participants count on course participants page
* MDL-60196 - Display custom external tool icon in activity chooser
* MDL-61736 - Show self enroled user as inactive when self enrolement method is disabled
* MDL-61800 - A bug which led to the failure of some Scheduled Tasks in certain circmstances has been fixed.
* MDL-61733 - Database module: Fixed bug with creating tables in templates using Atto editor
* MDL-61348 - Quiz: Fixed a report bug where the count of the number of attempts is sometimes incorrect in group averages
* MDL-61520 - Quiz: Fixed a bug where the question text was no longer exported in the quiz statistics HTML download
* MDL-61950 - Quiz: Fixed a bug in the statistics report to display the chosen questions for random question slots
* MDL-62202 - GDPR: Moved the Privacy and policies administration section to the Users tab (when GDPR plugins are installed)
* MDL-62042 - Global search: Remove unicode non-characters from indexing to resolve indexing errors
* MDL-61827 - Facebook OAuth2: Update the Facebook Graph API to v2.12

===Security issues===

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.4.2 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.4]]

[[fr:Notes de mise à jour de Moodle 3.4.3]]
[[es:Notas de Moodle 3.4.3]]

Moodle 3.3.5 release notes

2018-03-23T12:05:01Z

Fox: Regression

[[Releases]] > {{FULLPAGENAME}}

Release date: 19 March 2018

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.3.5%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.3.5].

=== Highlights ===

* MDL-48501, MDL-61600 - Migrate to reCAPTCHA v2
* MDL-51189 - Quiz: now possible to edit user overrides even if quiz is not available to a student
* MDL-60241 - Invisible default sections lead to unexpected visibility layout
* MDL-61344 - Assignment: "additional files" are now shown in Edit Submission view

=== GDPR preparation ===

Plugins will be available for Moodle 3.3 and 3.4 to help Moodle sites to comply with GDPR. In Moodle 3.5 they will be included in the standard distribution. Some necessary core changes were already included in this release:

* MDL-61307 - New Privacy subsystem
* MDL-61477 - Allow plugins to handle site policies and overwrite $CFG->sitepolicy
* MDL-61423 - Signup process - add minimum age verification

=== Fixes and improvements ===

* MDL-58006 - Assignment: reset 'Blind marking' status during 'Course reset'
* MDL-58845 - Choice: hide "unanswered" column when it is set so in choice settings
* MDL-56688 - Single View & grades export should follow the same order set in gradebook set up
* MDL-61305 - Performance: Modinfo cache can get built in parallel
* MDL-61242 - EQUELLA repository: fixed error "The source url does not match the sourcekey."
* MDL-61175 - Change "Remind me to grade by" date according to the new course start date after course restore

===Security issues===

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

=== Regression ===

Regressions are problems created by the new version, that didn't exists in previous version.
* MDL-61723 - Courses with long "shortname" can't backup anymore

==See also==
*[[Moodle 3.3.4 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.3]]

[[fr:Notes de mise à jour de Moodle 3.3.5]]
[[es:Notas de Moodle 3.3.5]]

Moodle 3.4.2 release notes

2018-03-16T13:30:44Z

Fox: Links corrected (wrong version)

[[Releases]] > {{FULLPAGENAME}}

Release date: 19 March 2018 (Not yet released)

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.4.2%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.4.2].

=== Highlights ===

* MDL-48501, MDL-61600 - Migrate to reCAPTCHA v2
* MDL-51189 - Quiz: now possible to edit user overrides even if quiz is not available to a student
* MDL-60241 - Invisible default sections lead to unexpected visibility layout
* MDL-61344 - Assignment: "additional files" are now shown in Edit Submission view

=== GDPR preparation ===

Plugins will be available for Moodle 3.3 and 3.4 to help Moodle sites to comply with GDPR. In Moodle 3.5 they will be included in the standard distribution. Some necessary core changes were already included in this release:

* MDL-61307 - New Privacy subsystem
* MDL-61477 - Allow plugins to handle site policies and overwrite $CFG->sitepolicy
* MDL-61423 - Signup process - add minimum age verification

=== Fixes and improvements ===

* MDL-60815 - Fixed bug with loading CSS for editor
* MDL-61549 - Fixed bug with empty user name on Participants page if username is included in user identitfy fields
* MDL-60812 - Select correct default role during manual enrolment
* MDL-58006 - Assignment: reset 'Blind marking' status during 'Course reset'
* MDL-58845 - Choice: hide "unanswered" column when it is set so in choice settings
* MDL-56688 - Single View & grades export should follow the same order set in gradebook set up
* MDL-61305 - Performance: Modinfo cache can get built in parallel
* MDL-61249 - Corrected end date for manual enrolments
* MDL-61242 - EQUELLA repository: fixed error "The source url does not match the sourcekey."
* MDL-61175 - Change "Remind me to grade by" date according to the new course start date after course restore

===Security issues===

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.4.1 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.4]]

[[fr:Notes de mise à jour de Moodle 3.4.2]]
[[es:Notas de Moodle 3.4.2]]

Category:Moodle 3.5

2017-12-12T08:59:44Z

Fox: Creation of the category page

Pages that relate to the planning and development of Moodle 3.5 features.

[[fr:Catégorie:Moodle 3.5]]