core_course/activitychooser

A type of dialogue used as for choosing modules in a course.

Source:
Copyright:
  • 2020 Mathew May
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Methods

(inner) buildModal(bodyPromise, footer) → {Object}

Source:

Given an object we want to build a modal ready to show

Parameters:
Name Type Description
bodyPromise Promise
footer String | Boolean

Either a footer to add or nothing
Returns:

The modal ready to display immediately and render body in later.

Type
Object

(inner) init(courseId, chooserConfig)

Source:

Set up the activity chooser.

Parameters:
Name Type Description
courseId Number

Course ID to use later on in fetchModules()
chooserConfig Object

Any PHP config settings that we may need to reference

(inner) nullFavouriteDomManager(favouriteTabNav, modalBody)

Source:

A small helper function to handle the case where there are no more favourites and we need to mess a bit with the available tabs in the chooser

Parameters:
Name Type Description
favouriteTabNav HTMLElement

Dom node of the favourite tab nav
modalBody HTMLElement

Our current modals' body

(inner) partiallyAppliedFavouriteManager(moduleData, sectionId) → {function}

Source:

Export a curried function where the builtModules has been applied. We have our array of modules so we can rerender the favourites area and have all of the items sorted.

Parameters:
Name Type Description
moduleData Array

This is our raw WS data that we need to manipulate
sectionId Number

We need this to add the sectionID to the URL's in the faves area after rerender
Returns:

partially applied function so we can manipulate DOM nodes easily & update our internal array

Type
function

(inner) registerListenerEvents(courseId, chooserConfig)

Source:

Once a selection has been made make the modal & module information and pass it along

Parameters:
Name Type Description
courseId Number
chooserConfig Object

Any PHP config settings that we may need to reference

(inner) sectionIdMapper(webServiceData, id, sectionreturnid) → {Array}

Source:

Given the web service data and an ID we want to make a deep copy of the WS data then add on the section ID to the addoption URL

Parameters:
Name Type Description
webServiceData Object

Our original data from the Web service call
id Number

The ID of the section we need to append to the links
sectionreturnid Number | null

The ID of the section return we need to append to the links
Returns:

[modules] with URL's built

Type
Array

(inner) templateDataBuilder(data, chooserConfig) → {Object}

Source:

Given an array of modules we want to figure out where & how to place them into our template object

Parameters:
Name Type Description
data Array

our modules to manipulate into a Templatable object
chooserConfig Object

Any PHP config settings that we may need to reference
Returns:

Our built object ready to render out

Type
Object