MoodleDocs - User contributions [en]

Moodle 4.0 developer update

2022-03-30T11:56:33Z

Tusefomal: /* The course format system */

{{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.
== Navigation changes ==
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 ===
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.
==== Customising the primary navigation ====
Not yet implemented but we are looking at allowing the full addition and removal of any of the primary navigation tabs in the boost theme config file.
=== Secondary 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
==== Adding items to the navigation ====
The secondary navigation pulls information mainly from the settings navigation node from each context. Any plugin that implements the existing navigation hooks will have their items added to the secondary navigation.
Existing navigation hooks:
* {module}_extend_navigation
* {local}_extend_navigation
* {report}_report_extend_navigation
* {plugin}_extend_navigation_course
* {plugin}_extend_navigation_category_settings
==== Changing the order of tabs ====
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.
=== Tertiary navigation ===
We've moved action buttons to the top of the page. We would encourage you to do the same.
If you have any buttons on an activity page that go to another page, or open a form (or similar), then we encourage you to move them from the body of your activity page to the top. All of the core activities have been updated to follow this pattern. Please take a look to see how you can format your activity in a similar fashion. There is no API here. You are welcome to create the buttons and display them as you wish in this top area.
=== 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_secondarynav - Force override the secondary navigation class

* set_secondary_navigation - Sets the ‘_hassecondarynavigation’ and optionally the ‘_hastablistsecondarynavigation’ to indicate whether a page should render the secondary navigation, and if the secondary navigation should be rendered and behave with a tablist ARIA role (as opposed to its default which is being rendered with a menubar ARIA role).
==== 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
==== The activity header class ====
There is a new activity header class that handles the display of information common to activities. 3rd party activities are not required to explicitly output this information as part of rendering individual pages.

The common information that are currently handled by the class are:
* title
* description
* completion information

As part of the update it was required that the initial information to be displayed by the class be toggable at a theme and layout level. Taking this into account the following theme level configurable exists:
* activityheaderconfig => An array that currently only enforces 'notitle' but can be expanded in the future NOTE: Boost has this set as true by default 'options'
The following layout level options that can be defined:
* noactivityheader - to remove the header in this specific layout.
* activityheader - An array that enforces the following options:
** notitle
** nocompletion
** nodescription
The class has a page level getter which you can use to fetch the current version of the class. The base state is initialised within the constructor with the completion information only fetched when data is exported for the template.

The class has setters for the following variables which can be leveraged to modify the header for a particular page in the format set_{variable_name}:
* hidecompletion
* description
* title
Alternately, bulk operations can also be done by passing the above variables in an array to 'set_attrs' which in turn calls the setters.<blockquote>'''Note: Any updates to the activityheader needs to be performed before the call to $OUTPUT->header'''</blockquote>
===== Theme updates: =====
With the changes in boost to incorporate the primary and secondary navigation, 3rd party themes would need to account for the following in their templates:
* To leverage the activity_header, it's data needs to be exported and included into the base template :<syntaxhighlight lang="html">
{{#headercontent}}
{{> core/activity_header}}
{{#headercontent}}
</syntaxhighlight>** headercontent being the array element that contains the exported activity_header data
* It is recommended to transition towards the secondary/tertiary navigation hierarchy to reduce user cognitive load and with a logical separation of components
** Secondary navigation can be added to the templates by following the example https://github.com/moodle/moodle/blob/master/theme/boost/templates/columns2.mustache#L64-L68 This leverages the secondary navigation class to generate it's content.
* Flat navigation classes have been marked for deprecation. Themes that leverage the flat_navigation will need to make the following changes in their plugins in order to use it
** Account for the additional changes [[Moodle 4.0 developer update#Theme changes]]
** Indicate that they do not implement secondary navigation via the page's "set_secondary_navigation" function. It is recommended to set this within the root layout file e.g. columns2
** Initialise the flat navigation by introducing the following in the root layout file(if not existent)<syntaxhighlight lang="php">
$nav = $PAGE->flatnav;
$templatecontext['firstcollectionlabel'] = $nav->get_collectionlabel();
</syntaxhighlight>
* In order to reintroduce the settings cog in the templates, you can introduce the following: <syntaxhighlight>
<div id="region-main-settings-menu" class="d-print-none {{#hasblocks}}has-blocks{{/hasblocks}}">
<div> {{{ output.region_main_settings_menu }}} </div>
</div>
</syntaxhighlight>
===== Accessibility notes: =====
The jump to ‘maincontent’ div is now rendered within the activity header when within an activity context
== 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.

A hosted version of the Component Library can be found here. http://componentlibrary.moodle.com
=== 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.
=== 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.
== Theme changes ==
=== Edit switch ===
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.
=== Login page ===
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 ===
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 ===
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 ===
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, for the page header and main content area the borders will be removed.
=== New layout page ===
Theme boost now uses the drawers.php layout for the course index and blocks.
== Question bank changes ==
There was a big project to deliver [[Question bank improvements for Moodle 4.0]] which added a new plugin type for adding features to the question banks, tracking the version history for each question as it is edited (question table has been split into <code>question</code>, <code>question_versions</code> and <code>question_bank_entries</code>), and tracking where each question is going to be used, with new tables <code>question_references</code> and <code>question_set_references</code>. This work was done in Epic MDL-70329 if you want to track down the details of any of the core changes.
=== Question type plugins ===
Amazingly, we (Safat and colleagues at Catalyst AU) managed to implement this without breaking most question type plugins.

However, the changes to the question bank, and the other Moodle 4.0 changes, probably broke the Behat tests for your plugin. To help with fixing that, MDL-74130 adds navigation to key question type pages (Preview and Edit for a question, and standard question bank pages like the bank itself, import and export) which should let you fix your test efficiently, and in a way that will work in all Moodle versions since 3.9.

The 'most' in the first paragraph here is becuase more advance question types may require more effort to fix. (For example qtype_combined which creates multi-part qusetions like the core qtype_multianswer; or qtype_pmatch or qtype_stack, which store additional data - questions tests - alongside the question itseld. How should that work with versionning?) But, if you have not done weird things like that, you are probably safe. If you find anything else that causes problems, please list it here.

The same thing should apply to question behaviour and question import/export format plugings: no significant changes required (probably just fixing the Behat tests because of the navigation changes).
=== New plugin type: qbank plugins ===
This is not something that will cause problems for people upgrading from 3.x. Rather, it is an exciting possibility you can explore once you have survived process of upgrading to 4.0. There is a whole new plugin type which you can create to add new features to the question bank. For example extra columns, new actions and bulk actions, and so on. See [[Question_bank_plugins]].
=== Activities that use questions ===
The probable bad news is if you have an activity module which uses questions. So far, the only activity which has been fixed is mod_quiz in Moodle core, so we don't yet have a good picture of what fixes will be necessary in other activities. Work is about to start fixing [https://github.com/studentquiz/moodle-mod_studentquiz mod_studentquiz], so watching that should give more clues. As we do that, we will try to update this section of this page. Other help writing the information required here would also be greatly appreciated.
== The course format system ==
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 course format output classes implements the new named_templatable interface, which allows the class to define its own template path using the "get_template_name" method. This new interface in combination with [[Templates#Blocks|mustache blocks]] allows the format plugins to provide alternative templates to render the course.

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
== Behat changes ==
=== New steps ===
Moodle 4.0 introduces some new behat steps.

Sometimes you want to create a bulk number of activities. In that case you can use:<syntaxhighlight lang="gherkin">
:count :entitytype exist with the following data:
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
Given 100 "mod_lti > tool types" exist with the following data:
|name |Test tool [count] |
|description |Example description [count] |
|baseurl |https://www.example.com/tool[count]|
</syntaxhighlight>

Dynamic (AJAX) tabs is a new feature contributed to Moodle 4.0 by the Workplace team (MDL-71943). You can use the following step to navigate between the tabs.<syntaxhighlight lang="gherkin">
And I click on the "tab title" dynamic tab
</syntaxhighlight>

To make sure that edit mode is (or is not) available on the current page, the following steps can be used.<syntaxhighlight lang="gherkin">
And edit mode should be available on the current page
And edit mode should not be available on the current page
</syntaxhighlight>

There are new aliases for the existing steps <code>I turn editing mode on</code> and <code>I turn editing mode off</code>.<syntaxhighlight lang="gherkin">
And I switch editing mode on
And I switch editing mode off
</syntaxhighlight>

In addition to the existing step to go to a course with editing mode on, we now have the following step to do the same but with editing mode being off.<syntaxhighlight lang="gherkin">
And I am on "course full name" course homepage with editing mode off
</syntaxhighlight>

The following step is similar to the old <code>following "link string" should download between "min bytes" and "max bytes" bytes</code> step, with more flexibility.<syntaxhighlight lang="gherkin">
And following "element string" "element type" in the "container string" "container type" should download between "min bytes" and "max bytes" bytes
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
And following "Download" "link" in the "Starter" "table_row" should download between "0" and "5000" bytes
</syntaxhighlight>

The following step can be used to hover the mouse over the trigger area.<syntaxhighlight lang="gherkin">
And I hover over the "element string" "element type" in the "container string" "container type"
</syntaxhighlight>

The following step enables an installed plugin.<syntaxhighlight lang="gherkin">
And I enable "plugin name" "plugin type" plugin
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
And I enable "course_summary" "block" plugin
</syntaxhighlight>

The following is a special variation of 'I click on "<page name>" "link" in the "page" "region"'. It first checks to see if we are on the given page via the breadcrumb. If not we then attempt to follow the link name given.<syntaxhighlight lang="gherkin">
And I follow the breadcrumb "page name"
</syntaxhighlight>

You can use the following step to ensure a node is active in the navbar.<syntaxhighlight lang="gherkin">
And I should see "Node" is active in navigation
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
And I should see "My courses" is active in navigation
</syntaxhighlight>

The following step can be used to navigate to a given node in the primary navigation.<syntaxhighlight lang="gherkin">
And I select "Node" from primary navigation
</syntaxhighlight>

The following steps are to check whether an item exists in the user menu or not.<syntaxhighlight lang="gherkin">
And "item text" "selector type" should exist in the user menu
And "item text" "selector type" should not exist in the user menu
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
And "Language" "link" should exist in the user menu
</syntaxhighlight>

The following steps are to check if a submenu of the user menu is shown, and if an item exists or does not exist in a given user submenu.<syntaxhighlight lang="gherkin">
And I should see "submenu name" user submenu
And "item text" "selector type" should exist in the "submenu name" user submenu
And "item text" "selector type" should not exist in the "submenu name" user submenu
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
When I follow "Language" in the user menu
Then I should see "Language selector" user submenu
And "English &lrm;(en)&lrm;" "link" should exist in the "Language selector" user submenu
And "English (pirate) &lrm;(en_ar)&lrm;" "link" should not exist in the "Language selector" user submenu
</syntaxhighlight>

To add enrolment methods to courses you can use the following new step. The data that you provide in the next lines are used to fill the enrolment method form.<syntaxhighlight lang="gherkin">
And I add "enrolment method" in "course identifier" with:
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
When I add "Self enrolment" enrolment method in "Course 1" with:
| Custom instance name | Test student enrolment |
| Enrolment key | moodle_rules |
| Use group enrolment keys | Yes |
</syntaxhighlight>

There are 3 new steps specific to the calendar component. These steps can be used to hover over a day in the mini-calendar or the full calendar.<syntaxhighlight lang="gherkin">
And I hover over day "day of month" of this month in the full calendar page
And I hover over day "day of month" of this month in the mini-calendar block
And I hover over today in the mini-calendar block
</syntaxhighlight>

Some new steps are added to question bank to be able to add comment to questions, verify the existence of a comment, and deleting comments form questions. Please note that the steps for adding comments only write the comment text in the comment field. You still need to click on the "Add comment" button to save the comment.<syntaxhighlight lang="gherkin">
And I add "comment text" comment to question
And I add "comment text" comment to question preview
And I delete "comment text" comment from question
And I delete "comment text" comment from question preview
And I should see "number of comments" on the comments column
And I click "number of comments" on the row on the comments column

</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
And I navigate to "Question bank" in current page administration
And I should see "0" on the comments column
And I click "0" on the row on the comments column
And I add "test comment 01" comment to question
And I click on "Add comment" "button" in the ".modal-dialog" "css_element"
And I click on "Close" "button" in the ".modal-dialog" "css_element"
And I should see "1" on the comments column
And I click "1" on the row on the comments column
And I delete "test comment 01" comment from question
</syntaxhighlight>

Similar to the steps for comments, the following steps are to verify the number of a question's usage and to click on it in order to open the question usage modal.<syntaxhighlight lang="gherkin">
And I should see "usage count" on the usage column
And I click "usage count" on the usage column
</syntaxhighlight>

The following new steps are related to bulk actions in the question bank UI.<syntaxhighlight lang="gherkin">
And I click on question bulk action "action"
And I should see question bulk action "action"
And I should not see question bulk action "action"
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
And I click on "First question" "checkbox"
And I click on "Second question" "checkbox"
And I click on "With selected" "button"
And I should see question bulk action "deleteselected"
And I click on question bulk action "deleteselected"
And I click on "Delete" "button" in the "Confirm" "dialogue"
</syntaxhighlight>

[https://docs.moodle.org/en/Report_builder Report builder] is a new feature contributed to Moodle 4.0 by the Workplace team. The following new step is added to Moodle 4.0 to select an action from the action menu in the list of custom reports table.<syntaxhighlight lang="gherkin">
And I press "action" action in the "report name" report row
</syntaxhighlight>

There's another step related to the report builder to set a column's aggregation in the report editor.<syntaxhighlight lang="gherkin">
And I set the "column title" column aggregation to "aggregation method"
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
And I set the "First name" column aggregation to "Comma separated values"
</syntaxhighlight>

The following step needs to be used in scenarios that involve testing BigBlueButton. For this to work, you need to have a [https://github.com/moodlehq/bigbluebutton_mock BigBlueButton Mock API Server] and set <code>TEST_MOD_BIGBLUEBUTTONBN_MOCK_SERVER</code> to point to that in config.php.<syntaxhighlight lang="gherkin">
And a BigBlueButton mock server is configured
</syntaxhighlight>

The following step replicates receiving a callback from the BigBlueButton server indicating the recordings for meetings are ready for viewing.<syntaxhighlight lang="gherkin">
And the BigBlueButtonBN server has sent recording ready notifications
</syntaxhighlight>

The following steps are specific to the lesson activity. Note that in 4.0, some links (such as the "edit" and the "grade essays" links) are replaced by buttons, so you need to update your old steps with the new ones.<syntaxhighlight lang="gherkin">
And I edit the lesson
</syntaxhighlight>A new step is added to be used in lesson activities to edit them. This step navigates the user to the lesson edit page.
<syntaxhighlight lang="gherkin">
And I grade lesson essays
</syntaxhighlight>It's a new step to go to the "Grade essays" page of the lesson we are currently in.
<syntaxhighlight lang="gherkin">
And I select edit type "edit type"
</syntaxhighlight>Select the lesson edit type when we are in the the lesson's edit page. "edit type" can either be "Collapsed" or "Expanded".

The following new step can be used to navigate to the exports page in the course gradebook and select the specified export type from the grade exports navigation selector.<syntaxhighlight lang="gherkin">
And I navigate to "export option" export page in the course gradebook
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
And I navigate to "XML file" export page in the course gradebook
</syntaxhighlight>

Similarly, there's a new step to navigate to the imports page in the course gradebook and select the specified import type from the grade imports navigation selector.<syntaxhighlight lang="gherkin">
And I navigate to "import option" import page in the course gradebook
</syntaxhighlight>
=== Boost steps ===
In addition to the steps listed in the previous section, there are also some Boost specific steps coming with Moodle 4.0. These steps only work in Boost or Boost child themes, so you need to make sure they are not used in scenarios that may be run by non-Boost themes.

The following step checks whether a node is active in the secondary navigation.<syntaxhighlight lang="gherkin">
And I should see :name is active in secondary navigation
</syntaxhighlight>

The Boost theme shows the language selector menu in the primary navigation when not logged in, and within the user menu when logged in. The following steps are to check if the primary navigation includes the language selector menu.<syntaxhighlight lang="gherkin">
And language selector menu should exist in the navbar
And language selector menu should not exist in the navbar
</syntaxhighlight>

And the following steps can be used to check whether an item exists in the language selector menu in the Boost theme.<syntaxhighlight lang="gherkin">
And "item text" "selector type" should exist in the language selector menu
And "item text" "selector type" should not exist in the language selector menu
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin">
And "English &lrm;(en)&lrm;" "link" should exist in the language selector menu
</syntaxhighlight>
=== Modified steps ===
The step <code>I change the (window|viewport) size to "size"</code> now supports 2 new values for the size argument. The size argument now accepts <code>mobile</code> and <code>tablet</code> values in addition to <code>small</code>, <code>medium</code> and <code>large</code>.
=== Removed steps ===
Some behat steps are removed or replaced with new steps.

As a result of some design changes, hidden or restricted activities are no longer dimmed. Therefore the step<syntaxhighlight lang="gherkin">
And "Activity or resource name" activity should be dimmed
</syntaxhighlight>is now removed.
Depending on what you were using that step for, you may be able to use these steps:<syntaxhighlight lang="gherkin">
And "Label name" label should be hidden
</syntaxhighlight><syntaxhighlight lang="gherkin">
And "Activity or resource name" activity should be hidden
</syntaxhighlight><syntaxhighlight lang="gherkin">
And I should see "Activity or resource name"
And "Activity or resource name" "link" should not exist in the "region-main" "region"
</syntaxhighlight>
=== Other things to consider ===
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. It 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] is integrated 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"
Old behat steps that may now fail can be updated to the new steps.
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"
Or for settings, instead of:
<syntaxhighlight lang="gherkin">And I follow "Test choice name"
And I navigate to "Edit settings" in current page administration</syntaxhighlight>
Use:
<syntaxhighlight lang="gherkin">And I am on the "Test choice name" "choice activity editing" page</syntaxhighlight>

There are also similar stream-lined navigation steps for accessing question bank pages. See MDL-74130.
== Other ==
=== 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.
=== Core blocks cleanup ===
In the "Add a block" menu, the list of blocks was really long. A few changes have been done to reduce this list.

More information about this project can be found in the [[Add a block cleanup]] page.
=== Site admin presets plugin ===
The third-party plugin [https://moodle.org/plugins/block_admin_presets Admin presets], created by David Monllaó and maintained by developers from [https://pimenko.com/ Pimenko] has been adapted and integrated into Moodle 4.0. It stores settings and plugins status (enabled/disabled) in what's called "presets" to let admins quickly switch between different configurations.

More information about this project can be found in the [[Site admin presets|Site admin presets plugin]] page.
=== JavaScript browser support changes ===
From Moodle 4.0, Internet Explorer is no longer supported. See MDL-73915 and MDLSITE-6109 for further information on this change.

This change means that changes built on 4.0 onwards (including the master branch) will be different to older versions of Moodle.

For plugin developers supporting multiple versions of Moodle using a single plugin version, the compiled javascript files are backwards compatible and will _work_ on all supported versions, however if you run the `grunt` command on multiple versions you will see unbuilt changes. Running grunt on all versions of Moodle is not necessary and this check can be safely disabled for Moodle versions 3.9 - 4.0, as long as only at least you run `grunt` against at least one version of Moodle.

If you need to support Internet Explorer and do not wish to fork your plugin for Moodle 4.0 onwards, then it is recommended that you run `grunt` on an older version of Moodle.
=== The course index element ===
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.
=== 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.

Plugins implementing the variable FEATURE_MOD_PURPOSE are only supported on Moodle 4.0 and newer.

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
)
== I'm a developer, what do I need to know? ==
This section is a quick checklist of the areas in this document that you should consult when updating your plugin.
=== Modules ===
If you are a module developer (activity / resources) then you need to review the following updates and changes:
* If using settings, reformat to work with the secondary navigation. We have significantly changed the way that settings are shown. Settings added to the course and activity administration branch of the navigation are now by default shown in the secondary navigation. You will most likely find them in the more section of the secondary navigation. Please avoid creating settings in containers (a parent navigation node with children). These settings will still be shown, but this goes against the pattern that we are trying to establish for navigation around the site. If you have a lot of settings, consider creating a specific page to handle your additional settings.
** The order of the items in the secondary navigation may not be to your liking. This can be changed. See [[Moodle_4.0_developer_update#Changing_the_order_of_tabs|changing the order of tabs]]
* Update my behat tests to use new steps for site navigation. See [[Moodle_4.0_developer_update#Behat_changes|new behat steps]].
* Update my module to use the new activity_header API. See [[Moodle_4.0_developer_update#The_activity_header_class|the activity header]].
* Update my pages to make it work with the general format of the tertiary navigation. See [[Moodle_4.0_developer_update#Tertiary_navigation|the tertiary navigation]].
* Update my activity icon to use the API and set a purpose. See [[Moodle_4.0_developer_update#Activity_icons|activity icons]].
=== Themes ===
If you are a theme developer then you may want to consider the following:
* Take a look at the [[Moodle_4.0_developer_update#Navigation_changes|new navigation]] and decide if you want to incorporate this into your theme.
** A new layout ([[Moodle_4.0_developer_update#New_layout_page|drawers]])
** An [[Moodle_4.0_developer_update#Edit_switch|edit switch]]
** The [[Moodle_4.0_developer_update#The_course_index_element|course index]]
* Use of the flat nav
* New Site administration page and layout
* Course settings and how they are displayed
=== Course format ===
There have been a lot of changes made to the course format. Most in the process of moving the course format away from using the old rendering system and towards templates.
We recommend the following sections be read carefully:
# [[Moodle_4.0_developer_update#The_course_format_system|The course format]]. There have been a lot of deprecations and reading this section is critical in understanding the changes made.
# Consider moving the rendering of your content over to the [[Templates|template system]].
=== Other plugins ===
# Are you adding settings? See the [[Moodle_4.0_developer_update#Adding_items_to_the_navigation|secondary nav]] for adding items to this navigation bar.
# Have a look at [[Moodle_4.0_developer_update#Secondary_navigation|secondary]] and [[Moodle_4.0_developer_update#Tertiary_navigation|tertiary]] navigation changes in general if you have a plugin that has multiple pages to navigate around.
# Do you have behat tests? Check the new [[Moodle_4.0_developer_update#Behat_changes|behat changes]].

Developer meeting December 2021

2021-11-08T10:00:54Z

Tusefomal:

[[Developer meetings]] > December 2021 meeting
{| class="wikitable"
|-
| Date
| Tuesday 14 December 2021 at 10:00 UTC ([https://www.timeanddate.com/worldclock/fixedtime.html?msg=Moodle+developer+meeting&iso=20211214T10&p1=1440&ah=1 Check this time in your location])
|-
| Meeting room
| [https://moodle.org/mod/bigbluebuttonbn/view.php?id=8596 Developer meetings BBB on moodle.org]
|-
| Discussion
| [https://moodle.org/mod/forum/discuss.php?d=428309 Developer meeting Tuesday 14 December 2021]
|}
== Agenda ==
# Latest #moodledev news - [https://moodle.org/user/view.php?id=2356736&course=5 Sander Bangma], Moodle HQ
# Report builder in Moodle 4.0 - [https://moodle.org/user/view.php?id=219220&course=5 Paul Holden], Moodle HQ
# Course editor in Moodle 4.0 - [https://moodle.org/user/view.php?id=57216&course=5 Ferran Recio Calderó], Moodle HQ
----
If there is any topic that you would like to present or discuss at a developer meeting, please contact [https://moodle.org/user/profile.php?id=1601 David Mudrák].

Moodle 4.0 developer update

2021-09-02T14:08:47Z

Tusefomal: /* 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 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 - [https://tracker.moodle.org/browse/MDL-71912 MDL-71912]. [https://tracker.moodle.org/browse/MDL-71913 MDL-71913],[https://tracker.moodle.org/browse/MDL-71914 MDL-71914],[https://tracker.moodle.org/browse/MDL-71915 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 - [https://tracker.moodle.org/browse/MDL-72352 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 developer update

2021-09-02T14:07:24Z

Tusefomal: /* Course editor javascript modules and frontend components */

{{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 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 - [https://tracker.moodle.org/browse/MDL-71912 MDL-71912]. [https://tracker.moodle.org/browse/MDL-71913 MDL-71913],[https://tracker.moodle.org/browse/MDL-71914 MDL-71914],[https://tracker.moodle.org/browse/MDL-71915 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 - [https://tracker.moodle.org/browse/MDL-72352 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 new feature of Moodle 4.0 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 which observe the course state data and react any data change
* When any reactive component need 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 developer update

2021-09-02T11:59:59Z

Tusefomal: /* Course editor javascript modules and frontend components */

Moodle 4.0 developer update

2021-09-02T10:03:04Z

Tusefomal: /* The core_courseformat subsystem */

Moodle 4.0 developer update

2021-09-02T10:01:34Z

Tusefomal: /* The core_courseformat subsystem */

Moodle 4.0 developer update

2021-09-02T09:10:02Z

Tusefomal: /* The core_courseformat subsystem */

Moodle 4.0 developer update

2021-09-02T07:20:31Z

Tusefomal: /* Course creation */

Moodle libraries credits

2021-05-11T09:13:20Z

Tusefomal: /* Mustache */

Some of Moodle's libraries were written by other people, and are being redistributed as part of Moodle under their respective open source licenses that thankfully allow us to do so. Thanks to the authors of all these excellent products - without them Moodle would be missing important functionality. Copyright information for each package is included below:

==ADOdb==

''lib/adodb''

Database abstraction library for MySQL, PostgreSQL, MSSQL, Oracle, Interbase, Foxpro, Access, ADO, Sybase, DB2 and ODBC.

Version: 5.20.14

@copyright (c) 2000-2013 John Lim (jlim#natsoft.com). All rights reserved.

@copyright (c) 2014 Damien Regad, Mark Newnham and the ADOdb community

License: Dual LGPL and BSD-style

http://adodb.sourceforge.net

==Bennu==

"lib/bennu"

Bennu is an object-oriented library written in PHP that implements the iCalendar standard (RFC 2445).

Version: 0.1 (customized since then)

Copyright (c) 2005, Jon Papaioannou

License: LGPL 2.1+

http://bennu.sourceforge.net/

==Amazon S3==

''repository/s3/S3.php''

A standalone Amazon S3 (REST) client for PHP 5.2.x using CURL that does not require PEAR.

Version: 0.5.1

Copyright (c) 2013, Donovan Schönknecht

License: BSD 2-Clause

https://github.com/tpyo/amazon-s3-php-class/releases

==CAS==

''auth/cas/CAS''

phpCAS library to support CAS authentication plugin

Version: 1.3.7

Copyright Jasig

License: Apache License 2.0

https://wiki.jasig.org/display/CASC/phpCAS

==Chart.js==

''lib/amd/src/chartjs-lazy.js''

Simple yet flexible JavaScript charting for designers & developers

Version: 2.9.4

Copyright 2016 Nick Downie

License: MIT

http://www.chartjs.org

==CodeMirror==

''lib/editor/atto/plugins/html/yui/src/codemirror''

CodeMirror is a versatile text editor implemented in JavaScript for the browser.

Version: 5.59.4

License: MIT

https://github.com/codemirror/CodeMirror

==Emoji-data==

''lib/emoji-data''

Library to parse easily data and spritesheets for emoji

License: MIT

https://github.com/iamcal/emoji-data/

==EvalMath==

''lib/evalmath''

Class to safely evaluate math expressions

Copyright Miles Kaufmann

License: BSD

http://www.twmagic.com/

==Flexitour==

"admin/tool/usertours/amd/src/tour.js"

A JS library for tours

© 2016 Andrew Nicols and contributors

License: GPLv3

https://github.com/andrewnicols/flexitour

==FLV player==

''filter/mediaplugin/flvplayer.swf''

Flash movie to play FLV files

Copyright Jeroen Wijering

License: GNU GPL

http://www.jeroenwijering.com

(This library is not currently used in Moodle)

== GeoIp2 ==

''lib/maxmind/GeoIp2''

Library for processing of GeoIP data files

Version: 2.11.0

Copyright MaxMind

License: Apache 2.0

https://github.com/maxmind/GeoIP2-php

== GeoPattern==

''lib/geopattern-php''

Library for creating beautiful generative background images from a string

Version: 1.1.1

Copyright 2015 Leaf Corcoran

License: MIT

https://github.com/RedeyeGroup/geopattern-php

==Google APIs==

"lib/google"

Library Google APIs Client Library for PHP

Version: 1.1.7

License: Apache License Version 2.0

https://github.com/google/google-api-php-client

==Graph Class==

''lib/graphlib.php''

Class to draw line, point, bar, and area graphs, including numeric x-axis and double y-axis.

Version: 1.6.3 (with modifications)

Copyright © 2000 Herman Veluwenkamp (''hermanV AT mindless DOT com'')

License: LGPL

==H5P==

''lib/h5p''

The general H5P library

Version: 1.24

Copyright © Joubel

License: GPL-3.0

https://github.com/h5p/h5p-php-library/

==Horde==

''lib/horde''

Library used by the inbound e-mail handling system.

Version: 5.2.22

Copyright © Horde LLC

License: LGPL

http://www.horde.org/

==html2text==

''lib/html2text''

PHP script to convert HTML into an approximate text equivalent

Version: 4.3.1

Copyright (c) 2005-2007 Jon Abernathy <jon@chuggnutt.com>

License: GNU GPL

https://github.com/mtibben/html2text.git

==htmlArea==

''lib/editor''

Javascript/HTML script to put a GUI editor in textareas on Internet Explorer and Mozilla

Version: 3.0 beta (with modifications)

Copyright © 2002 interactivetools.com, inc.

License: htmlArea License (based on BSD license)

(This library is not currently used in Moodle)

==HTML Purifier==

"lib/htmlpurifier"

Filters HTML.

Version: 4.13.0

License: LGPL

==IP-Atlas==

''lib/ipatlas''

PHP scripts to show the location of an IP address on a map.

Version: 1.0 (with modifications)

Copyright © 2002 Ivan Kozik

License: GNU GPL

http://www.xpenguin.com/ip-atlas.php

(This library is not currently used in Moodle)

==Jabber - XMPPHP==

''lib/jabber''

PHP library for XMPP (aka Jabber, Google Talk, etc).

Version: 0.1rc2-r77

Copyright: 2008 Nathanael C. Fritz

License: GPL

http://code.google.com/p/xmpphp

==jQuery==

''lib/jquery''

jQuery is a fast, small, and feature-rich JavaScript library widely used on moodle.

Version: 3.4.1

Copyright: 2016 The jQuery Foundation

License: MIT

https://jquery.com

==jQuery migrate==

''lib/jquery/jquery-migrate-1.4.0.js''

Library used migrate older jQuery code to jQuery 3.0.

Version: 1.4.0

Copyright: 2016 The jQuery Foundation and other contributors

License: MIT

https://github.com/jquery/jquery-migrate

(This library is not currently used in Moodle)

==jQuery UI==

''lib/jquery/ui-1.12.1/''

jQuery UI is a set of user interface interactions, effects, widgets, and themes built on top of the jQuery library.

Version: 1.12.1

Copyright: 2016 The jQuery Foundation and other contributors

License: MIT

https://github.com/jquery/jquery-migrate

==JavaScript Beautifier==

''yui/src/beautify''

Beautify HTML code in Atto.

Version: 1.13.0

Copyright (c) 2007-2018 Einar Lielmanis, Liam Newman, and contributors.

License: MIT

https://beautifier.io/

==Services_JSON==

''lib/json''

Allows PHP->JS communication via JSON

Version: 1.3.1

Copyright © 2005 Michal Migurski

License: Modified BSD (GPL-compatible)

http://pear.php.net/pepr/pepr-proposal-show.php?id=198

(This library is not currently used in Moodle)

==JWT==

''lib/php-jwt''

A simple library to encode and decode JSON Web Tokens (JWT) in PHP, conforming to RFC 7519

Version: 5.0.0

Copyright © 2011, Neuman Vong

License: BSD

https://github.com/firebase/php-jwt

==ENUM==

''lib/php-enum''

PHP Enum implementation inspired from SplEnum

Version: 1.7.6

Copyright (c) 2015 My C-Labs

License: MIT

https://github.com/myclabs/php-enum

==kses==

''lib/kses.php''

HTML/XHTML filter that only allows some elements and attributes

Version: 0.2.2

Copyright © 2002, 2003, 2005 Ulf Harnhammar

License: GNU GPL

http://sourceforge.net/projects/kses

(This library is not currently used in Moodle)

==less.php==

The less.php is a PHP port of the official LESS processor used by moodle themes.

''lib/lessphp''

Version: 1.7.0.10

License: Apache 2.0

http://lessphp.typesettercms.com/

Copyright: Matt Agar and Martin Jantošovič

(This library is not currently used in Moodle)

==loglevel.js==

Minimal lightweight simple logging for JavaScript.

Version 1.7.1

Copyright (c) 2019 Tim Perry

License: MIT

https://github.com/pimterry/loglevel/

==LTI Tool Provider Library for PHP==

"lib/ltiprovider/"

PHP library for communicating with learning tools as per the LTI specification.

Version: 3.0.2

© 2016 IMS Global Learning Consortium Inc. All Rights Reserved. Trademark Policy - (www.imsglobal.org/trademarks)

License: Apache 2

https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP

==MathJax==

JavaScript filter library for displaying LaTeX, AsciiMath notation, and MathML.

Not actually included in Moodle. Instead, Moodle [[:en:MathJax filter|has a setting]] for where the library is located to be loaded from. It is currently pointing to the Cloudflare CDN by default.

© Copyright 2009 - 2017 The MathJax Consortium

* Default MathJax version: 2.7.2 (Moodle 3.4)
* License: Apache 2.0
* Homepage: https://www.mathjax.org/

==MatthiasMullie\Minify==
CSS & JavaScript minifier, in PHP

Version 1.3.61

License: MIT

https://github.com/matthiasmullie/minify

==MaxMind DB Reader==
lib/maxmind/MaxMind/

PHP API for reading MaxMind DB files

Version: 1.9.0

Copyright MaxMind

License: Apache 2.0

https://github.com/maxmind/MaxMind-DB-Reader-php/

==mimeTeX==

''filter/tex''

Compiled C program to convert TeX into GIFs

Version: 1.74

Copyright © 2002-2004 John Forkosh Associates, Inc

License: GNU GPL

http://www.forkosh.com/mimetex.html

==Mustache.js==

"lib/amd/src/mustache.js"

JS library for displaying mustache templates.

Version: 3.0.1

Copyright (c) 2009 Chris Wanstrath (Ruby)

Copyright (c) 2010-2014 Jan Lehnardt (JavaScript)

Copyright (c) 2010-2015 The mustache.js community

License: MIT

https://github.com/janl/mustache.js/releases

==Mustache==

"lib/mustache"

PHP library for displaying mustache templates.

Version: 2.13.0

Copyright (c) 2010-2016 Justin Hileman

License: MIT

https://github.com/bobthecow/mustache.php/releases

==mp3player==

''lib/mp3player''

Flash movie to play streaming MP3s

Copyright © 2005 Andrew Walker

License: GNU GPL

(This library is not currently used in Moodle)

==overlibmws==

''lib/overlib.js''

Javascript library to enable DHTML popups, floating windows, events etc

Version: July 2004

Copyright © 2002-2004 Foteos Macrides

Copyright © 1998-2004 Erik Bosrup

License: Artistic Open Source License

http://www.macridesweb.com/oltest/

(This library is not currently used in Moodle)

==PclZip==

''lib/pclzip''

Class to create, manage and unpack zip files.

Version: 2.4 RC1

Copyright © 2004 Vincent Blavet (''vincent AT phpconcept DOT net'')

License: GNU GPL

http://www.phpconcept.net

(This library is not currently used in Moodle)

==PEAR OLE Classes==

''lib/pear''

Class to write Excel files

Version: 0.5

Copyright © 2004 Xavier Noguer

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/OLE

(This library is not currently used in Moodle)

==PEAR Spreadsheet_Excel_Writer==

''lib/pear''

Class to write Excel files

Version: 0.9.1

Copyright © 2004 Xavier Noguer and Mika Tuupola

License: LGPL

http://pear.php.net/package/Spreadsheet_Excel_Writer

(This library is not currently used in Moodle)

==PEAR HTML_Quickform==

''lib/pear''

Class to write forms

Version: 3.2.6

Copyright © 2004 Bertrand Mansion, Adam Daniel, Alexey Borzov

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Quickform

==PEAR HTML_Quickform_Renderer_Tableless==

''lib/pear''

Class to render forms without tables

Version: 0.3.4

Copyright © 2005 Mark Wiesemann

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Quickform_Renderer_Tableless

==PEAR HTML_QuickForm_DHTMLRulesTableless==

''lib/pear''

Class to render validation notices with dhtml

Version: 0.1.2

Copyright © 2005 Alexey Borzov, Adam Daniel, Bertrand Mansion, Justin Patrin, Mark Wiesemann

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_QuickForm_DHTMLRulesTableless

==PEAR HTML_Common==

''lib/pear''

Class with many common HTML functions (used by HTML Quickform)

Version: 0.3.4

Copyright © 2004 Adam Daniel, Bertrand Mansion, Klaus Guenther, Alexey Borzov

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Common

==PEAR XML_Parser==

''lib/pear''

Class implementing one handy (sax-expat) XML parser

Version: 1.3.2

Copyright © 2004-2008 The PHP Group & Stephan Schmidt

License: New BSD License

http://pear.php.net/package/XML_Parser

(This library is not currently used in Moodle)

==PHP-CSS-Parser==

''lib/php-css-parser''

A Parser for CSS Files written in PHP.

Version: 8.3.0

Copyright (c) 2011 Raphael Schweikert, http://sabberworm.com/

License: MIT

https://github.com/sabberworm/PHP-CSS-Parser

==PHPExcel==

''lib/phpexcel/PHPExcel.php''

Library to read, write and create spreadsheet documents in PHP.

Version 1.8.1

Copyright © 2006 - 2015 PHPExcel
License: LGPL

https://github.com/PHPOffice/PHPExcel

(This library is not currently used in Moodle)

==PhpSpreadsheet==

''lib/phpspreadsheet''

Library to read, write and create spreadsheet documents in PHP.

Version 1.7.0

License: LGPL

https://github.com/PHPOffice/PhpSpreadsheet

==PHP mailer==

''lib/class.phpmailer.php''

Class for sending email using either sendmail, PHP mail(), or SMTP. Methods are based upon the standard AspEmail(tm) classes.

Version 6.0.7

Copyright © 2003 Brent R. Matzelle (''bmatzelle AT yahoo DOT com'')
License: LGPL

http://phpmailer.sourceforge.net
https://github.com/PHPMailer/PHPMailer/releases

==PHP Markdown==

''lib/markdown.php''

Functions to convert from the Markdown text format into clean XHTML.

Version: 1.8.0 (with modifications)

* @copyright 2004-2016 Michel Fortin <https://michelf.com/projects/php-markdown/>

* @copyright (Original Markdown) 2004-2006 John Gruber <https://daringfireball.net/projects/markdown/>
All rights reserved.

License: BSD

http://www.michelf.com/projects/php-markdown/

==PHP-ML==

''lib/mlbackend/php/phpml''

Machine learning library used to generate data for the Analytics system.

Version: 0.8.0

* @copyright 2016-2018 Arkadiusz Kondas <arkadiusz.kondas[at]gmail>

License: MIT

https://php-ml.readthedocs.io/

==Popper.js==

"admin/tool/usertours/amd/src/popper.js"

A kickass library used to created Poppers in web applications

Version: 1.12.6

© 2016 Federico Zivolo and contributors

License: MIT

https://github.com/FezVrasta/popper.js

==RTLCSS for PHP==

"lib/rtlcss"

RTLCSS is a framework for converting Left-To-Right (LTR) Cascading Style Sheets(CSS) to Right-To-Left (RTL).

© 2016 Frédéric Massart

License: MIT

https://github.com/moodlehq/rtlcss-php

==RequireJS==

''/lib/requirejs/''

RequireJS is a JavaScript file and module loader.

Version 2.3.5

License: new BSD or MIT

http://requirejs.org/

==scssphp==

''/lib/scssphp/''

scssphp is a compiler for SCSS written in PHP.

Version: 1.0.2

Copyright (c) 2015 Leaf Corcoran

License: MIT

http://leafo.github.io/scssphp

==SimplePie==

"/lib/simplepie"

Simple Pie helps with blogs.

Version 1.5.6

License: BSD

https://github.com/simplepie/simplepie

==Snoopy==

''lib/snoopy''

A PHP net client

Version: 1.0

Copyright © 1999-2000 Monte Ohrt (''monte AT ispi DOT net'')
License: GNU LGPL

http://snoopy.sourceforge.com

(This library is not currently used in Moodle)

==SMTP class==

''lib/class.smtp.php''

Class that can be used to connect and communicate with any SMTP server. It implements all the SMTP functions defined in RFC821 except TURN.

Version: 03/26/2001

Copyright © 2001 Chris Ryan (''chris AT greatbridge DOT com'')

(This library is not currently used in Moodle)

==Spike PHPCoverage==

''lib/spikephpcoverage''

PHP code coverage reporting tool

Version: 0.8.2 (with modifications)

Copyright © 2004 SpikeSource Inc

License: LGPL

http://developer.spikesource.com/projects/phpcoverage

(This library is not currently used in Moodle)

==Spout==

"lib/spout"

Library for importing and exporting csv / excel / ODS files.

Version 3.0.1

License: Apache

https://github.com/box/spout/

==TCPDF Class==

''lib/tcpdf''

Class to generate PDF files

Version: 6.3.5

Copyright Olivier PLATHEY

License: LGPL-v3.0-only

http://www.setasign.com/products/fpdi/downloads

==Typo3 Character Set Class==

''lib/typo3''

Class for conversion between charsets and multibyte-savy operations with strings.

Version: 4.7.19

Copyright © 2003-2005 Kasper Skaarhoj

Licence: GNU GPL

http://typo3.org/

==Video.js==

''amd/src/video-lazy.js''

JavaScript library that makes it easier to work with and build on HTML5 video

Version: 7.10.0

Copyright Brightcove, Inc

Licence: Apache

http://videojs.com/

==XHProf==

''lib/xhprof''

A Hierarchical Profiler for PHP

Version: 0.9.4

Copyright © 2009 Phacility

Licence: Apache

https://github.com/phacility/xhprof

==Yahoo User Interface==

''lib/yui''

The Yahoo! User Interface Library is a set of utilities and controls, in JavaScript, for building richly interactive web applications using techniques such as DOM scripting, DHTML and AJAX. The YUI Library also includes several core CSS resources.Set of user-interface components using AJAX, DHTML etc. We use it for all our AJAX-related stuff.

CVS version: 3.17.2

Copyright (c) 2006, Yahoo! Inc.

Licence: BSD

http://developer.yahoo.com/yui/

[[Category:Credits]]

Moodle libraries credits

2021-05-11T09:03:30Z

Tusefomal: /* GeoIp2 */

Some of Moodle's libraries were written by other people, and are being redistributed as part of Moodle under their respective open source licenses that thankfully allow us to do so. Thanks to the authors of all these excellent products - without them Moodle would be missing important functionality. Copyright information for each package is included below:

==ADOdb==

''lib/adodb''

Database abstraction library for MySQL, PostgreSQL, MSSQL, Oracle, Interbase, Foxpro, Access, ADO, Sybase, DB2 and ODBC.

Version: 5.20.14

@copyright (c) 2000-2013 John Lim (jlim#natsoft.com). All rights reserved.

@copyright (c) 2014 Damien Regad, Mark Newnham and the ADOdb community

License: Dual LGPL and BSD-style

http://adodb.sourceforge.net

==Bennu==

"lib/bennu"

Bennu is an object-oriented library written in PHP that implements the iCalendar standard (RFC 2445).

Version: 0.1 (customized since then)

Copyright (c) 2005, Jon Papaioannou

License: LGPL 2.1+

http://bennu.sourceforge.net/

==Amazon S3==

''repository/s3/S3.php''

A standalone Amazon S3 (REST) client for PHP 5.2.x using CURL that does not require PEAR.

Version: 0.5.1

Copyright (c) 2013, Donovan Schönknecht

License: BSD 2-Clause

https://github.com/tpyo/amazon-s3-php-class/releases

==CAS==

''auth/cas/CAS''

phpCAS library to support CAS authentication plugin

Version: 1.3.7

Copyright Jasig

License: Apache License 2.0

https://wiki.jasig.org/display/CASC/phpCAS

==Chart.js==

''lib/amd/src/chartjs-lazy.js''

Simple yet flexible JavaScript charting for designers & developers

Version: 2.9.4

Copyright 2016 Nick Downie

License: MIT

http://www.chartjs.org

==CodeMirror==

''lib/editor/atto/plugins/html/yui/src/codemirror''

CodeMirror is a versatile text editor implemented in JavaScript for the browser.

Version: 5.59.4

License: MIT

https://github.com/codemirror/CodeMirror

==Emoji-data==

''lib/emoji-data''

Library to parse easily data and spritesheets for emoji

License: MIT

https://github.com/iamcal/emoji-data/

==EvalMath==

''lib/evalmath''

Class to safely evaluate math expressions

Copyright Miles Kaufmann

License: BSD

http://www.twmagic.com/

==Flexitour==

"admin/tool/usertours/amd/src/tour.js"

A JS library for tours

© 2016 Andrew Nicols and contributors

License: GPLv3

https://github.com/andrewnicols/flexitour

==FLV player==

''filter/mediaplugin/flvplayer.swf''

Flash movie to play FLV files

Copyright Jeroen Wijering

License: GNU GPL

http://www.jeroenwijering.com

(This library is not currently used in Moodle)

== GeoIp2 ==

''lib/maxmind/GeoIp2''

Library for processing of GeoIP data files

Version: 2.11.0

Copyright MaxMind

License: Apache 2.0

https://github.com/maxmind/GeoIP2-php

== GeoPattern==

''lib/geopattern-php''

Library for creating beautiful generative background images from a string

Version: 1.1.1

Copyright 2015 Leaf Corcoran

License: MIT

https://github.com/RedeyeGroup/geopattern-php

==Google APIs==

"lib/google"

Library Google APIs Client Library for PHP

Version: 1.1.7

License: Apache License Version 2.0

https://github.com/google/google-api-php-client

==Graph Class==

''lib/graphlib.php''

Class to draw line, point, bar, and area graphs, including numeric x-axis and double y-axis.

Version: 1.6.3 (with modifications)

Copyright © 2000 Herman Veluwenkamp (''hermanV AT mindless DOT com'')

License: LGPL

==H5P==

''lib/h5p''

The general H5P library

Version: 1.24

Copyright © Joubel

License: GPL-3.0

https://github.com/h5p/h5p-php-library/

==Horde==

''lib/horde''

Library used by the inbound e-mail handling system.

Version: 5.2.22

Copyright © Horde LLC

License: LGPL

http://www.horde.org/

==html2text==

''lib/html2text''

PHP script to convert HTML into an approximate text equivalent

Version: 4.3.1

Copyright (c) 2005-2007 Jon Abernathy <jon@chuggnutt.com>

License: GNU GPL

https://github.com/mtibben/html2text.git

==htmlArea==

''lib/editor''

Javascript/HTML script to put a GUI editor in textareas on Internet Explorer and Mozilla

Version: 3.0 beta (with modifications)

Copyright © 2002 interactivetools.com, inc.

License: htmlArea License (based on BSD license)

(This library is not currently used in Moodle)

==HTML Purifier==

"lib/htmlpurifier"

Filters HTML.

Version: 4.13.0

License: LGPL

==IP-Atlas==

''lib/ipatlas''

PHP scripts to show the location of an IP address on a map.

Version: 1.0 (with modifications)

Copyright © 2002 Ivan Kozik

License: GNU GPL

http://www.xpenguin.com/ip-atlas.php

(This library is not currently used in Moodle)

==Jabber - XMPPHP==

''lib/jabber''

PHP library for XMPP (aka Jabber, Google Talk, etc).

Version: 0.1rc2-r77

Copyright: 2008 Nathanael C. Fritz

License: GPL

http://code.google.com/p/xmpphp

==jQuery==

''lib/jquery''

jQuery is a fast, small, and feature-rich JavaScript library widely used on moodle.

Version: 3.4.1

Copyright: 2016 The jQuery Foundation

License: MIT

https://jquery.com

==jQuery migrate==

''lib/jquery/jquery-migrate-1.4.0.js''

Library used migrate older jQuery code to jQuery 3.0.

Version: 1.4.0

Copyright: 2016 The jQuery Foundation and other contributors

License: MIT

https://github.com/jquery/jquery-migrate

(This library is not currently used in Moodle)

==jQuery UI==

''lib/jquery/ui-1.12.1/''

jQuery UI is a set of user interface interactions, effects, widgets, and themes built on top of the jQuery library.

Version: 1.12.1

Copyright: 2016 The jQuery Foundation and other contributors

License: MIT

https://github.com/jquery/jquery-migrate

==JavaScript Beautifier==

''yui/src/beautify''

Beautify HTML code in Atto.

Version: 1.13.0

Copyright (c) 2007-2018 Einar Lielmanis, Liam Newman, and contributors.

License: MIT

https://beautifier.io/

==Services_JSON==

''lib/json''

Allows PHP->JS communication via JSON

Version: 1.3.1

Copyright © 2005 Michal Migurski

License: Modified BSD (GPL-compatible)

http://pear.php.net/pepr/pepr-proposal-show.php?id=198

(This library is not currently used in Moodle)

==JWT==

''lib/php-jwt''

A simple library to encode and decode JSON Web Tokens (JWT) in PHP, conforming to RFC 7519

Version: 5.0.0

Copyright © 2011, Neuman Vong

License: BSD

https://github.com/firebase/php-jwt

==ENUM==

''lib/php-enum''

PHP Enum implementation inspired from SplEnum

Version: 1.7.6

Copyright (c) 2015 My C-Labs

License: MIT

https://github.com/myclabs/php-enum

==kses==

''lib/kses.php''

HTML/XHTML filter that only allows some elements and attributes

Version: 0.2.2

Copyright © 2002, 2003, 2005 Ulf Harnhammar

License: GNU GPL

http://sourceforge.net/projects/kses

(This library is not currently used in Moodle)

==less.php==

The less.php is a PHP port of the official LESS processor used by moodle themes.

''lib/lessphp''

Version: 1.7.0.10

License: Apache 2.0

http://lessphp.typesettercms.com/

Copyright: Matt Agar and Martin Jantošovič

(This library is not currently used in Moodle)

==loglevel.js==

Minimal lightweight simple logging for JavaScript.

Version 1.7.1

Copyright (c) 2019 Tim Perry

License: MIT

https://github.com/pimterry/loglevel/

==LTI Tool Provider Library for PHP==

"lib/ltiprovider/"

PHP library for communicating with learning tools as per the LTI specification.

Version: 3.0.2

© 2016 IMS Global Learning Consortium Inc. All Rights Reserved. Trademark Policy - (www.imsglobal.org/trademarks)

License: Apache 2

https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP

==MathJax==

JavaScript filter library for displaying LaTeX, AsciiMath notation, and MathML.

Not actually included in Moodle. Instead, Moodle [[:en:MathJax filter|has a setting]] for where the library is located to be loaded from. It is currently pointing to the Cloudflare CDN by default.

© Copyright 2009 - 2017 The MathJax Consortium

* Default MathJax version: 2.7.2 (Moodle 3.4)
* License: Apache 2.0
* Homepage: https://www.mathjax.org/

==MatthiasMullie\Minify==
CSS & JavaScript minifier, in PHP

Version 1.3.61

License: MIT

https://github.com/matthiasmullie/minify

==MaxMind DB Reader==
lib/maxmind/MaxMind/

PHP API for reading MaxMind DB files

Version: 1.9.0

Copyright MaxMind

License: Apache 2.0

https://github.com/maxmind/MaxMind-DB-Reader-php/

==mimeTeX==

''filter/tex''

Compiled C program to convert TeX into GIFs

Version: 1.74

Copyright © 2002-2004 John Forkosh Associates, Inc

License: GNU GPL

http://www.forkosh.com/mimetex.html

==Mustache.js==

"lib/amd/src/mustache.js"

JS library for displaying mustache templates.

Version: 3.0.1

Copyright (c) 2009 Chris Wanstrath (Ruby)

Copyright (c) 2010-2014 Jan Lehnardt (JavaScript)

Copyright (c) 2010-2015 The mustache.js community

License: MIT

https://github.com/janl/mustache.js/releases

==Mustache==

"lib/mustache"

PHP library for displaying mustache templates.

Version: 2.12.0

Copyright (c) 2010-2016 Justin Hileman

License: MIT

https://github.com/bobthecow/mustache.php/releases

==mp3player==

''lib/mp3player''

Flash movie to play streaming MP3s

Copyright © 2005 Andrew Walker

License: GNU GPL

(This library is not currently used in Moodle)

==overlibmws==

''lib/overlib.js''

Javascript library to enable DHTML popups, floating windows, events etc

Version: July 2004

Copyright © 2002-2004 Foteos Macrides

Copyright © 1998-2004 Erik Bosrup

License: Artistic Open Source License

http://www.macridesweb.com/oltest/

(This library is not currently used in Moodle)

==PclZip==

''lib/pclzip''

Class to create, manage and unpack zip files.

Version: 2.4 RC1

Copyright © 2004 Vincent Blavet (''vincent AT phpconcept DOT net'')

License: GNU GPL

http://www.phpconcept.net

(This library is not currently used in Moodle)

==PEAR OLE Classes==

''lib/pear''

Class to write Excel files

Version: 0.5

Copyright © 2004 Xavier Noguer

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/OLE

(This library is not currently used in Moodle)

==PEAR Spreadsheet_Excel_Writer==

''lib/pear''

Class to write Excel files

Version: 0.9.1

Copyright © 2004 Xavier Noguer and Mika Tuupola

License: LGPL

http://pear.php.net/package/Spreadsheet_Excel_Writer

(This library is not currently used in Moodle)

==PEAR HTML_Quickform==

''lib/pear''

Class to write forms

Version: 3.2.6

Copyright © 2004 Bertrand Mansion, Adam Daniel, Alexey Borzov

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Quickform

==PEAR HTML_Quickform_Renderer_Tableless==

''lib/pear''

Class to render forms without tables

Version: 0.3.4

Copyright © 2005 Mark Wiesemann

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Quickform_Renderer_Tableless

==PEAR HTML_QuickForm_DHTMLRulesTableless==

''lib/pear''

Class to render validation notices with dhtml

Version: 0.1.2

Copyright © 2005 Alexey Borzov, Adam Daniel, Bertrand Mansion, Justin Patrin, Mark Wiesemann

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_QuickForm_DHTMLRulesTableless

==PEAR HTML_Common==

''lib/pear''

Class with many common HTML functions (used by HTML Quickform)

Version: 0.3.4

Copyright © 2004 Adam Daniel, Bertrand Mansion, Klaus Guenther, Alexey Borzov

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Common

==PEAR XML_Parser==

''lib/pear''

Class implementing one handy (sax-expat) XML parser

Version: 1.3.2

Copyright © 2004-2008 The PHP Group & Stephan Schmidt

License: New BSD License

http://pear.php.net/package/XML_Parser

(This library is not currently used in Moodle)

==PHP-CSS-Parser==

''lib/php-css-parser''

A Parser for CSS Files written in PHP.

Version: 8.3.0

Copyright (c) 2011 Raphael Schweikert, http://sabberworm.com/

License: MIT

https://github.com/sabberworm/PHP-CSS-Parser

==PHPExcel==

''lib/phpexcel/PHPExcel.php''

Library to read, write and create spreadsheet documents in PHP.

Version 1.8.1

Copyright © 2006 - 2015 PHPExcel
License: LGPL

https://github.com/PHPOffice/PHPExcel

(This library is not currently used in Moodle)

==PhpSpreadsheet==

''lib/phpspreadsheet''

Library to read, write and create spreadsheet documents in PHP.

Version 1.7.0

License: LGPL

https://github.com/PHPOffice/PhpSpreadsheet

==PHP mailer==

''lib/class.phpmailer.php''

Class for sending email using either sendmail, PHP mail(), or SMTP. Methods are based upon the standard AspEmail(tm) classes.

Version 6.0.7

Copyright © 2003 Brent R. Matzelle (''bmatzelle AT yahoo DOT com'')
License: LGPL

http://phpmailer.sourceforge.net
https://github.com/PHPMailer/PHPMailer/releases

==PHP Markdown==

''lib/markdown.php''

Functions to convert from the Markdown text format into clean XHTML.

Version: 1.8.0 (with modifications)

* @copyright 2004-2016 Michel Fortin <https://michelf.com/projects/php-markdown/>

* @copyright (Original Markdown) 2004-2006 John Gruber <https://daringfireball.net/projects/markdown/>
All rights reserved.

License: BSD

http://www.michelf.com/projects/php-markdown/

==PHP-ML==

''lib/mlbackend/php/phpml''

Machine learning library used to generate data for the Analytics system.

Version: 0.8.0

* @copyright 2016-2018 Arkadiusz Kondas <arkadiusz.kondas[at]gmail>

License: MIT

https://php-ml.readthedocs.io/

==Popper.js==

"admin/tool/usertours/amd/src/popper.js"

A kickass library used to created Poppers in web applications

Version: 1.12.6

© 2016 Federico Zivolo and contributors

License: MIT

https://github.com/FezVrasta/popper.js

==RTLCSS for PHP==

"lib/rtlcss"

RTLCSS is a framework for converting Left-To-Right (LTR) Cascading Style Sheets(CSS) to Right-To-Left (RTL).

© 2016 Frédéric Massart

License: MIT

https://github.com/moodlehq/rtlcss-php

==RequireJS==

''/lib/requirejs/''

RequireJS is a JavaScript file and module loader.

Version 2.3.5

License: new BSD or MIT

http://requirejs.org/

==scssphp==

''/lib/scssphp/''

scssphp is a compiler for SCSS written in PHP.

Version: 1.0.2

Copyright (c) 2015 Leaf Corcoran

License: MIT

http://leafo.github.io/scssphp

==SimplePie==

"/lib/simplepie"

Simple Pie helps with blogs.

Version 1.5.6

License: BSD

https://github.com/simplepie/simplepie

==Snoopy==

''lib/snoopy''

A PHP net client

Version: 1.0

Copyright © 1999-2000 Monte Ohrt (''monte AT ispi DOT net'')
License: GNU LGPL

http://snoopy.sourceforge.com

(This library is not currently used in Moodle)

==SMTP class==

''lib/class.smtp.php''

Class that can be used to connect and communicate with any SMTP server. It implements all the SMTP functions defined in RFC821 except TURN.

Version: 03/26/2001

Copyright © 2001 Chris Ryan (''chris AT greatbridge DOT com'')

(This library is not currently used in Moodle)

==Spike PHPCoverage==

''lib/spikephpcoverage''

PHP code coverage reporting tool

Version: 0.8.2 (with modifications)

Copyright © 2004 SpikeSource Inc

License: LGPL

http://developer.spikesource.com/projects/phpcoverage

(This library is not currently used in Moodle)

==Spout==

"lib/spout"

Library for importing and exporting csv / excel / ODS files.

Version 3.0.1

License: Apache

https://github.com/box/spout/

==TCPDF Class==

''lib/tcpdf''

Class to generate PDF files

Version: 6.3.5

Copyright Olivier PLATHEY

License: LGPL-v3.0-only

http://www.setasign.com/products/fpdi/downloads

==Typo3 Character Set Class==

''lib/typo3''

Class for conversion between charsets and multibyte-savy operations with strings.

Version: 4.7.19

Copyright © 2003-2005 Kasper Skaarhoj

Licence: GNU GPL

http://typo3.org/

==Video.js==

''amd/src/video-lazy.js''

JavaScript library that makes it easier to work with and build on HTML5 video

Version: 7.10.0

Copyright Brightcove, Inc

Licence: Apache

http://videojs.com/

==XHProf==

''lib/xhprof''

A Hierarchical Profiler for PHP

Version: 0.9.4

Copyright © 2009 Phacility

Licence: Apache

https://github.com/phacility/xhprof

==Yahoo User Interface==

''lib/yui''

The Yahoo! User Interface Library is a set of utilities and controls, in JavaScript, for building richly interactive web applications using techniques such as DOM scripting, DHTML and AJAX. The YUI Library also includes several core CSS resources.Set of user-interface components using AJAX, DHTML etc. We use it for all our AJAX-related stuff.

CVS version: 3.17.2

Copyright (c) 2006, Yahoo! Inc.

Licence: BSD

http://developer.yahoo.com/yui/

[[Category:Credits]]

Moodle libraries credits

2021-05-11T09:03:04Z

Tusefomal: /* MaxMind DB Reader */

Some of Moodle's libraries were written by other people, and are being redistributed as part of Moodle under their respective open source licenses that thankfully allow us to do so. Thanks to the authors of all these excellent products - without them Moodle would be missing important functionality. Copyright information for each package is included below:

==ADOdb==

''lib/adodb''

Database abstraction library for MySQL, PostgreSQL, MSSQL, Oracle, Interbase, Foxpro, Access, ADO, Sybase, DB2 and ODBC.

Version: 5.20.14

@copyright (c) 2000-2013 John Lim (jlim#natsoft.com). All rights reserved.

@copyright (c) 2014 Damien Regad, Mark Newnham and the ADOdb community

License: Dual LGPL and BSD-style

http://adodb.sourceforge.net

==Bennu==

"lib/bennu"

Bennu is an object-oriented library written in PHP that implements the iCalendar standard (RFC 2445).

Version: 0.1 (customized since then)

Copyright (c) 2005, Jon Papaioannou

License: LGPL 2.1+

http://bennu.sourceforge.net/

==Amazon S3==

''repository/s3/S3.php''

A standalone Amazon S3 (REST) client for PHP 5.2.x using CURL that does not require PEAR.

Version: 0.5.1

Copyright (c) 2013, Donovan Schönknecht

License: BSD 2-Clause

https://github.com/tpyo/amazon-s3-php-class/releases

==CAS==

''auth/cas/CAS''

phpCAS library to support CAS authentication plugin

Version: 1.3.7

Copyright Jasig

License: Apache License 2.0

https://wiki.jasig.org/display/CASC/phpCAS

==Chart.js==

''lib/amd/src/chartjs-lazy.js''

Simple yet flexible JavaScript charting for designers & developers

Version: 2.9.4

Copyright 2016 Nick Downie

License: MIT

http://www.chartjs.org

==CodeMirror==

''lib/editor/atto/plugins/html/yui/src/codemirror''

CodeMirror is a versatile text editor implemented in JavaScript for the browser.

Version: 5.59.4

License: MIT

https://github.com/codemirror/CodeMirror

==Emoji-data==

''lib/emoji-data''

Library to parse easily data and spritesheets for emoji

License: MIT

https://github.com/iamcal/emoji-data/

==EvalMath==

''lib/evalmath''

Class to safely evaluate math expressions

Copyright Miles Kaufmann

License: BSD

http://www.twmagic.com/

==Flexitour==

"admin/tool/usertours/amd/src/tour.js"

A JS library for tours

© 2016 Andrew Nicols and contributors

License: GPLv3

https://github.com/andrewnicols/flexitour

==FLV player==

''filter/mediaplugin/flvplayer.swf''

Flash movie to play FLV files

Copyright Jeroen Wijering

License: GNU GPL

http://www.jeroenwijering.com

(This library is not currently used in Moodle)

== GeoIp2 ==

''lib/maxmind/GeoIp2''

Library for processing of GeoIP data files

Version: 2.10.0

Copyright MaxMind

License: Apache 2.0

https://github.com/maxmind/GeoIP2-php

== GeoPattern==

''lib/geopattern-php''

Library for creating beautiful generative background images from a string

Version: 1.1.1

Copyright 2015 Leaf Corcoran

License: MIT

https://github.com/RedeyeGroup/geopattern-php

==Google APIs==

"lib/google"

Library Google APIs Client Library for PHP

Version: 1.1.7

License: Apache License Version 2.0

https://github.com/google/google-api-php-client

==Graph Class==

''lib/graphlib.php''

Class to draw line, point, bar, and area graphs, including numeric x-axis and double y-axis.

Version: 1.6.3 (with modifications)

Copyright © 2000 Herman Veluwenkamp (''hermanV AT mindless DOT com'')

License: LGPL

==H5P==

''lib/h5p''

The general H5P library

Version: 1.24

Copyright © Joubel

License: GPL-3.0

https://github.com/h5p/h5p-php-library/

==Horde==

''lib/horde''

Library used by the inbound e-mail handling system.

Version: 5.2.22

Copyright © Horde LLC

License: LGPL

http://www.horde.org/

==html2text==

''lib/html2text''

PHP script to convert HTML into an approximate text equivalent

Version: 4.3.1

Copyright (c) 2005-2007 Jon Abernathy <jon@chuggnutt.com>

License: GNU GPL

https://github.com/mtibben/html2text.git

==htmlArea==

''lib/editor''

Javascript/HTML script to put a GUI editor in textareas on Internet Explorer and Mozilla

Version: 3.0 beta (with modifications)

Copyright © 2002 interactivetools.com, inc.

License: htmlArea License (based on BSD license)

(This library is not currently used in Moodle)

==HTML Purifier==

"lib/htmlpurifier"

Filters HTML.

Version: 4.13.0

License: LGPL

==IP-Atlas==

''lib/ipatlas''

PHP scripts to show the location of an IP address on a map.

Version: 1.0 (with modifications)

Copyright © 2002 Ivan Kozik

License: GNU GPL

http://www.xpenguin.com/ip-atlas.php

(This library is not currently used in Moodle)

==Jabber - XMPPHP==

''lib/jabber''

PHP library for XMPP (aka Jabber, Google Talk, etc).

Version: 0.1rc2-r77

Copyright: 2008 Nathanael C. Fritz

License: GPL

http://code.google.com/p/xmpphp

==jQuery==

''lib/jquery''

jQuery is a fast, small, and feature-rich JavaScript library widely used on moodle.

Version: 3.4.1

Copyright: 2016 The jQuery Foundation

License: MIT

https://jquery.com

==jQuery migrate==

''lib/jquery/jquery-migrate-1.4.0.js''

Library used migrate older jQuery code to jQuery 3.0.

Version: 1.4.0

Copyright: 2016 The jQuery Foundation and other contributors

License: MIT

https://github.com/jquery/jquery-migrate

(This library is not currently used in Moodle)

==jQuery UI==

''lib/jquery/ui-1.12.1/''

jQuery UI is a set of user interface interactions, effects, widgets, and themes built on top of the jQuery library.

Version: 1.12.1

Copyright: 2016 The jQuery Foundation and other contributors

License: MIT

https://github.com/jquery/jquery-migrate

==JavaScript Beautifier==

''yui/src/beautify''

Beautify HTML code in Atto.

Version: 1.13.0

Copyright (c) 2007-2018 Einar Lielmanis, Liam Newman, and contributors.

License: MIT

https://beautifier.io/

==Services_JSON==

''lib/json''

Allows PHP->JS communication via JSON

Version: 1.3.1

Copyright © 2005 Michal Migurski

License: Modified BSD (GPL-compatible)

http://pear.php.net/pepr/pepr-proposal-show.php?id=198

(This library is not currently used in Moodle)

==JWT==

''lib/php-jwt''

A simple library to encode and decode JSON Web Tokens (JWT) in PHP, conforming to RFC 7519

Version: 5.0.0

Copyright © 2011, Neuman Vong

License: BSD

https://github.com/firebase/php-jwt

==ENUM==

''lib/php-enum''

PHP Enum implementation inspired from SplEnum

Version: 1.7.6

Copyright (c) 2015 My C-Labs

License: MIT

https://github.com/myclabs/php-enum

==kses==

''lib/kses.php''

HTML/XHTML filter that only allows some elements and attributes

Version: 0.2.2

Copyright © 2002, 2003, 2005 Ulf Harnhammar

License: GNU GPL

http://sourceforge.net/projects/kses

(This library is not currently used in Moodle)

==less.php==

The less.php is a PHP port of the official LESS processor used by moodle themes.

''lib/lessphp''

Version: 1.7.0.10

License: Apache 2.0

http://lessphp.typesettercms.com/

Copyright: Matt Agar and Martin Jantošovič

(This library is not currently used in Moodle)

==loglevel.js==

Minimal lightweight simple logging for JavaScript.

Version 1.7.1

Copyright (c) 2019 Tim Perry

License: MIT

https://github.com/pimterry/loglevel/

==LTI Tool Provider Library for PHP==

"lib/ltiprovider/"

PHP library for communicating with learning tools as per the LTI specification.

Version: 3.0.2

© 2016 IMS Global Learning Consortium Inc. All Rights Reserved. Trademark Policy - (www.imsglobal.org/trademarks)

License: Apache 2

https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP

==MathJax==

JavaScript filter library for displaying LaTeX, AsciiMath notation, and MathML.

Not actually included in Moodle. Instead, Moodle [[:en:MathJax filter|has a setting]] for where the library is located to be loaded from. It is currently pointing to the Cloudflare CDN by default.

© Copyright 2009 - 2017 The MathJax Consortium

* Default MathJax version: 2.7.2 (Moodle 3.4)
* License: Apache 2.0
* Homepage: https://www.mathjax.org/

==MatthiasMullie\Minify==
CSS & JavaScript minifier, in PHP

Version 1.3.61

License: MIT

https://github.com/matthiasmullie/minify

==MaxMind DB Reader==
lib/maxmind/MaxMind/

PHP API for reading MaxMind DB files

Version: 1.9.0

Copyright MaxMind

License: Apache 2.0

https://github.com/maxmind/MaxMind-DB-Reader-php/

==mimeTeX==

''filter/tex''

Compiled C program to convert TeX into GIFs

Version: 1.74

Copyright © 2002-2004 John Forkosh Associates, Inc

License: GNU GPL

http://www.forkosh.com/mimetex.html

==Mustache.js==

"lib/amd/src/mustache.js"

JS library for displaying mustache templates.

Version: 3.0.1

Copyright (c) 2009 Chris Wanstrath (Ruby)

Copyright (c) 2010-2014 Jan Lehnardt (JavaScript)

Copyright (c) 2010-2015 The mustache.js community

License: MIT

https://github.com/janl/mustache.js/releases

==Mustache==

"lib/mustache"

PHP library for displaying mustache templates.

Version: 2.12.0

Copyright (c) 2010-2016 Justin Hileman

License: MIT

https://github.com/bobthecow/mustache.php/releases

==mp3player==

''lib/mp3player''

Flash movie to play streaming MP3s

Copyright © 2005 Andrew Walker

License: GNU GPL

(This library is not currently used in Moodle)

==overlibmws==

''lib/overlib.js''

Javascript library to enable DHTML popups, floating windows, events etc

Version: July 2004

Copyright © 2002-2004 Foteos Macrides

Copyright © 1998-2004 Erik Bosrup

License: Artistic Open Source License

http://www.macridesweb.com/oltest/

(This library is not currently used in Moodle)

==PclZip==

''lib/pclzip''

Class to create, manage and unpack zip files.

Version: 2.4 RC1

Copyright © 2004 Vincent Blavet (''vincent AT phpconcept DOT net'')

License: GNU GPL

http://www.phpconcept.net

(This library is not currently used in Moodle)

==PEAR OLE Classes==

''lib/pear''

Class to write Excel files

Version: 0.5

Copyright © 2004 Xavier Noguer

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/OLE

(This library is not currently used in Moodle)

==PEAR Spreadsheet_Excel_Writer==

''lib/pear''

Class to write Excel files

Version: 0.9.1

Copyright © 2004 Xavier Noguer and Mika Tuupola

License: LGPL

http://pear.php.net/package/Spreadsheet_Excel_Writer

(This library is not currently used in Moodle)

==PEAR HTML_Quickform==

''lib/pear''

Class to write forms

Version: 3.2.6

Copyright © 2004 Bertrand Mansion, Adam Daniel, Alexey Borzov

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Quickform

==PEAR HTML_Quickform_Renderer_Tableless==

''lib/pear''

Class to render forms without tables

Version: 0.3.4

Copyright © 2005 Mark Wiesemann

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Quickform_Renderer_Tableless

==PEAR HTML_QuickForm_DHTMLRulesTableless==

''lib/pear''

Class to render validation notices with dhtml

Version: 0.1.2

Copyright © 2005 Alexey Borzov, Adam Daniel, Bertrand Mansion, Justin Patrin, Mark Wiesemann

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_QuickForm_DHTMLRulesTableless

==PEAR HTML_Common==

''lib/pear''

Class with many common HTML functions (used by HTML Quickform)

Version: 0.3.4

Copyright © 2004 Adam Daniel, Bertrand Mansion, Klaus Guenther, Alexey Borzov

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Common

==PEAR XML_Parser==

''lib/pear''

Class implementing one handy (sax-expat) XML parser

Version: 1.3.2

Copyright © 2004-2008 The PHP Group & Stephan Schmidt

License: New BSD License

http://pear.php.net/package/XML_Parser

(This library is not currently used in Moodle)

==PHP-CSS-Parser==

''lib/php-css-parser''

A Parser for CSS Files written in PHP.

Version: 8.3.0

Copyright (c) 2011 Raphael Schweikert, http://sabberworm.com/

License: MIT

https://github.com/sabberworm/PHP-CSS-Parser

==PHPExcel==

''lib/phpexcel/PHPExcel.php''

Library to read, write and create spreadsheet documents in PHP.

Version 1.8.1

Copyright © 2006 - 2015 PHPExcel
License: LGPL

https://github.com/PHPOffice/PHPExcel

(This library is not currently used in Moodle)

==PhpSpreadsheet==

''lib/phpspreadsheet''

Library to read, write and create spreadsheet documents in PHP.

Version 1.7.0

License: LGPL

https://github.com/PHPOffice/PhpSpreadsheet

==PHP mailer==

''lib/class.phpmailer.php''

Class for sending email using either sendmail, PHP mail(), or SMTP. Methods are based upon the standard AspEmail(tm) classes.

Version 6.0.7

Copyright © 2003 Brent R. Matzelle (''bmatzelle AT yahoo DOT com'')
License: LGPL

http://phpmailer.sourceforge.net
https://github.com/PHPMailer/PHPMailer/releases

==PHP Markdown==

''lib/markdown.php''

Functions to convert from the Markdown text format into clean XHTML.

Version: 1.8.0 (with modifications)

* @copyright 2004-2016 Michel Fortin <https://michelf.com/projects/php-markdown/>

* @copyright (Original Markdown) 2004-2006 John Gruber <https://daringfireball.net/projects/markdown/>
All rights reserved.

License: BSD

http://www.michelf.com/projects/php-markdown/

==PHP-ML==

''lib/mlbackend/php/phpml''

Machine learning library used to generate data for the Analytics system.

Version: 0.8.0

* @copyright 2016-2018 Arkadiusz Kondas <arkadiusz.kondas[at]gmail>

License: MIT

https://php-ml.readthedocs.io/

==Popper.js==

"admin/tool/usertours/amd/src/popper.js"

A kickass library used to created Poppers in web applications

Version: 1.12.6

© 2016 Federico Zivolo and contributors

License: MIT

https://github.com/FezVrasta/popper.js

==RTLCSS for PHP==

"lib/rtlcss"

RTLCSS is a framework for converting Left-To-Right (LTR) Cascading Style Sheets(CSS) to Right-To-Left (RTL).

© 2016 Frédéric Massart

License: MIT

https://github.com/moodlehq/rtlcss-php

==RequireJS==

''/lib/requirejs/''

RequireJS is a JavaScript file and module loader.

Version 2.3.5

License: new BSD or MIT

http://requirejs.org/

==scssphp==

''/lib/scssphp/''

scssphp is a compiler for SCSS written in PHP.

Version: 1.0.2

Copyright (c) 2015 Leaf Corcoran

License: MIT

http://leafo.github.io/scssphp

==SimplePie==

"/lib/simplepie"

Simple Pie helps with blogs.

Version 1.5.6

License: BSD

https://github.com/simplepie/simplepie

==Snoopy==

''lib/snoopy''

A PHP net client

Version: 1.0

Copyright © 1999-2000 Monte Ohrt (''monte AT ispi DOT net'')
License: GNU LGPL

http://snoopy.sourceforge.com

(This library is not currently used in Moodle)

==SMTP class==

''lib/class.smtp.php''

Class that can be used to connect and communicate with any SMTP server. It implements all the SMTP functions defined in RFC821 except TURN.

Version: 03/26/2001

Copyright © 2001 Chris Ryan (''chris AT greatbridge DOT com'')

(This library is not currently used in Moodle)

==Spike PHPCoverage==

''lib/spikephpcoverage''

PHP code coverage reporting tool

Version: 0.8.2 (with modifications)

Copyright © 2004 SpikeSource Inc

License: LGPL

http://developer.spikesource.com/projects/phpcoverage

(This library is not currently used in Moodle)

==Spout==

"lib/spout"

Library for importing and exporting csv / excel / ODS files.

Version 3.0.1

License: Apache

https://github.com/box/spout/

==TCPDF Class==

''lib/tcpdf''

Class to generate PDF files

Version: 6.3.5

Copyright Olivier PLATHEY

License: LGPL-v3.0-only

http://www.setasign.com/products/fpdi/downloads

==Typo3 Character Set Class==

''lib/typo3''

Class for conversion between charsets and multibyte-savy operations with strings.

Version: 4.7.19

Copyright © 2003-2005 Kasper Skaarhoj

Licence: GNU GPL

http://typo3.org/

==Video.js==

''amd/src/video-lazy.js''

JavaScript library that makes it easier to work with and build on HTML5 video

Version: 7.10.0

Copyright Brightcove, Inc

Licence: Apache

http://videojs.com/

==XHProf==

''lib/xhprof''

A Hierarchical Profiler for PHP

Version: 0.9.4

Copyright © 2009 Phacility

Licence: Apache

https://github.com/phacility/xhprof

==Yahoo User Interface==

''lib/yui''

The Yahoo! User Interface Library is a set of utilities and controls, in JavaScript, for building richly interactive web applications using techniques such as DOM scripting, DHTML and AJAX. The YUI Library also includes several core CSS resources.Set of user-interface components using AJAX, DHTML etc. We use it for all our AJAX-related stuff.

CVS version: 3.17.2

Copyright (c) 2006, Yahoo! Inc.

Licence: BSD

http://developer.yahoo.com/yui/

[[Category:Credits]]

Moodle libraries credits

2021-05-11T09:01:23Z

Tusefomal: /* Video.js */

Some of Moodle's libraries were written by other people, and are being redistributed as part of Moodle under their respective open source licenses that thankfully allow us to do so. Thanks to the authors of all these excellent products - without them Moodle would be missing important functionality. Copyright information for each package is included below:

==ADOdb==

''lib/adodb''

Database abstraction library for MySQL, PostgreSQL, MSSQL, Oracle, Interbase, Foxpro, Access, ADO, Sybase, DB2 and ODBC.

Version: 5.20.14

@copyright (c) 2000-2013 John Lim (jlim#natsoft.com). All rights reserved.

@copyright (c) 2014 Damien Regad, Mark Newnham and the ADOdb community

License: Dual LGPL and BSD-style

http://adodb.sourceforge.net

==Bennu==

"lib/bennu"

Bennu is an object-oriented library written in PHP that implements the iCalendar standard (RFC 2445).

Version: 0.1 (customized since then)

Copyright (c) 2005, Jon Papaioannou

License: LGPL 2.1+

http://bennu.sourceforge.net/

==Amazon S3==

''repository/s3/S3.php''

A standalone Amazon S3 (REST) client for PHP 5.2.x using CURL that does not require PEAR.

Version: 0.5.1

Copyright (c) 2013, Donovan Schönknecht

License: BSD 2-Clause

https://github.com/tpyo/amazon-s3-php-class/releases

==CAS==

''auth/cas/CAS''

phpCAS library to support CAS authentication plugin

Version: 1.3.7

Copyright Jasig

License: Apache License 2.0

https://wiki.jasig.org/display/CASC/phpCAS

==Chart.js==

''lib/amd/src/chartjs-lazy.js''

Simple yet flexible JavaScript charting for designers & developers

Version: 2.9.4

Copyright 2016 Nick Downie

License: MIT

http://www.chartjs.org

==CodeMirror==

''lib/editor/atto/plugins/html/yui/src/codemirror''

CodeMirror is a versatile text editor implemented in JavaScript for the browser.

Version: 5.59.4

License: MIT

https://github.com/codemirror/CodeMirror

==Emoji-data==

''lib/emoji-data''

Library to parse easily data and spritesheets for emoji

License: MIT

https://github.com/iamcal/emoji-data/

==EvalMath==

''lib/evalmath''

Class to safely evaluate math expressions

Copyright Miles Kaufmann

License: BSD

http://www.twmagic.com/

==Flexitour==

"admin/tool/usertours/amd/src/tour.js"

A JS library for tours

© 2016 Andrew Nicols and contributors

License: GPLv3

https://github.com/andrewnicols/flexitour

==FLV player==

''filter/mediaplugin/flvplayer.swf''

Flash movie to play FLV files

Copyright Jeroen Wijering

License: GNU GPL

http://www.jeroenwijering.com

(This library is not currently used in Moodle)

== GeoIp2 ==

''lib/maxmind/GeoIp2''

Library for processing of GeoIP data files

Version: 2.10.0

Copyright MaxMind

License: Apache 2.0

https://github.com/maxmind/GeoIP2-php

== GeoPattern==

''lib/geopattern-php''

Library for creating beautiful generative background images from a string

Version: 1.1.1

Copyright 2015 Leaf Corcoran

License: MIT

https://github.com/RedeyeGroup/geopattern-php

==Google APIs==

"lib/google"

Library Google APIs Client Library for PHP

Version: 1.1.7

License: Apache License Version 2.0

https://github.com/google/google-api-php-client

==Graph Class==

''lib/graphlib.php''

Class to draw line, point, bar, and area graphs, including numeric x-axis and double y-axis.

Version: 1.6.3 (with modifications)

Copyright © 2000 Herman Veluwenkamp (''hermanV AT mindless DOT com'')

License: LGPL

==H5P==

''lib/h5p''

The general H5P library

Version: 1.24

Copyright © Joubel

License: GPL-3.0

https://github.com/h5p/h5p-php-library/

==Horde==

''lib/horde''

Library used by the inbound e-mail handling system.

Version: 5.2.22

Copyright © Horde LLC

License: LGPL

http://www.horde.org/

==html2text==

''lib/html2text''

PHP script to convert HTML into an approximate text equivalent

Version: 4.3.1

Copyright (c) 2005-2007 Jon Abernathy <jon@chuggnutt.com>

License: GNU GPL

https://github.com/mtibben/html2text.git

==htmlArea==

''lib/editor''

Javascript/HTML script to put a GUI editor in textareas on Internet Explorer and Mozilla

Version: 3.0 beta (with modifications)

Copyright © 2002 interactivetools.com, inc.

License: htmlArea License (based on BSD license)

(This library is not currently used in Moodle)

==HTML Purifier==

"lib/htmlpurifier"

Filters HTML.

Version: 4.13.0

License: LGPL

==IP-Atlas==

''lib/ipatlas''

PHP scripts to show the location of an IP address on a map.

Version: 1.0 (with modifications)

Copyright © 2002 Ivan Kozik

License: GNU GPL

http://www.xpenguin.com/ip-atlas.php

(This library is not currently used in Moodle)

==Jabber - XMPPHP==

''lib/jabber''

PHP library for XMPP (aka Jabber, Google Talk, etc).

Version: 0.1rc2-r77

Copyright: 2008 Nathanael C. Fritz

License: GPL

http://code.google.com/p/xmpphp

==jQuery==

''lib/jquery''

jQuery is a fast, small, and feature-rich JavaScript library widely used on moodle.

Version: 3.4.1

Copyright: 2016 The jQuery Foundation

License: MIT

https://jquery.com

==jQuery migrate==

''lib/jquery/jquery-migrate-1.4.0.js''

Library used migrate older jQuery code to jQuery 3.0.

Version: 1.4.0

Copyright: 2016 The jQuery Foundation and other contributors

License: MIT

https://github.com/jquery/jquery-migrate

(This library is not currently used in Moodle)

==jQuery UI==

''lib/jquery/ui-1.12.1/''

jQuery UI is a set of user interface interactions, effects, widgets, and themes built on top of the jQuery library.

Version: 1.12.1

Copyright: 2016 The jQuery Foundation and other contributors

License: MIT

https://github.com/jquery/jquery-migrate

==JavaScript Beautifier==

''yui/src/beautify''

Beautify HTML code in Atto.

Version: 1.13.0

Copyright (c) 2007-2018 Einar Lielmanis, Liam Newman, and contributors.

License: MIT

https://beautifier.io/

==Services_JSON==

''lib/json''

Allows PHP->JS communication via JSON

Version: 1.3.1

Copyright © 2005 Michal Migurski

License: Modified BSD (GPL-compatible)

http://pear.php.net/pepr/pepr-proposal-show.php?id=198

(This library is not currently used in Moodle)

==JWT==

''lib/php-jwt''

A simple library to encode and decode JSON Web Tokens (JWT) in PHP, conforming to RFC 7519

Version: 5.0.0

Copyright © 2011, Neuman Vong

License: BSD

https://github.com/firebase/php-jwt

==ENUM==

''lib/php-enum''

PHP Enum implementation inspired from SplEnum

Version: 1.7.6

Copyright (c) 2015 My C-Labs

License: MIT

https://github.com/myclabs/php-enum

==kses==

''lib/kses.php''

HTML/XHTML filter that only allows some elements and attributes

Version: 0.2.2

Copyright © 2002, 2003, 2005 Ulf Harnhammar

License: GNU GPL

http://sourceforge.net/projects/kses

(This library is not currently used in Moodle)

==less.php==

The less.php is a PHP port of the official LESS processor used by moodle themes.

''lib/lessphp''

Version: 1.7.0.10

License: Apache 2.0

http://lessphp.typesettercms.com/

Copyright: Matt Agar and Martin Jantošovič

(This library is not currently used in Moodle)

==loglevel.js==

Minimal lightweight simple logging for JavaScript.

Version 1.7.1

Copyright (c) 2019 Tim Perry

License: MIT

https://github.com/pimterry/loglevel/

==LTI Tool Provider Library for PHP==

"lib/ltiprovider/"

PHP library for communicating with learning tools as per the LTI specification.

Version: 3.0.2

© 2016 IMS Global Learning Consortium Inc. All Rights Reserved. Trademark Policy - (www.imsglobal.org/trademarks)

License: Apache 2

https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP

==MathJax==

JavaScript filter library for displaying LaTeX, AsciiMath notation, and MathML.

Not actually included in Moodle. Instead, Moodle [[:en:MathJax filter|has a setting]] for where the library is located to be loaded from. It is currently pointing to the Cloudflare CDN by default.

© Copyright 2009 - 2017 The MathJax Consortium

* Default MathJax version: 2.7.2 (Moodle 3.4)
* License: Apache 2.0
* Homepage: https://www.mathjax.org/

==MatthiasMullie\Minify==
CSS & JavaScript minifier, in PHP

Version 1.3.61

License: MIT

https://github.com/matthiasmullie/minify

==MaxMind DB Reader==
lib/maxmind/MaxMind/

PHP API for reading MaxMind DB files

Version: 1.5.1

Copyright MaxMind

License: Apache 2.0

https://github.com/maxmind/MaxMind-DB-Reader-php/

==mimeTeX==

''filter/tex''

Compiled C program to convert TeX into GIFs

Version: 1.74

Copyright © 2002-2004 John Forkosh Associates, Inc

License: GNU GPL

http://www.forkosh.com/mimetex.html

==Mustache.js==

"lib/amd/src/mustache.js"

JS library for displaying mustache templates.

Version: 3.0.1

Copyright (c) 2009 Chris Wanstrath (Ruby)

Copyright (c) 2010-2014 Jan Lehnardt (JavaScript)

Copyright (c) 2010-2015 The mustache.js community

License: MIT

https://github.com/janl/mustache.js/releases

==Mustache==

"lib/mustache"

PHP library for displaying mustache templates.

Version: 2.12.0

Copyright (c) 2010-2016 Justin Hileman

License: MIT

https://github.com/bobthecow/mustache.php/releases

==mp3player==

''lib/mp3player''

Flash movie to play streaming MP3s

Copyright © 2005 Andrew Walker

License: GNU GPL

(This library is not currently used in Moodle)

==overlibmws==

''lib/overlib.js''

Javascript library to enable DHTML popups, floating windows, events etc

Version: July 2004

Copyright © 2002-2004 Foteos Macrides

Copyright © 1998-2004 Erik Bosrup

License: Artistic Open Source License

http://www.macridesweb.com/oltest/

(This library is not currently used in Moodle)

==PclZip==

''lib/pclzip''

Class to create, manage and unpack zip files.

Version: 2.4 RC1

Copyright © 2004 Vincent Blavet (''vincent AT phpconcept DOT net'')

License: GNU GPL

http://www.phpconcept.net

(This library is not currently used in Moodle)

==PEAR OLE Classes==

''lib/pear''

Class to write Excel files

Version: 0.5

Copyright © 2004 Xavier Noguer

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/OLE

(This library is not currently used in Moodle)

==PEAR Spreadsheet_Excel_Writer==

''lib/pear''

Class to write Excel files

Version: 0.9.1

Copyright © 2004 Xavier Noguer and Mika Tuupola

License: LGPL

http://pear.php.net/package/Spreadsheet_Excel_Writer

(This library is not currently used in Moodle)

==PEAR HTML_Quickform==

''lib/pear''

Class to write forms

Version: 3.2.6

Copyright © 2004 Bertrand Mansion, Adam Daniel, Alexey Borzov

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Quickform

==PEAR HTML_Quickform_Renderer_Tableless==

''lib/pear''

Class to render forms without tables

Version: 0.3.4

Copyright © 2005 Mark Wiesemann

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Quickform_Renderer_Tableless

==PEAR HTML_QuickForm_DHTMLRulesTableless==

''lib/pear''

Class to render validation notices with dhtml

Version: 0.1.2

Copyright © 2005 Alexey Borzov, Adam Daniel, Bertrand Mansion, Justin Patrin, Mark Wiesemann

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_QuickForm_DHTMLRulesTableless

==PEAR HTML_Common==

''lib/pear''

Class with many common HTML functions (used by HTML Quickform)

Version: 0.3.4

Copyright © 2004 Adam Daniel, Bertrand Mansion, Klaus Guenther, Alexey Borzov

License: PHP (plus special exemption for Moodle to make it compatible)

http://pear.php.net/package/HTML_Common

==PEAR XML_Parser==

''lib/pear''

Class implementing one handy (sax-expat) XML parser

Version: 1.3.2

Copyright © 2004-2008 The PHP Group & Stephan Schmidt

License: New BSD License

http://pear.php.net/package/XML_Parser

(This library is not currently used in Moodle)

==PHP-CSS-Parser==

''lib/php-css-parser''

A Parser for CSS Files written in PHP.

Version: 8.3.0

Copyright (c) 2011 Raphael Schweikert, http://sabberworm.com/

License: MIT

https://github.com/sabberworm/PHP-CSS-Parser

==PHPExcel==

''lib/phpexcel/PHPExcel.php''

Library to read, write and create spreadsheet documents in PHP.

Version 1.8.1

Copyright © 2006 - 2015 PHPExcel
License: LGPL

https://github.com/PHPOffice/PHPExcel

(This library is not currently used in Moodle)

==PhpSpreadsheet==

''lib/phpspreadsheet''

Library to read, write and create spreadsheet documents in PHP.

Version 1.7.0

License: LGPL

https://github.com/PHPOffice/PhpSpreadsheet

==PHP mailer==

''lib/class.phpmailer.php''

Class for sending email using either sendmail, PHP mail(), or SMTP. Methods are based upon the standard AspEmail(tm) classes.

Version 6.0.7

Copyright © 2003 Brent R. Matzelle (''bmatzelle AT yahoo DOT com'')
License: LGPL

http://phpmailer.sourceforge.net
https://github.com/PHPMailer/PHPMailer/releases

==PHP Markdown==

''lib/markdown.php''

Functions to convert from the Markdown text format into clean XHTML.

Version: 1.8.0 (with modifications)

* @copyright 2004-2016 Michel Fortin <https://michelf.com/projects/php-markdown/>

* @copyright (Original Markdown) 2004-2006 John Gruber <https://daringfireball.net/projects/markdown/>
All rights reserved.

License: BSD

http://www.michelf.com/projects/php-markdown/

==PHP-ML==

''lib/mlbackend/php/phpml''

Machine learning library used to generate data for the Analytics system.

Version: 0.8.0

* @copyright 2016-2018 Arkadiusz Kondas <arkadiusz.kondas[at]gmail>

License: MIT

https://php-ml.readthedocs.io/

==Popper.js==

"admin/tool/usertours/amd/src/popper.js"

A kickass library used to created Poppers in web applications

Version: 1.12.6

© 2016 Federico Zivolo and contributors

License: MIT

https://github.com/FezVrasta/popper.js

==RTLCSS for PHP==

"lib/rtlcss"

RTLCSS is a framework for converting Left-To-Right (LTR) Cascading Style Sheets(CSS) to Right-To-Left (RTL).

© 2016 Frédéric Massart

License: MIT

https://github.com/moodlehq/rtlcss-php

==RequireJS==

''/lib/requirejs/''

RequireJS is a JavaScript file and module loader.

Version 2.3.5

License: new BSD or MIT

http://requirejs.org/

==scssphp==

''/lib/scssphp/''

scssphp is a compiler for SCSS written in PHP.

Version: 1.0.2

Copyright (c) 2015 Leaf Corcoran

License: MIT

http://leafo.github.io/scssphp

==SimplePie==

"/lib/simplepie"

Simple Pie helps with blogs.

Version 1.5.6

License: BSD

https://github.com/simplepie/simplepie

==Snoopy==

''lib/snoopy''

A PHP net client

Version: 1.0

Copyright © 1999-2000 Monte Ohrt (''monte AT ispi DOT net'')
License: GNU LGPL

http://snoopy.sourceforge.com

(This library is not currently used in Moodle)

==SMTP class==

''lib/class.smtp.php''

Class that can be used to connect and communicate with any SMTP server. It implements all the SMTP functions defined in RFC821 except TURN.

Version: 03/26/2001

Copyright © 2001 Chris Ryan (''chris AT greatbridge DOT com'')

(This library is not currently used in Moodle)

==Spike PHPCoverage==

''lib/spikephpcoverage''

PHP code coverage reporting tool

Version: 0.8.2 (with modifications)

Copyright © 2004 SpikeSource Inc

License: LGPL

http://developer.spikesource.com/projects/phpcoverage

(This library is not currently used in Moodle)

==Spout==

"lib/spout"

Library for importing and exporting csv / excel / ODS files.

Version 3.0.1

License: Apache

https://github.com/box/spout/

==TCPDF Class==

''lib/tcpdf''

Class to generate PDF files

Version: 6.3.5

Copyright Olivier PLATHEY

License: LGPL-v3.0-only

http://www.setasign.com/products/fpdi/downloads

==Typo3 Character Set Class==

''lib/typo3''

Class for conversion between charsets and multibyte-savy operations with strings.

Version: 4.7.19

Copyright © 2003-2005 Kasper Skaarhoj

Licence: GNU GPL

http://typo3.org/

==Video.js==

''amd/src/video-lazy.js''

JavaScript library that makes it easier to work with and build on HTML5 video

Version: 7.10.0

Copyright Brightcove, Inc

Licence: Apache

http://videojs.com/

==XHProf==

''lib/xhprof''

A Hierarchical Profiler for PHP

Version: 0.9.4

Copyright © 2009 Phacility

Licence: Apache

https://github.com/phacility/xhprof

==Yahoo User Interface==

''lib/yui''

The Yahoo! User Interface Library is a set of utilities and controls, in JavaScript, for building richly interactive web applications using techniques such as DOM scripting, DHTML and AJAX. The YUI Library also includes several core CSS resources.Set of user-interface components using AJAX, DHTML etc. We use it for all our AJAX-related stuff.

CVS version: 3.17.2

Copyright (c) 2006, Yahoo! Inc.

Licence: BSD

http://developer.yahoo.com/yui/

[[Category:Credits]]

Moodle Development kit

2020-11-04T11:55:50Z

Tusefomal: /* 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 instance where you have 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]]

Experience API (xAPI)

2020-05-28T15:51:23Z

Tusefomal: /* Useful methods to handle xAPI statements inside plugins */

== Heading text ==

This document contains a technical explanation on how the xAPI Moodle integration library works. The main purpose of this document is to keep the dev documentation while the oficial Dev Wiki page is not yet created.

The '''Experience API (xAPI)''' is an e-learning software specification that allows learning content and learning systems to speak to each other in a manner that records and tracks all types of learning experiences.

xAPI defines web services that can be used by any plugin or APP to connect to the LMS in a standard way. The main actors in xAPI communication are:

* '''Client''': any plugin or APP that wants to use xAPI webservices
* '''xAPI LRS''' (server site): responsible for storing and serve the data emitted by the clients

One good aspect about xAPI is that the amount of messages that can be shared between the clients and the LRS is quite limited. The main message type is called '''Statement''' and all statements can be summarized as “''An actor XX executes action YY on object ZZ''”.

The typical statement object is a JSON element containing:

* '''Actor''': the person or group that do something
* '''Verb''': the action the Actor do
* '''Object''': the object on the Verb is executed. There are more than one type of objects that can be defined here but, for now, you can think about it as a specific “Quiz Attempt” for example.
* Other fields: for now, the rest of xAPI fields have a basic data validation so every plugin is responsible for implementing it’s own checks if they need them.
The xAPI specification can be consulted in the xAPI specs page: [https://github.com/adlnet/xAPI-Spec].

== Moodle xAPI functionalities ==

The final objective of Moodle xAPI library is NOT to implement a full LRS inside Moodle but to provide an easy way to handle xAPI statements within any plugin that needs it.

For now Moodle will focus on supporting the main xAPI request which is called “'''statement'''”. A statement must be seen as a tracking message that can be used by any plugin to store user activity directly to the Moodle without programming any additional web service.

The current library implements:

* A new webservice called '''core_xapi_statement_post''' to process xAPI statements and generate standard Moodle events.
* A class '''\core_xapi\handler''' that any plugin can extend in order to user xAPI and generate specific plugin contexts. This way any plugin could use xAPI without implementing any new web service.
* A class '''\core_xapi\iri''' to easily translate random information into valid IRI values (needed for xAPI objects and verbs)
* A class '''\core_xapi\local\statement''' to create and extract information from statement data.
* A bunch of predefined classes in '''\core_xapi\local\statement\item_XXX''' to generate xAPI statement items from the plugins (exemple provided in “Generating statements in PHP”).

== Statement processing ==

The '''core_xapi_statement_post''' webservice receives a JSON encoded statement (could be an array or a single one) and a component frankenstyle name.

The processing sequence is:
# The core xAPI library checks if the specified component has a xAPI handling class implementation. Otherwise it returns an error.
# xAPI checks the statement structure, if any check fails, it returns an error. The main validations for now are:
## Check that only supported xAPI attributes are used. If the statement array has some format error all statements will be rejected (see “Statement data validation” for more information).
## Check all users and groups are created in the LMS
## Check the current user ($USER) is an actor of the statement (actors can be a single agent or a group)
# For every statement:
## xAPI asks the component handler to convert the statement into a standard event (function statement_to_event). In case the plugin could not convert some statement into an event, this statement will be marked as “not processed” and will continue to the next statement.
## xAPI triggers the generated events
# Once all statements are processed:
## If ALL statements are marked as “not processed” it returns an error.
## If some statement could be processed, returns an array containing “true” if the statement is processed and “false” otherwise.

Note that the plugin “statement_to_event” is responsible for:
* Grant that the specified user has permission to execute that statement.
* Provide a valid Moodle event to trigger
* Process any result attached to the statement

== Statement data validation ==

The core_xapi_statement_post webservice will reject and statements batch that does not comply with the above xAPI data validation:

* '''actor''': this is a mandatory field. Actor objectType attribute must be “Agent” or “Group”
** '''agent''': agent can be only real moodle users and must be identified by account (user id as name and wwwroot as homepage) or mbox (user email). The other agent identifiers are not supported (mbox_sha1sum and openid).
** '''group''': all groups must be real moodle groups identified by account (group id as name and wwwroot as homepage). Anonymous groups are not supported.
* '''verb''': this is a mandatory field. Verb id must be provided in a valid IRI format.
* '''object''': this is a mandatory field. The objectType attribute can be “Agent”, “Group” ar “Activity”:
** '''agent''' or '''group''': both have the same restrictions as when they act as actors.
** '''activity''': activity id must be provided as a valid IRI format.
*** '''definition''': in case a definition is provided, the only accepted interaction types are: choice, fill-in, long-fill-in, true-false, matching, performance, sequencing, likert, numeric, compound and other.
* '''result''': in case it is provided the duration must be provided in a valid ISO 8601 compatible with the PHP DateInterval class (More info: https://bugs.php.net/bug.php?id=53831).
** '''score''': all score fields are optional and do not have any particular data validation.
* '''context''': it has no specific validation.
* '''attachments''': if present must be an array of elements and every element must have: usageType, display, contentType, a valid usageType IRI, a numeric length and a sha2.
* '''authority''': must be a valid xAPI actor.
* '''timestamp''', '''stored''' and '''version''': those optional fields are just strings with no particular validation or usage for now.

== Generating statements in PHP ==

The xAPI library provides classes to translate Moodle elements into xAPI structures. Those statements could be sent to JS via the “$PAGE->requires->data_for_js” method.

The next example shows how to generate a basic statement:

use core_xapi\local\statement;
use core_xapi\local\statement\item_actor;
use core_xapi\local\statement\item_verb;
use core_xapi\local\statement\item_activity;

(...)
// Generate statement.
$statement = new statement();
$statement->set_actor(item_agent::create_from_user($USER));
$statement->set_verb(item_verb::create_from_id('bake'));
$statement->set_object(item_activity::create_from_id('cake'));

As can be seen in the example, the function item_agent has a static method to generate a valid xAPI actor from a user record. The result object of executing that code will be something like:

{
"actor": {
"objectType": "Agent",
"account": {
"homePage": "http:\/\/localhost\/m\/H5P",
"name": "2"
}
},
"verb": {
"id": "http:\/\/localhost\/m\/H5P\/xapi\/verb\/bake"
},
"object": {
"objectType": "Activity",
"id": "http:\/\/localhost\/m\/H5P\/xapi\/object\/cake"
}
}

For the object and verbs, xAPI uses a standard IRI format. The xAPI library will convert any string into a valid IRI but it can also use real IRI identifiers to generate standard verbs and object structures.

The next example is more a less the same but using valid IRI values for verbs and objects:

use core_xapi\local\statement;
use core_xapi\local\statement\item_actor;
use core_xapi\local\statement\item_verb;
use core_xapi\local\statement\item_activity;

(...)
// Generate statement.
$statement = new statement();
$statement->set_actor(item_agent::create_from_user($USER));
$statement->set_verb(item_verb::create_from_id('http://adlnet.gov/xapi/verbs/bake'));
$statement->set_object(item_activity::create_from_id('http://adlnet.gov/xapi/activities/cake'));

The resulting structure will be:

{
"actor": {
"objectType": "Agent",
"account": {
"homePage": "http:\/\/localhost\/m\/H5P",
"name": "2"
}
},
"verb": {
"id": "http:\/\/adlnet.gov\/xapi\/verbs\/bake"
},
"object": {
"objectType": "Activity",
"id": "http:\/\/adlnet.gov\/xapi\/activities\/cake"
}
}

The xAPI library also provides classes to convert moodle groups into valid xAPI group actors. To generate one the code is as following:

use core_xapi\local\statement;
use core_xapi\local\statement\item_actor;
use core_xapi\local\statement\item_verb;
use core_xapi\local\statement\item_activity;

(...)
// Generate statement.
$group = groups_get_group($groupid);
$statement = new statement();
$statement->set_actor(item_group::create_from_group($group));
$statement->set_verb(item_verb::create_from_id('bake'));
$statement->set_object(item_activity::create_from_id('cake'));

The result will be:

{
"actor": {
"objectType": "Group",
"name": "Group A",
"account": {
"homePage": "http:\/\/localhost\/m\/H5P",
"name": "1"
}
},
"verb": {
"id": "http:\/\/localhost\/m\/H5P\/xapi\/verb\/bake"
},
"object": {
"objectType": "Activity",
"id": "http:\/\/localhost\/m\/H5P\/xapi\/object\/cake"
}
}

== xAPI statements attributes implementation ==

All xAPI statement attributes have it’s own implementation in case any plugin needs them. All classes are implemented in the namespace “core_xapi\local\statement”, Those are the classes implemented:

* Item: all xAPI attributes derived from this class. This class provides a method to generate a valid item from a xAPI data structure (create_from_data), implements de json serialization and provides the basic “get_data” method to access the raw element data structure.
** Item_actor: this is an abstract class extended by both two xAPI valid actors:
*** Item_agent: an individual user. The class has a static method called “create_from_user” to generate a valid xAPI actor from a moodle user record.
*** Item_group: a group statement. Moodle xAPI implementation only accepts named groups (it will reject any anonymous group). To generate a valid xAPI group from a moodle group the class has a static method called “create_from_group”. It also provides methods to get all moodle users from that group (get_all_users) and the group record itself (get_group).
** Item_verb: represents the statement verb. The class has a static method “create_from_id” which accepts both valid IRI values or any random string to create a valid xAPI verb structure. IT algo has a method to get back the verb value (get_id).
** Item_object: this is an abstract class extended by all possible xAPI valid objects:
*** Item_agent or Item_group: both can be statements actor or objects as well
*** Item_activity: activity can be any kind of string value which the plugin decides. It has the same methods as item_verb to create and get this value (“create_from_id” and “get_id”). The xAPI activity could have also an atribute called “definition” that contains a SCORM like data defining the user interaction.
**** Item_definition: contains all the specific interaction details such as the interaction type (in SCORM format), the user answer or the correct answer pattern.
** Item_result: this optional attribute represents any kind of results and score derived from the user interaction. IT has no strict data validation and it has to be created directly from a valid xAPI data structure using the method “create_from_data”. It provides two methods to get the result score if present (get_score) and one to convert the result duration into seconds (get_duration). It uses also one subclass to handle score:
** Item_score: the class representing the xAPI score data. It has no validation and no specific methods.
** Item_context: the class representing the xAPI context data. It has no validation and no specific methods.
** Item_attachment: validate the xAPI attachment structure

== Adapting a plugin to use xAPI functions ==

All the plugins could use the new xAPI functionalities to send xAPI statements, interact with them, trigger events and generate log store entries.

=== Step 1: program a xapi handle class ===

Implement a class “\PLUGINNAME\classes\xapi\handler” which extends “\core_xapi\handler” and override this methods:

* '''statement_to_event (statement $statement): core\event\base''': to convert a statement into a valid Moodle event
* In case that the plugin wants to accept also Group statements (by default any Group statement will be rejected) it can override the method supports_group_actors(): bool

=== Step 2: code events ===

All xAPI statements MUST be converted into a valid Moodle event. To do so the plugin needs to '''code all the necessary events''' for this.

== Useful methods to handle xAPI statements inside plugins ==

The core_xapi\local\statement provides several methods to extract information from a statement object.

* '''get_user (): stdClass'''
** Return the Moodle user represented by the statement actor. In the case of a group actor, this function will throw an xapi_exception.
* '''get_all_users(): array'''
** Will return an array with all Moodle users represented in the xAPI actor object. This can be used in both single agent and group statements.
* '''get_group(): stdClass'''
** Return the Moodle group record represented in the xAPI actor. In the case of a single agent actor, this function will throw an xapi_exception.
* '''get_verb_id (): string'''
** Return the current verb ID value from a statement.
* '''get_activity_id(): string'''
** Return the current activity ID. If the statement object is not an activity (could be also an agent or a group) the method will throw an xapi_exception.
* '''minify (): ?array'''
** Return a minified version of the statement suitable for using as a “other” field of a Moodle event.
* '''get_actor(): item_actor'''
** Return the statement actor.
* '''get_verb(): item_verb'''
** Return the statement verb.
* '''get_object(): item_object'''
** Return the statement object.
* '''get_context(): item_context'''
** Return the statement context attribute.
* '''get_result(): item_result'''
** Return the statement result attribute.
* '''get_timestamp(): string'''
** Return the statement timestamp attribute.
* '''get_stored(): string'''
** Return the statement stored attribute.
* '''get_authority(): item_actor'''
** Return the statement authority attribute.
* '''get_version(): string'''
** Return the statement version attribute.
* '''get_attachments(): item_attachment'''
** Return the statement attachments attribute.

== Using Ajax lib to send a statement to Moodle ==

The webservices have a different behaviour depending if it is processing a single statement or an array of them.

This code could be an example of a single xAPI statement post JS code:

require(['core/ajax'], function(ajax) {
var data = {
component: 'mod_h5p',
requestjson: JSON.stringify(statement)
};
var promises = ajax.call([
{
methodname: 'core_xapi_statement_post',
args: data
}
]);
promises[0].done(function(response) {
// Put some success messages...
}).fail(function(ex) {
// Do some failure message handling...
});
});

On the other hand, if you send more than one statement, the webservice will return an array of booleans indicating which statements are successfully stored and which not. Only in the case of none of the statements could be processed (usually because of an invalid statement structure) the webservice will return an error.

This could be an example of sending more than one statement to Moodle:

require(['core/ajax'], function(ajax) {
var data = {
component: 'mod_h5p',
requestjson: JSON.stringify(statements)
};
var promises = ajax.call([
{
methodname: 'core_xapi_statement_post',
args: data
}
]);
promises[0].done(function(response) {
// Check if it's a success or not.
for (var i = 0; i < response.length; i++) {
if (response[i]) {
// Do some success handling.
} else {
// Do some failure handling.
}
}
}).fail(function(ex) {
// None of the statements are processed.
});
});

Experience API (xAPI)

2020-05-28T15:50:09Z

Tusefomal: Created page with "== Heading text == This document contains a technical explanation on how the xAPI Moodle integration library works. The main purpose of this document is to keep the dev docum..."

== Heading text ==

This document contains a technical explanation on how the xAPI Moodle integration library works. The main purpose of this document is to keep the dev documentation while the oficial Dev Wiki page is not yet created.

The '''Experience API (xAPI)''' is an e-learning software specification that allows learning content and learning systems to speak to each other in a manner that records and tracks all types of learning experiences.

xAPI defines web services that can be used by any plugin or APP to connect to the LMS in a standard way. The main actors in xAPI communication are:

* '''Client''': any plugin or APP that wants to use xAPI webservices
* '''xAPI LRS''' (server site): responsible for storing and serve the data emitted by the clients

One good aspect about xAPI is that the amount of messages that can be shared between the clients and the LRS is quite limited. The main message type is called '''Statement''' and all statements can be summarized as “''An actor XX executes action YY on object ZZ''”.

The typical statement object is a JSON element containing:

* '''Actor''': the person or group that do something
* '''Verb''': the action the Actor do
* '''Object''': the object on the Verb is executed. There are more than one type of objects that can be defined here but, for now, you can think about it as a specific “Quiz Attempt” for example.
* Other fields: for now, the rest of xAPI fields have a basic data validation so every plugin is responsible for implementing it’s own checks if they need them.
The xAPI specification can be consulted in the xAPI specs page: [https://github.com/adlnet/xAPI-Spec].

== Moodle xAPI functionalities ==

The final objective of Moodle xAPI library is NOT to implement a full LRS inside Moodle but to provide an easy way to handle xAPI statements within any plugin that needs it.

For now Moodle will focus on supporting the main xAPI request which is called “'''statement'''”. A statement must be seen as a tracking message that can be used by any plugin to store user activity directly to the Moodle without programming any additional web service.

The current library implements:

* A new webservice called '''core_xapi_statement_post''' to process xAPI statements and generate standard Moodle events.
* A class '''\core_xapi\handler''' that any plugin can extend in order to user xAPI and generate specific plugin contexts. This way any plugin could use xAPI without implementing any new web service.
* A class '''\core_xapi\iri''' to easily translate random information into valid IRI values (needed for xAPI objects and verbs)
* A class '''\core_xapi\local\statement''' to create and extract information from statement data.
* A bunch of predefined classes in '''\core_xapi\local\statement\item_XXX''' to generate xAPI statement items from the plugins (exemple provided in “Generating statements in PHP”).

== Statement processing ==

The '''core_xapi_statement_post''' webservice receives a JSON encoded statement (could be an array or a single one) and a component frankenstyle name.

The processing sequence is:
# The core xAPI library checks if the specified component has a xAPI handling class implementation. Otherwise it returns an error.
# xAPI checks the statement structure, if any check fails, it returns an error. The main validations for now are:
## Check that only supported xAPI attributes are used. If the statement array has some format error all statements will be rejected (see “Statement data validation” for more information).
## Check all users and groups are created in the LMS
## Check the current user ($USER) is an actor of the statement (actors can be a single agent or a group)
# For every statement:
## xAPI asks the component handler to convert the statement into a standard event (function statement_to_event). In case the plugin could not convert some statement into an event, this statement will be marked as “not processed” and will continue to the next statement.
## xAPI triggers the generated events
# Once all statements are processed:
## If ALL statements are marked as “not processed” it returns an error.
## If some statement could be processed, returns an array containing “true” if the statement is processed and “false” otherwise.

Note that the plugin “statement_to_event” is responsible for:
* Grant that the specified user has permission to execute that statement.
* Provide a valid Moodle event to trigger
* Process any result attached to the statement

== Statement data validation ==

The core_xapi_statement_post webservice will reject and statements batch that does not comply with the above xAPI data validation:

* '''actor''': this is a mandatory field. Actor objectType attribute must be “Agent” or “Group”
** '''agent''': agent can be only real moodle users and must be identified by account (user id as name and wwwroot as homepage) or mbox (user email). The other agent identifiers are not supported (mbox_sha1sum and openid).
** '''group''': all groups must be real moodle groups identified by account (group id as name and wwwroot as homepage). Anonymous groups are not supported.
* '''verb''': this is a mandatory field. Verb id must be provided in a valid IRI format.
* '''object''': this is a mandatory field. The objectType attribute can be “Agent”, “Group” ar “Activity”:
** '''agent''' or '''group''': both have the same restrictions as when they act as actors.
** '''activity''': activity id must be provided as a valid IRI format.
*** '''definition''': in case a definition is provided, the only accepted interaction types are: choice, fill-in, long-fill-in, true-false, matching, performance, sequencing, likert, numeric, compound and other.
* '''result''': in case it is provided the duration must be provided in a valid ISO 8601 compatible with the PHP DateInterval class (More info: https://bugs.php.net/bug.php?id=53831).
** '''score''': all score fields are optional and do not have any particular data validation.
* '''context''': it has no specific validation.
* '''attachments''': if present must be an array of elements and every element must have: usageType, display, contentType, a valid usageType IRI, a numeric length and a sha2.
* '''authority''': must be a valid xAPI actor.
* '''timestamp''', '''stored''' and '''version''': those optional fields are just strings with no particular validation or usage for now.

== Generating statements in PHP ==

The xAPI library provides classes to translate Moodle elements into xAPI structures. Those statements could be sent to JS via the “$PAGE->requires->data_for_js” method.

The next example shows how to generate a basic statement:

use core_xapi\local\statement;
use core_xapi\local\statement\item_actor;
use core_xapi\local\statement\item_verb;
use core_xapi\local\statement\item_activity;

(...)
// Generate statement.
$statement = new statement();
$statement->set_actor(item_agent::create_from_user($USER));
$statement->set_verb(item_verb::create_from_id('bake'));
$statement->set_object(item_activity::create_from_id('cake'));

As can be seen in the example, the function item_agent has a static method to generate a valid xAPI actor from a user record. The result object of executing that code will be something like:

{
"actor": {
"objectType": "Agent",
"account": {
"homePage": "http:\/\/localhost\/m\/H5P",
"name": "2"
}
},
"verb": {
"id": "http:\/\/localhost\/m\/H5P\/xapi\/verb\/bake"
},
"object": {
"objectType": "Activity",
"id": "http:\/\/localhost\/m\/H5P\/xapi\/object\/cake"
}
}

For the object and verbs, xAPI uses a standard IRI format. The xAPI library will convert any string into a valid IRI but it can also use real IRI identifiers to generate standard verbs and object structures.

The next example is more a less the same but using valid IRI values for verbs and objects:

use core_xapi\local\statement;
use core_xapi\local\statement\item_actor;
use core_xapi\local\statement\item_verb;
use core_xapi\local\statement\item_activity;

(...)
// Generate statement.
$statement = new statement();
$statement->set_actor(item_agent::create_from_user($USER));
$statement->set_verb(item_verb::create_from_id('http://adlnet.gov/xapi/verbs/bake'));
$statement->set_object(item_activity::create_from_id('http://adlnet.gov/xapi/activities/cake'));

The resulting structure will be:

{
"actor": {
"objectType": "Agent",
"account": {
"homePage": "http:\/\/localhost\/m\/H5P",
"name": "2"
}
},
"verb": {
"id": "http:\/\/adlnet.gov\/xapi\/verbs\/bake"
},
"object": {
"objectType": "Activity",
"id": "http:\/\/adlnet.gov\/xapi\/activities\/cake"
}
}

The xAPI library also provides classes to convert moodle groups into valid xAPI group actors. To generate one the code is as following:

use core_xapi\local\statement;
use core_xapi\local\statement\item_actor;
use core_xapi\local\statement\item_verb;
use core_xapi\local\statement\item_activity;

(...)
// Generate statement.
$group = groups_get_group($groupid);
$statement = new statement();
$statement->set_actor(item_group::create_from_group($group));
$statement->set_verb(item_verb::create_from_id('bake'));
$statement->set_object(item_activity::create_from_id('cake'));

The result will be:

{
"actor": {
"objectType": "Group",
"name": "Group A",
"account": {
"homePage": "http:\/\/localhost\/m\/H5P",
"name": "1"
}
},
"verb": {
"id": "http:\/\/localhost\/m\/H5P\/xapi\/verb\/bake"
},
"object": {
"objectType": "Activity",
"id": "http:\/\/localhost\/m\/H5P\/xapi\/object\/cake"
}
}

== xAPI statements attributes implementation ==

All xAPI statement attributes have it’s own implementation in case any plugin needs them. All classes are implemented in the namespace “core_xapi\local\statement”, Those are the classes implemented:

* Item: all xAPI attributes derived from this class. This class provides a method to generate a valid item from a xAPI data structure (create_from_data), implements de json serialization and provides the basic “get_data” method to access the raw element data structure.
** Item_actor: this is an abstract class extended by both two xAPI valid actors:
*** Item_agent: an individual user. The class has a static method called “create_from_user” to generate a valid xAPI actor from a moodle user record.
*** Item_group: a group statement. Moodle xAPI implementation only accepts named groups (it will reject any anonymous group). To generate a valid xAPI group from a moodle group the class has a static method called “create_from_group”. It also provides methods to get all moodle users from that group (get_all_users) and the group record itself (get_group).
** Item_verb: represents the statement verb. The class has a static method “create_from_id” which accepts both valid IRI values or any random string to create a valid xAPI verb structure. IT algo has a method to get back the verb value (get_id).
** Item_object: this is an abstract class extended by all possible xAPI valid objects:
*** Item_agent or Item_group: both can be statements actor or objects as well
*** Item_activity: activity can be any kind of string value which the plugin decides. It has the same methods as item_verb to create and get this value (“create_from_id” and “get_id”). The xAPI activity could have also an atribute called “definition” that contains a SCORM like data defining the user interaction.
**** Item_definition: contains all the specific interaction details such as the interaction type (in SCORM format), the user answer or the correct answer pattern.
** Item_result: this optional attribute represents any kind of results and score derived from the user interaction. IT has no strict data validation and it has to be created directly from a valid xAPI data structure using the method “create_from_data”. It provides two methods to get the result score if present (get_score) and one to convert the result duration into seconds (get_duration). It uses also one subclass to handle score:
** Item_score: the class representing the xAPI score data. It has no validation and no specific methods.
** Item_context: the class representing the xAPI context data. It has no validation and no specific methods.
** Item_attachment: validate the xAPI attachment structure

== Adapting a plugin to use xAPI functions ==

All the plugins could use the new xAPI functionalities to send xAPI statements, interact with them, trigger events and generate log store entries.

=== Step 1: program a xapi handle class ===

Implement a class “\PLUGINNAME\classes\xapi\handler” which extends “\core_xapi\handler” and override this methods:

* '''statement_to_event (statement $statement): core\event\base''': to convert a statement into a valid Moodle event
* In case that the plugin wants to accept also Group statements (by default any Group statement will be rejected) it can override the method supports_group_actors(): bool

=== Step 2: code events ===

All xAPI statements MUST be converted into a valid Moodle event. To do so the plugin needs to '''code all the necessary events''' for this.

== Useful methods to handle xAPI statements inside plugins ==

The core_xapi\local\statement provides several methods to extract information from a statement object.

* get_user (): stdClass
** Return the Moodle user represented by the statement actor. In the case of a group actor, this function will throw an xapi_exception.
* get_all_users(): array
** Will return an array with all Moodle users represented in the xAPI actor object. This can be used in both single agent and group statements.
* get_group(): stdClass
** Return the Moodle group record represented in the xAPI actor. In the case of a single agent actor, this function will throw an xapi_exception.
* get_verb_id (): string
** Return the current verb ID value from a statement.
* get_activity_id(): string
** Return the current activity ID. If the statement object is not an activity (could be also an agent or a group) the method will throw an xapi_exception.
* minify (): ?array
** Return a minified version of the statement suitable for using as a “other” field of a Moodle event.
* get_actor(): item_actor
** Return the statement actor.
* get_verb(): item_verb
** Return the statement verb.
* get_object(): item_object
** Return the statement object.
* get_context(): item_context
** Return the statement context attribute.
* get_result(): item_result
** Return the statement result attribute.
* get_timestamp(): string
** Return the statement timestamp attribute.
* get_stored(): string
** Return the statement stored attribute.
* get_authority(): item_actor
** Return the statement authority attribute.
* get_version(): string
** Return the statement version attribute.
* get_attachments(): item_attachment
** Return the statement attachments attribute.

== Using Ajax lib to send a statement to Moodle ==

The webservices have a different behaviour depending if it is processing a single statement or an array of them.

This code could be an example of a single xAPI statement post JS code:

require(['core/ajax'], function(ajax) {
var data = {
component: 'mod_h5p',
requestjson: JSON.stringify(statement)
};
var promises = ajax.call([
{
methodname: 'core_xapi_statement_post',
args: data
}
]);
promises[0].done(function(response) {
// Put some success messages...
}).fail(function(ex) {
// Do some failure message handling...
});
});

On the other hand, if you send more than one statement, the webservice will return an array of booleans indicating which statements are successfully stored and which not. Only in the case of none of the statements could be processed (usually because of an invalid statement structure) the webservice will return an error.

This could be an example of sending more than one statement to Moodle:

require(['core/ajax'], function(ajax) {
var data = {
component: 'mod_h5p',
requestjson: JSON.stringify(statements)
};
var promises = ajax.call([
{
methodname: 'core_xapi_statement_post',
args: data
}
]);
promises[0].done(function(response) {
// Check if it's a success or not.
for (var i = 0; i < response.length; i++) {
if (response[i]) {
// Do some success handling.
} else {
// Do some failure handling.
}
}
}).fail(function(ex) {
// None of the statements are processed.
});
});

Core APIs

2020-05-28T15:24:51Z

Tusefomal: /* Other General APIs */

Moodle has a number of core APIs that provide tools for Moodle scripts.

They are essential when writing [[Plugins|Moodle plugins]].

==Most-used General APIs==

These APIs are critical and will be used by nearly every Moodle plugin.

=== Access API (access) ===

The [[Access API]] gives you functions so you can determine what the current user is allowed to do, and it allows modules to extend Moodle with new capabilities.

=== Data manipulation API (dml) ===

The [[Data manipulation API]] allows you to read/write to databases in a consistent and safe way.

=== File API (files) ===

The [[File API]] controls the storage of files in connection to various plugins.

=== Form API (form) ===

The [[Form API]] defines and handles user data via web forms.

=== Logging API (log) ===

The [[Events API]] allows you to log events in Moodle, while [[Logging 2]] describes how logs are stored and retrieved.

=== Navigation API (navigation) ===

The [[Navigation API]] allows you to manipulate the navigation tree to add and remove items as you wish.

=== Page API (page) ===

The [[Page API]] is used to set up the current page, add JavaScript, and configure how things will be displayed to the user.

=== Output API (output) ===

The [[Output API]] is used to render the HTML for all parts of the page.

=== String API (string) ===

The [[String API]] is how you get language text strings to use in the user interface. It handles any language translations that might be available.

=== Upgrade API (upgrade) ===

The [[Upgrade API]] is how your module installs and upgrades itself, by keeping track of its own version.

=== Moodlelib API (core) ===

The [[Moodlelib API]] is the central library file of miscellaneous general-purpose Moodle functions. Functions can over the handling of request parameters, configs, user preferences, time, login, mnet, plugins, strings and others. There are plenty of defined constants too.

==Other General APIs==

=== Admin settings (admin) ===

The [[Admin settings]] API deals with providing configuration options for each plugin and Moodle core.

=== Analytics API (analytics) ===

The [[Analytics API]] allow you to create prediction models and generate insights.

=== Availability (availability) ===

The [[Availability API]] controls access to activities and sections.

=== Backup API (backup) ===

The [[Backup API]] defines exactly how to convert course data into XML for backup purposes, and the [[Restore API]] describes how to convert it back the other way.

=== Cache API (cache) ===

The [[The Moodle Universal Cache (MUC)]] is the structure for storing cache data within Moodle. [[Cache_API]] explains some of what is needed to use a cache in your code.

=== Calendar API (calendar) ===

The [[Calendar API]] allows you to add and modify events in the calendar for user, groups, courses, or the whole site.

=== Check API (check) ===

WIP The [[Check API]] allows you to add security, performance or health checks to your site.

=== Comment API (comment) ===

The [[Comment API]] allows you to save and retrieve user comments, so that you can easily add commenting to any of your code.

=== Competency API (competency) ===

The [[Competency API]] allows you to list and add evidence of competencies to learning plans, learning plan templates, frameworks, courses and activities.

=== Data definition API (ddl) ===

The [[Data definition API]] is what you use to create, change and delete tables and fields in the database during upgrades.

=== Editor API ===

The [[Editor API]] is used to control HTML text editors.

=== Enrolment API (enrol) ===

The [[Enrolment API]] deals with course participants.

=== Events API (event) ===

The [[Events API]] allows to define "events" with payload data to be fired whenever you like, and it also allows you to define handlers to react to these events when they happen. This is the recommended form of inter-plugin communication. This also forms the basis for logging in Moodle.

=== Experience API (xAPI) ===

The Experience API (xAPI) is an e-learning standard that allows learning content and learning systems to speak to each other. The [[Experience API (xAPI)]]
allows any plugin to generate and handle xAPI standard statements.

=== External functions API (external) ===

The [[External functions API]] allows you to create fully parametrised methods that can be accessed by external programs (such as [[Web services]]).

=== Favourites API ===

The [[Favourites API]] allows you to mark items as favourites for a user and manage these favourites. This is often referred to as 'Starred'.

=== Lock API (lock) ===

The [[Lock API]] lets you synchronise processing between multiple requests, even for separate nodes in a cluster.

=== Message API (message) ===

The [[Message API]] lets you post messages to users. They decide how they want to receive them.

=== Media API (media) ===

The [[Media_players#Using_media_players|Media]] API can be used to embed media items such as audio, video, and Flash.

=== My profile API ===

The [[My profile API]] is used to add things to the profile page.

=== OAuth 2 API (oauth2) ===

The [[OAuth 2 API]] is used to provide a common place to configure and manage external systems using OAuth 2.

=== Preference API (preference) ===

The [[Preference API]] is a simple way to store and retrieve preferences for individual users.

=== Portfolio API (portfolio) ===

The [[Portfolio API]] allows you to add portfolio interfaces on your pages and allows users to package up data to send to their portfolios.

=== Privacy API (privacy) ===

The [[Privacy API]] allows you to describe the personal data that you store, and provides the means for that data to be discovered, exported, and deleted on a per-user basis.
This allows compliance with regulation such as the General Data Protection Regulation (GDPR) in Europe.

=== Rating API (rating) ===

The [[Rating API]] lets you create AJAX rating interfaces so that users can rate items in your plugin. In an activity module, you may choose to aggregate ratings to form grades.

=== RSS API (rss) ===

The [[RSS API]] allows you to create secure RSS feeds of data in your module.

=== Search API (search) ===

The [[Search API]] allows you to index contents in a search engine and query the search engine for results.

=== Tag API (tag) ===

The [[Tag API]] allows you to store tags (and a tag cloud) to items in your module.

=== Task API (task) ===

The [[Task API]] lets you run jobs in the background. Either once off, or on a regular schedule.

=== Time API (time) ===

The [[Time API]] takes care of translating and displaying times between users in the site.

=== Testing API (test) ===

The testing API contains the Unit test API ([[PHPUnit]]) and Acceptance test API ([[Acceptance testing]]). Ideally all new code should have unit tests written FIRST.

=== User-related APIs (user) ===

This is a rather informal grouping of miscellaneous [[User-related APIs]] relating to sorting and searching lists of users.

=== Web services API (webservice) ===

The [[Web services API]] allows you to expose particular functions (usually external functions) as web services.

=== Badges API (OpenBadges) ===

The [https://docs.moodle.org/dev/OpenBadges_User_Documentation Badges] user documentation (is a temp page until we compile a proper page with all the classes and APIs that allows you to manage particular badges and OpenBadges Backpack).

=== Custom fields API ===

The [[Custom fields API]] allows you to configure and add custom fields for different entities

== Activity module APIs ==

Activity modules are the most important plugin in Moodle. There are several core APIs that service only Activity modules.

=== Activity completion API (completion) ===

The [[Activity completion API]] is to indicate to the system how activities are completed.

=== Advanced grading API (grading) ===

The [[Advanced grading API]] allows you to add more advanced grading interfaces (such as rubrics) that can produce simple grades for the gradebook.

=== Conditional activities API (condition) - deprecated in 2.7 ===

The deprecated [[Conditional activities API]] used to provide conditional access to modules and sections in Moodle 2.6 and below. It has been replaced by the [[Availability API]].

=== Groups API (group) ===

The [[Groups API]] allows you to check the current activity group mode and set the current group.

=== Gradebook API (grade) ===

The [[Gradebook API]] allows you to read and write from the gradebook. It also allows you to provide an interface for detailed grading information.

=== Plagiarism API (plagiarism) ===

The [[Plagiarism API]] allows your activity module to send files and data to external services to have them checked for plagiarism.

=== Question API (question) ===

The [[Question API]] (which can be divided into the Question bank API and the Question engine API), can be used by activities that want to use questions from the question bank.

== See also ==

* [[Plugins]] - plugin types also have their own APIs
* [[Callbacks]] - list of all callbacks in Moodle
* [[Coding style]] - general information about writing PHP code for Moodle

Moodle Development kit

2019-12-04T09:51:10Z

Tusefomal: /* Typical workflows using MDK */

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

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

Of for some reason one cherry pick could not finish successfully, mdk will ask you if you want to keep this backport on 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 user 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]]

HQ component teams

2019-11-06T15:43:09Z

Tusefomal:

As of Dec 2017, at Moodle HQ each core developer is assigned a list of components to lead. They are responsible for triaging the issues in those components, planning the roadmap of issues to be worked on and should be consulted as part of the peer review process for all issues relating to their components.

The current list of component leads is:

'''Adrian (abgreeve), Mihail (Geshoski), Peter (peterdias)'''

Blocks, Blog, Book, Filepicker, Glossary, Lesson, Ratings, Reports, Repositories, Resource

'''Andrew (dobedobedoh), Mick Hawkins (michaelh)'''

Email, Forum, HTML Editor (Atto), HTML Editor (TinyMCE), Installation, JavaScript, Logging, RSS, Unit tests, User Tours

'''Bas Brands (basbrands), Ryan (ryanwyllie)'''

Themes, Dashboard (My home), Accessibility, HTML and CSS, Navigation, Usability, Javascript (''Ryan'')

'''Damyon (damyon)'''

Assignment, Assignment (2.2), Competencies, Database activity module, Backup, Backup: IMS-CC

'''David (dmonllao), Víctor Deniz (victor)'''

Analytics, Caching, Global search, Gradebook, Grading methods, Libraries, Performance, Tasks

'''David (mudrd8mz), Sara (sarjona), Amaia Anabitarte (amaia), Ferran (tusefomal)'''

Badges, Cohorts, Enrolments, Feedback, Hub, Language, Maths filters, MNet, Plagiarism, Roles / Access, SCORM, Survey, Tags, Translation, User management, Wiki(2.x), Workshop

'''Jake (jaked), Jun (jpataleta )'''

Automated functional tests (behat), Choice, Comments, Conditional activities, Database SQL/XMLDB, Events API, Files API, Filters, Forms Library, Portfolio, Web Services

'''Mark (markn), Carlos Escobedo (carlos)'''

Activity completion, Authentication, Chat, Course completion, External Tool (IMS-LTI), IMS-CP resource type, LTI provider, Media, Messages

'''Simey (lameze), Shamim (rezaie9)'''

Calendar, Groups, Questions, Quiz

'''Eduard Cercós (eduard)'''

IT Team

'''Mark Paget (markpaget)'''

IT Team

'''David Matamoros (davidmc)'''

[Workplace] Programs & Certifications

'''Mikel Martín (mikel)'''

Workplace Team

Testing of integrated issues

2019-11-04T11:46:20Z

Tusefomal: /* Expectation from tester */

<p class="note">'''Note:''' This page is for analysing and developing our weekly testing of code added to the integration server. It is a work-in-progress. ''Comments or suggestions are welcome!'' Please use the [[{{TALKPAGENAME}}|page comments]].</p>

Testing is an important part of the [[Process|Moodle development process]].
Wednesday has been allocated for testing, tester's first priority should be to finish testing on that day. Tester should update testing status or add comments in tracker, so that status of testing is known to iTeam.

==The testing process==

# Every Wednesday by 10:00 am (WST) all tests get allocated to HQ developers by iTeam.
# Developer should check mail or search tracker to see which issues are assigned to him/her for testing.
# Pull latest integration from git://git.moodle.org/integration.git
# Test issue by following '''Testing instructions'''
# Select 'Pass test' or 'Fail test' as appropriate, adding a short description of what was tested if not obvious
# If you find you cannot finish testing a particular pull request, click 'Stop testing' and let iTeam know about it.
# Failed tests will wait for assignee to respond. If the patch is provided late and there is constrained to find tester then issue will be re-opened.
# Once the fail fix is integrated, it goes back to *complete* re-testing.
# It's responsibility of tester to test the issue again, provided fix patch is not from tester. If tester provides fix patch then tester will be changed.
# Tester who passes the issue will be set as tester for the issue.

For test sessions, if you encounter a failure, please fail the issue add a comment on the issue itself. If everything's good, add a comment in the session and complete the session. You may also comment on the issue and say that testing passes on your part.

===Expectation from developer and peer-reviewer===
* Testing instructions are spot-on, clear and easy to perform. Please, follow the [[Testing instructions guide]] recommendations.

===Expectation from iTeam===
* Most (if not all) tests should be allocated by Wednesday Morning 10:00 a.m (WST). Tests that appear after this might not be tested. If tests are allocated after this point, the allocated tester should be contacted individually by private message and allowed to acknowledge.
* The iTeam member assigning tests should put a message in office chat that tests have been allocated.
* The iTeam may need to help/re-assign tests if developers are having problems.

===Expectation from tester===
* Testing '''must happen always against up to date integration.git repository''' (unless testing instructions include some exceptional git operation). More specifically, testing '''must not happen against development branches''' for a number of reasons (based on old core stuff, missing interdependencies with other issues or changes performed along the integration process, upgrade problems...).
* If HQ developer is not available for testing on Wednesday, this should be recorded in the calendar. If this has not been communicated in the leave calendar, then the developer or management should let iTeam know ASAP.
* Testers should try to finish testing as early as possible on Wednesdays, so when tests fail, the issue assignee has as much time as possible to resolve it.
* When a test fails, or new (related) regression found then fail test
* If tester is not sure of results or need explanation on testing instructions, then tester can either fail test with comments, or contact the assignee individually to raise the problem.
* Testers should let the iTeam know ASAP if they are facing any problems, need help or may not be able to complete their allocated tests
* For any reason (Big test, not enough time, not started testing yet), if a test is dragged to next day (Thursday) then the tester should leave comment on tracker, updating the status of testing and adding the expected time needed to finish testing.
* When a test is passed, it is recommended to add some extra information that confirms that all works as expected. This could be a browser screenshot, terminal output...
* '''All UI tests should be tested on currently supported themes {{Template:CurrentlySupportedThemes}}.'''

=== Differences in test process during continuous integration periods ===

During [[Integration Review#During continuous integration.2FFreeze.2FQA period|continuous integration]] we change our schedule to produce and release fixes to bugs more quickly than the usual weekly cycle. Our goal during this period is to release a new version of master multiple times per week and we do not have preallocated testing days (wednesday). We try to keep the process more flexible during this time in order that developers who have less pressing issues than others can take the load off those concentrating on big fixes. It works best if we work together to help each other out.

It is expected that:
* Testers to proactively pick up issues from the [https://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=16582 Urgent Issues Dashboard] ([https://tracker.moodle.org/issues/?filter=14728 awaiting testing] widget/filter).
* At ~12:00 (UTC-8) each day, any waiting tests will be allocated to testers (first to those who have not proactively taken any)
* Priority is given to testing issues to ensure we can release regularly

==Installing a local test site from the integration repository==

Moodle uses two Git repositories for its source code. Their names are moodle.git and integration.git and they live at http://git.moodle.org. All submitted patches that were accepted during the integration review go to the integration.git first. Testers use integration.git as the source of the code to test. Patches that survive testing are then promoted to moodle.git and become the part of the official Moodle weekly build.

To obtain the code from the integration.git repository, follow the instructions at [[Git for Administrators]] page. But instead of cloning from git://github.com/moodle/moodle.git, use

git clone git://git.moodle.org/integration.git

as the very first command.

===Changing theme to another one===

Ensure you have following setting in the config (It allows changing theme from url).

Set $CFG->allowthemechangeonurl = true;

For changing to a theme named "yay" add '''?theme=yay''' to the url.

===Checking tests assigned to you===
# Log in to [https://tracker.moodle.org Tracker]
# Visit [https://tracker.moodle.org/issues/?filter=11801&jql=project%20%3D%20MDL%20AND%20Tester%20%3D%20currentUser()%20AND%20status%20%3D%20%22Waiting%20for%20testing%22 Issues waiting to be tested.]

==Notes==

* If issues requires an Oracle and MSSQL installations for testing, and you don't have one, then please let iTeam know about this.
* Any update should be added as comment on MDL issue being tested.
* If testers pass or fail an issue by mistake, then please request iTeam to reopen it for testing.
* Testers should not be involved in the bugfixing or review process.
* If an issue cannot be fixed within a sprint and has to be reopened, the fix for sprint version should be removed and an appropriate backlog version set.

[[Category:Quality Assurance]]