Members
(constant) addContextmenuItem
- Source:
Given a TinyMCE contextmenu configuration, add the specified button to the end.
(constant) addMenubarItem
- Source:
Given a TinyMCE Menubar configuration, add the specified button to the named section.
(constant) addQuickbarsToolbarItem
- Source:
Given a TinyMCE quickbars configuration, add items to the menu.
(constant) addToolbarButton
- Source:
Given a TinyMCE Toolbar configuration, add the specified button to the named section.
(constant) addToolbarButtons
- Source:
Given a TinyMCE Toolbar configuration, add the specified buttons to the named section.
(constant) addToolbarSection
- Source:
Insert a new section into the toolbar.
(constant) byCategory
- Source:
- Copyright:
- 2019 Ryan Wyllie
- 2019 Ryan Wyllie
- License:
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Emoji data based on the data available from https://github.com/iamcal/emoji-data.
(constant) clearSearch
Reset the search icon and trigger the init for the block.
current :LoadingProcess
the current uploading process.
Type:
(constant) displayFilepicker
- Source:
Helper to display a filepicker and return a Promise.
The Promise will resolve when a file is selected, or reject if the file type is not found.
editorUpdates :Map
the courses pending to be updated.
Type:
- Map
endTime
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
endTime |
Number |
Timestamp at which time runs out.
(constant) ensureEditorIsValid
- Source:
Ensure that the editor is still in the DOM, removing it if it is not.
errorCallback :function
the error callback if any.
Type:
- function
extraData :Object
any extra process information to store.
Type:
- Object
finishedCallback :function
the finished callback if any.
Type:
- function
(constant) getDocumentationLink
- Source:
Get the link to the user documentation for the named plugin.
(constant) getImagePath
- Source:
Get the image path for the specified image.
(constant) getPluginMetadata
- Source:
Get the default plugin metadata for the named plugin. If no URL is provided, then a URL is generated pointing to the standard Moodle Documentation.
(constant) init
- Source:
Initialise all of the modules for the overview block.
(constant) init
Initialise the timeline view navigation by adding event listeners to the navigation elements.
(constant) init
Intialise the courses list and cards views on page load.
(constant) init
Initialise the timeline view navigation by adding event listeners to the navigation elements.
isEditing
Return the current edit mode.
Components should use this method to check if edit mode is active.
isLoggerSet :boolean
Flag to determine whether the screen reader-only logger has already been set, so we only need to set it once.
Type:
- boolean
locked
Set the lock value and locks or unlocks the element.
locked
Get the current locked value from the element.
manager :ProcessMonitorManager
the page monitor.
Type:
- ProcessMonitorManager
pending :Array
the pending queue.
Type:
- Array
prepare
- Source:
Prepares to begin a drag operation - call with a mousedown or touchstart event.
If the returned object has 'start' true, then you can set up a drag proxy, and call start. This function will call preventDefault automatically regardless of whether starting or not.
removedCallback :function
the removed callback if any.
Type:
- function
(constant) removeMenubarItem
- Source:
Given a TinyMCE Menubar configuration, remove the specified menu from the named section.
(constant) removeMenubarItems
- Source:
Given a TinyMCE Menubar configuration, remove the specified menu from the named section.
(constant) removeSubmenuItem
- Source:
Remove the specified sub-menu item from the named section. Recreate a menu with the same sub-menu items but remove the specified item.
(constant) removeToolbarButton
- Source:
Given a TinyMCE Toolbar configuration, remove the specified button from the named section.
(constant) removeToolbarButtons
- Source:
Given a TinyMCE Toolbar configuration, remove the specified buttons from the named section.
(constant) reset
Reset the courses views to their original state on first page load.courseOffset
This is called when configuration has changed for the event lists to cause them to reload their data.
(constant) serialize
- Source:
Serialize form values into a string.
This must be used instead of URLSearchParams, which does not correctly encode nested values such as arrays.
start
- Source:
Starts automatic scrolling if user moves near edge of window. This should be called in response to mouse down or touch start.
start
- Source:
Call to start a drag operation, in response to a mouse down or touch start event. Normally call this after calling prepare and receiving start true (you can probably skip prepare if only supporting drag not touch).
Note: The caller is responsible for creating a 'drag proxy' which is the thing that actually gets dragged. At present, this doesn't really work properly unless it is added directly within the body tag.
You also need to ensure that there is CSS so the proxy is absolutely positioned, and styled to look like it is floating.
You also need to absolutely position the proxy where you want it to start.
state
Return the current state.
stop
- Source:
Stops automatic scrolling. This should be called in response to mouse up or touch end.
StorageWrapper :Object
- Source:
Wraps browsers localStorage object
Type:
- Object
supportComponents
Return if the current course support components to refresh the content.
The :string
placeholder character used for standard strings (unclean)
Type:
- string
The :string
placeholder character used for cleaned strings
Type:
- string
timeoutId
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
timeoutId |
Number |
ID of the timeout that updates the clock.
timer
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
timer |
Element |
The timer element.
(constant) updateEditorState
- Source:
Updates the state of the editor.
Methods
_activityAnchor(event)
The activity anchor event.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event |
_addEventTotalMovement(event)
Add the total amout of movement to a mouse event.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
MouseEvent |
_addIdsToSelection(stateManager, typeName, ids)
Add some ids to the current bulk selection.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
typeName |
String | the type name (section/cm) |
ids |
array | the list of ids |
_allSectionToggler(event)
Handle the collapse/expand all sections button.
Toggler click is delegated to the main course content element because new sections can appear at any moment and this way we prevent accidental double bindings.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the triggered event |
_callEditWebservice(action, courseId, ids, targetSectionId, targetCmId)
Private method to call core_courseformat_update_course webservice.
Parameters:
| Name | Type | Description |
|---|---|---|
action |
string | |
courseId |
number | |
ids |
array | |
targetSectionId |
number | optional target section id (for moving actions) |
targetCmId |
number | optional target cm id (for moving actions) |
_callParentMethod(methodname, dropdata, event)
Convenient method for calling parent component functions if present.
Parameters:
| Name | Type | Description |
|---|---|---|
methodname |
string | the name of the method |
dropdata |
Object | the current drop data object |
event |
Event | the original event |
_cancelBulk()
Cancel bulk handler.
_cancelDebouncedReloadCm(cmId)
Cancel the active reload CM debounced function, if any.
Parameters:
| Name | Type | Description |
|---|---|---|
cmId |
Number |
_checkSectionlist(detail)
Check the section list and disable some options if needed.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
detail |
Object | the update details. Properties
|
_closeMonitor()
Close the monitor.
(async) _cmBasicAction(stateManager, action, cmIds, targetSectionId, targetCmId)
Execute a basic course module state action.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
action |
string | the action name |
cmIds |
array | the cm ids |
targetSectionId |
number | optional target section id (for moving actions) |
targetCmId |
number | optional target cm id (for moving actions) |
_completionHandler(event)
Activity manual completion listener.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the custom ecent |
_completionHandler(event)
Activity manual completion listener.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
event |
Event | the custom event Properties
|
_containsOnlyFiles(event) → {boolean}
Check if the dragged event contains only files.
Files dragging does not generate drop data because they came from outside the page and the component must check it before validating the event.
Some browsers like Firefox add extra types to file dragging. To discard the false positives a double check is necessary.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the original event. |
Returns:
if the drag dataTransfers contains files.
- Type
- boolean
(async) _createCm(param)
Create a newcm instance.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_createCmItem(container, cmid) → {Element}
Create a new course module item in a section.
Thos method will append a fake item in the container and trigger an ajax request to replace the fake element by the real content.
Parameters:
| Name | Type | Description |
|---|---|---|
container |
Element | the container element (section) |
cmid |
Number | the course-module ID |
Returns:
the created element
- Type
- Element
(async) _createListItem(args)
Create a monitor item.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
args |
object | the watcher arguments Properties
|
(async) _createSection(details)
Create a new section instance.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
details |
Object | the update details. Properties
|
_createSectionItem(container, sectionid) → {Element}
Create a new section item.
This method will append a fake item in the container and trigger an ajax request to replace the fake element by the real content.
Parameters:
| Name | Type | Description |
|---|---|---|
container |
Element | the container element (section) |
sectionid |
Number | the course-module ID |
Returns:
the created element
- Type
- Element
_deleteCm(param)
Remove a cm from the list.
The actual DOM element removal is delegated to the cm component.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_deleteSection(details)
Remove a section from the list.
The actual DOM element removal is delegated to the section component.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
details |
Object | the update details. Properties
|
_destroyModal(modal, element)
Hide and later destroy a modal.
Behat will fail if we remove the modal while some boostrap collapse is executing.
Parameters:
| Name | Type | Description |
|---|---|---|
modal |
Modal | |
element |
HTMLElement | the dom element to focus on. |
_disableLink(element)
Replace an element with a copy with a different tag name.
Parameters:
| Name | Type | Description |
|---|---|---|
element |
Element | the original element |
_dragEnd(event)
Drag end event handler.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the event. |
_dragEnter(event)
Drag enter event handler.
The JS drag&drop API triggers several dragenter events on the same element because it bubbles the child events as well. To prevent this form affecting the dropzones display, this methods use "entercount" to determine if it's one extra child event or a valid one.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the event. |
_dragLeave(event)
Drag over leave handler.
The JS drag&drop API triggers several dragleave events on the same element because it bubbles the child events as well. To prevent this form affecting the dropzones display, this methods use "entercount" to determine if it's one extra child event or a valid one.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the event. |
_dragOver(event)
Drag over event handler.
We only use dragover event when a draggable action starts inside a valid dropzone. In those cases the API won't trigger any dragEnter because the dragged alement was already there. We use the dropzonevisible to determine if the component needs to display the dropzones or not.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the event. |
_dragStart(event)
Drag start event handler.
This method will generate the current dropable data. This data is the one used to determine if a droparea accepts the dropping or not.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the event. |
_drop(event)
Drop event handler.
This method will call both hideDropZones and drop methods on the parent component.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the event. |
_enableBulk()
Dispatch the enable bulk mutation.
The enable bulk button is outside of the course content main div. Because content/actions captures click events only in the course content, this button needs to trigger the enable bulk mutation by itself.
_expandSectionNode(element, forceValue)
Expand a section node.
By default the method will use element.indexcollapsed to decide if the section is opened or closed. However, using forceValue it is possible to open or close a section independant from the indexcollapsed attribute.
Parameters:
| Name | Type | Description |
|---|---|---|
element |
Object | the course module state element |
forceValue |
boolean | optional forced expanded value |
(async) _fixOrder(container, neworder, selector, dettachedelements, createMethod)
Fix/reorder the section or cms order.
Parameters:
| Name | Type | Description |
|---|---|---|
container |
Element | the HTML element to reorder. |
neworder |
Array | an array with the ids order |
selector |
string | the element selector |
dettachedelements |
Object | a list of dettached elements |
createMethod |
function | method to create missing elements |
_fixOrder(container, neworder, allitems)
Fix/reorder the section or cms order.
Parameters:
| Name | Type | Description |
|---|---|---|
container |
Element | the HTML element to reorder. |
neworder |
Array | an array with the ids order |
allitems |
Array | the list of html elements that can be placed in the container |
_getClosestActionMenuToogler(element) → {HTMLElement|undefined}
Get the closest actions menu toggler to an action element.
Parameters:
| Name | Type | Description |
|---|---|---|
element |
HTMLElement | the action link element |
Returns:
- Type
- HTMLElement | undefined
_getDebouncedReloadCm(cmId) → {function}
Generate or get a reload CM debounced function.
Parameters:
| Name | Type | Description |
|---|---|---|
cmId |
Number |
Returns:
the debounced reload function
- Type
- function
_getDraggableData() → {Object}
Get the draggable data of this component.
Returns:
exported course module drop data
- Type
- Object
_getDropData(event) → {Object|undefined}
Get the current dropdata for a specific event.
The browser can generate drag&drop events related to several user interactions:
- Drag a page elements: this case is registered in the activeDropData map
- Drag some HTML selections: ignored for now
- Drag a file over the browser: file drag may appear in the future but for now they are ignored.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the original event. |
Returns:
with the dragged data (or undefined if none)
- Type
- Object | undefined
(async) _getLoggerEntry(stateManager, action, itemIds, data) → {Object}
Get log entry for the current action.
Parameters:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
stateManager |
StateManager | the current state manager |
|||||||||||||||
action |
string | the action name |
|||||||||||||||
itemIds |
Array.<int> | null | the element ids |
|||||||||||||||
data |
Object | undefined | extra params for the log entry Properties
|
Returns:
the log entry
- Type
- Object
_getTargetIds(target) → {Array.<Number>}
Return the ids represented by this element.
Depending on the dataset attributes the action could represent a single id or a bulk actions with all the current selected ids.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
HTMLElement |
Returns:
array of Ids
- Type
- Array.<Number>
_handleUnselectAll()
Process unselect all elements.
_indexContents()
Regenerate content indexes.
This method is used when a legacy action refresh some content element.
_isCmBulkEnabled(bulk) → {Boolean}
Check if cm bulk selection is available.
Parameters:
| Name | Type | Description |
|---|---|---|
bulk |
Object | the current state bulk attribute |
Returns:
- Type
- Boolean
_isSectionBulkEditable() → {Boolean}
Check if the section is bulk editable.
Returns:
- Type
- Boolean
_isSectionBulkEnabled(bulk) → {Boolean}
Check if cm bulk selection is available.
Parameters:
| Name | Type | Description |
|---|---|---|
bulk |
Object | the current state bulk attribute |
Returns:
- Type
- Boolean
_isSelected(bulk) → {Boolean}
Check if the cm id is part of the current bulk selection.
Parameters:
| Name | Type | Description |
|---|---|---|
bulk |
Object | the current state bulk attribute |
Returns:
- Type
- Boolean
_isSelected(bulk) → {Boolean}
Check if the cm id is part of the current bulk selection.
Parameters:
| Name | Type | Description |
|---|---|---|
bulk |
Object | the current state bulk attribute |
Returns:
- Type
- Boolean
_loadFileHandlers()
Load the file hanlders promise.
_modalBodyRenderedPromise(ModalClass, modalParams) → {Promise}
Render a modal and return a body ready promise.
Parameters:
| Name | Type | Description |
|---|---|---|
ModalClass |
Modal | the modal class |
modalParams |
object | the modal params |
Returns:
the modal body ready promise
- Type
- Promise
_mouseLeave()
Mouse leave handler.
_mouseOver()
Mouse over handle.
_prepareFields(stateManager, updateName, fields) → {Object}
Add default values to state elements.
This method is called every time a webservice returns a update state message.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
Object | the state manager |
updateName |
String | the state element to update |
fields |
Object | the new data |
Returns:
final fields data
- Type
- Object
_processEvent(event) → {Object|false}
Process a drag and drop event and delegate logic to the parent component.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the drag and drop event |
Returns:
the dropdata or null if the event should not be processed
- Type
- Object | false
_publishEvents()
Internal method to publish events.
This is a private method, it will be invoked when the state is set back to read only mode.
_refreshActions(param)
Refresh the visible action buttons depending on the selection type.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshActivityCard(bulk, selected)
Update the activity card depending on the bulk selection.
Parameters:
| Name | Type | Description |
|---|---|---|
bulk |
Object | the current bulk state data |
selected |
Boolean | if the activity is selected. |
_refreshAllSectionsToggler(state)
Refresh the collapse/expand all sections element.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | The state data |
_refreshBulk(param)
Update the bulk editing interface.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshBulk(param)
Update a bulk options.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshCm(param)
Update a course index cm using the state information.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshCm(param)
Update a course index cm using the state information.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshCmName(param)
Update a course module name on the whole page.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
(async) _refreshCompletion(details)
Update the activity completion icon.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
details |
Object | the update details Properties
|
_refreshCourseSectionlist(param)
Refresh the section list.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
Object |
Properties
|
_refreshCourseSectionlist(param)
Refresh the section list.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshEnabled(param)
Hide and show the bulk edit tools.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
(async) _refreshItem(args)
Create a monitor item.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
args |
object | the watcher arguments Properties
|
_refreshPageItem(details)
Handle a page item update.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
details |
Object | the update details Properties
|
_refreshPageItem(details)
Handle a page item update.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
details |
Object | the update details Properties
|
_refreshPageItem(details)
Handle a page item update.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
details |
Object | the update details Properties
|
_refreshSection(param)
Update a content section using the state information.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshSection(param)
Update a course index section using the state information.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
Object | details the update details. Properties
|
(async) _refreshSectionBulkSelector(param)
Update the bulk checkbox when the section name changes.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshSectionCmlist(param)
Refresh a section cm list.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
Object |
Properties
|
_refreshSectionCmlist(param)
Refresh a section cm list.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshSectionCollapsed(args)
Update section collapsed state via bootstrap 4 if necessary.
Formats that do not use bootstrap 4 must override this method in order to keep the section toggling working.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
args |
object |
Properties
|
_refreshSectionCollapsed(args)
Update section collapsed.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
args |
object |
Properties
|
_refreshSectionNumber(param)
Update a course section when the section number changes.
The courseActions module used for most course section tools still depends on css classes and section numbers (not id). To prevent inconsistencies when a section is moved, we need to refresh the
Course formats can override the section title rendering so the frontend depends heavily on backend rendering. Luckily in edit mode we can trigger a title update using the inplace_editable module.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
Object |
Properties
|
_refreshSectionTitle(param)
Update the section when the section name changes.
The section header have several HTML that uses the section name for accessibility and behat tests. This method updates them all.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshSelectAll(param)
Refresh the select all element.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
(async) _refreshSelectCount(param)
Refresh the selection count.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshToggler(param)
Update a content section using the state information.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param |
object |
Properties
|
_refreshTools(param)
Refresh the tools depending on the current selection.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
param |
object | the state watcher information Properties
|
_reloadCm(param0)
Reload a course module contents.
Most course module HTML is still strongly backend dependant. Some changes require to get a new version of the module.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param0 |
object | the watcher details Properties
|
_reloadSection(param0)
Reload a course section contents.
Section HTML is still strongly backend dependant. Some changes require to get a new version of the section.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
param0 |
details | the watcher details Properties
|
_removeIdsFromSelection(stateManager, typeName, ids)
Remove some ids to the current bulk selection.
The method resets the selection type if the current selection is empty.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
typeName |
String | the type name (section/cm) |
ids |
array | the list of ids |
_removeProcess()
Close the process.
(async) _requestAddSection(target, event)
Handle a create section request.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
event |
Event | the triggered event |
(async) _requestCmAvailability(target)
Handle a cm availability change request.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
(async) _requestCmDelete(target, event)
Handle a delete cm request.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
event |
Event | the triggered event |
(async) _requestCmDuplicate(target, event)
Handle a course module duplicate request.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
event |
Event | the triggered event |
(async) _requestDeleteSection(target, event)
Handle a delete section request.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
event |
Event | the triggered event |
(async) _requestMoveCm(target, event)
Handle a move cm request.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
event |
Event | the triggered event |
(async) _requestMoveSection(target, event)
Handle a move section request.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
event |
Event | the triggered event |
(async) _requestMutationAction(target, event, mutationName)
Basic mutation action helper.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
event |
Event | the triggered event |
mutationName |
string | the mutation name |
(async) _requestSectionAvailability(target)
Handle a section availability change request.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
(async) _requestToggleSelectionCm(target, event)
Handle a toggle cm selection.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
event |
Event | the triggered event |
(async) _requestToggleSelectionSection(target, event)
Handle a toggle section selection.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the dispatch action element |
event |
Event | the triggered event |
_scanIndex(selector, index, creationhandler)
Reindex a content (section or cm) of the course content.
This method is used internally by _indexContents.
Parameters:
| Name | Type | Description |
|---|---|---|
selector |
string | the DOM selector to scan |
index |
* | the index attribute to update |
creationhandler |
* | method to create a new indexed element |
_scrollHandler()
Check the current page scroll and update the active element if necessary.
(async) _sectionBasicAction(stateManager, action, sectionIds, targetSectionId, targetCmId)
Execute a basic section state action.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
action |
string | the action name |
sectionIds |
array | the section ids |
targetSectionId |
number | optional target section id (for moving actions) |
targetCmId |
number | optional target cm id (for moving actions) |
_sectionTogglers(event)
Setup sections toggler.
Toggler click is delegated to the main course content element because new sections can appear at any moment and this way we prevent accidental double bindings.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the triggered event |
_sectionTogglers(event)
Setup sections toggler.
Toggler click is delegated to the main course index element because new sections can appear at any moment and this way we prevent accidental double bindings.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the triggered event |
_selectAllClick(event)
Handle special select all cases.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event |
_setAddSectionLocked(locked)
Disable all add sections actions.
Parameters:
| Name | Type | Description |
|---|---|---|
locked |
boolean | the new locked value. |
_setCheckboxValue(checked, disabled)
Modify the checkbox element.
Parameters:
| Name | Type | Description |
|---|---|---|
checked |
Boolean | the new checked value |
disabled |
Boolean | the new disabled value |
_setCheckboxValue(checked, disabled)
Modify the checkbox element.
Parameters:
| Name | Type | Description |
|---|---|---|
checked |
Boolean | the new checked value |
disabled |
Boolean | the new disabled value |
_setupMutationRadioButtonModal(modal, ids)
Add events to a mutation selector radio buttons modal.
Parameters:
| Name | Type | Description |
|---|---|---|
modal |
Modal | |
ids |
Array.<Number> | the section or cm ids to apply the mutation |
_startProcessing()
Setup the component to start a transaction.
Some of the course actions replaces the current DOM element with a new one before updating the course state. This means the component cannot preload any index properly until the transaction starts.
(async) _updateActionsMenu(section)
Update a section action menus.
Parameters:
| Name | Type | Description |
|---|---|---|
section |
object | the section state. |
_updateBadges(section)
Update a section badges using the state information.
Parameters:
| Name | Type | Description |
|---|---|---|
section |
object | the section state. |
_updateMonitor(args)
Create a monitor item.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
args |
object | the watcher arguments Properties
|
_updateStateSectionPreference(stateManager, preferenceName, sectionIds, preferenceValue) → {Array.<Number>|null}
Private batch update for a section preference attribute.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
preferenceName |
string | the preference name |
sectionIds |
array | the affected section ids |
preferenceValue |
boolean | the new preferenceValue value |
Returns:
sections ids with the preference value true or null if no update is required
- Type
- Array.<Number> | null
activeSearch(clearIcon)
Change the searching icon to its' active state.
Parameters:
| Name | Type | Description |
|---|---|---|
clearIcon |
HTMLElement | Our closing icon to manipulate. |
activeSearchState(clearSearchIcon, timelineViewRoot)
Show the clear search icon.
Parameters:
| Name | Type | Description |
|---|---|---|
clearSearchIcon |
object | Clear search icon element. |
timelineViewRoot |
object | The root element for the timeline view |
addActions(actions)
Add extra actions to the module.
Parameters:
| Name | Type | Description |
|---|---|---|
actions |
array | array of methods to execute |
addClickHandler(handler)
Add a click handler to the list of handlers.
Parameters:
| Name | Type | Description |
|---|---|---|
handler |
function | A handler to call on a click event |
addEventListener(target, type, listener)
Add and bind an event listener to a target and keep track of all event listeners.
The native element.addEventListener method is not object oriented friently as the "this" represents the element that triggers the event and not the listener class. As components can be unregister and removed at any time, the BaseComponent provides this method to keep track of all component listeners and do all of the bind stuff.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the event target |
type |
string | the event name |
listener |
function | the class method that recieve the event |
addLoggerEntry(entry)
Add a new log entry into the reactive logger.
Parameters:
| Name | Type | Description |
|---|---|---|
entry |
LoggerEntry |
addMutations(newFunctions)
Add individual functions to the mutations.
Note new mutations will be added to the existing ones. To replace the full mutation object with a new one, use setMutations method.
Parameters:
| Name | Type | Description |
|---|---|---|
newFunctions |
Object | an object with new mutation functions. |
(async) addOverlay(definition, target)
Adds an overlay to a specific page element.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
definition |
Object | the overlay definition. Properties
|
|||||||||
target |
Element | optional parent object (this.element will be used if none provided) |
(async) addSection(stateManager, targetSectionId)
Add a new section to a specific course location.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
targetSectionId |
number | optional the target section id |
addSelectors(newSelectors)
Add or update the component selectors.
Parameters:
| Name | Type | Description |
|---|---|---|
newSelectors |
Object | an object of new selectors. |
addToFavourites(root, courseId)
Add course to favourites
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
courseId |
Number | Course id number |
addUpdateTypes(newFunctions)
Add methods to process update state messages.
The state manager provide a default update, create and delete methods. However, some applications may require to override the default methods or even add new ones like "refresh" or "error".
Parameters:
| Name | Type | Description |
|---|---|---|
newFunctions |
Object | the new update types functions. |
allItemsArray(state) → {Array}
Return a sorted list of all sections and cms items in the state.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the current state. |
Returns:
all sections and cms items in the state.
- Type
- Array
(async) allSectionsIndexCollapsed(stateManager, collapsed)
Update the course index collapsed attribute of all sections.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
collapsed |
boolean | the new collapsed value |
bulkEnable(stateManager, enabled)
Enable/disable bulk editing.
Note: reenabling the bulk will clean the current selection.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
enabled |
Boolean | the new bulk state. |
bulkReset(stateManager)
Reset the current selection.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
callWatchersHandler(event)
State changed listener.
This function take any state change and send it to the proper watchers.
To prevent internal state changes from colliding with other reactive instances, only the general "state changed" is triggered at document level. All the internal changes are triggered at private target level without bubbling. This way any reactive instance can alert only its own watchers.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
CustomEvent |
canUseStealth(state, cmIds) → {Boolean}
Check is some activities of a list can be stealth.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the current state. |
cmIds |
Array.<Number> | the module ids to check |
Returns:
if any of the activities can be stealth.
- Type
- Boolean
checkAllBulkSelected(courseEditor) → {Boolean}
Check if all possible elements are selected.
Parameters:
| Name | Type | Description |
|---|---|---|
courseEditor |
CourseEditor |
Returns:
if all elements of the current type are selected.
- Type
- Boolean
checkImage() → {Node}
Check accessiblity issue only for img type.
Returns:
A complete list of all warnings and problems.
- Type
- Node
checkTableCaption() → {Node}
Look for any table without a caption.
Returns:
A complete list of all warnings and problems.
- Type
- Node
clearSearchState(clearSearchIcon, timelineViewRoot)
Hide the clear search icon.
Parameters:
| Name | Type | Description |
|---|---|---|
clearSearchIcon |
object | Clear search icon element. |
timelineViewRoot |
object | The root element for the timeline view |
cm(state, cminfo) → {Object}
Generate a cm export data from the state.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the current state. |
cminfo |
Object | the course module state data. |
Returns:
- Type
- Object
cmCompletion(state, cminfo) → {Object}
Generate a completion export data from the cm element.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the current state. |
cminfo |
Object | the course module state data. |
Returns:
- Type
- Object
cmCompletion(stateManager, cmIds, complete)
Mark or unmark course modules as complete.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of course modules ids |
complete |
bool | the new completion value |
(async) cmDelete(stateManager, cmIds)
Delete cms.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of section ids |
cmDrag(stateManager, cmIds, dragValue)
Mark or unmark course modules as dragging.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of course modules ids |
dragValue |
bool | the new dragging value |
cmDraggableData(state, cmid) → {Object|null}
Generate a dragable cm data structure.
This method is used by any draggable course module element to generate drop data for its reactive/dragdrop instance.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
* | the state object |
cmid |
* | the cours emodule id |
Returns:
- Type
- Object | null
(async) cmDuplicate(stateManager, cmIds, targetSectionId, targetCmId)
Duplicate course modules
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of course modules ids |
targetSectionId |
number | undefined | the optional target sectionId |
targetCmId |
number | undefined | the target course module id |
(async) cmHide(stateManager, cmIds)
Hide cms.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of cm ids |
cmLock(stateManager, cmIds, lockValue)
Lock or unlock course modules.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of course modules ids |
lockValue |
bool | the new locked value |
(async) cmMove(stateManager, cmids, targetSectionId, targetCmId)
Move course modules to specific course location.
Note that one of targetSectionId or targetCmId should be provided in order to identify the new location:
- targetCmId: the activities will be located avobe the target cm. The targetSectionId value will be ignored in this case.
- targetSectionId: the activities will be appended to the section. In this case targetSectionId should not be present.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmids |
array | the list of cm ids to move |
targetSectionId |
number | the target section id |
targetCmId |
number | the target course module id |
(async) cmMoveLeft(stateManager, cmIds)
Move cms to the left: indent = 0.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of cm ids |
(async) cmMoveRight(stateManager, cmIds)
Move cms to the right: indent = 1.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of cm ids |
(async) cmNoGroups(stateManager, cmIds)
Set cms group mode to NOGROUPS.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of cm ids |
cmSelect(stateManager, cmIds)
Select a list of cms.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of cm ids |
(async) cmSeparateGroups(stateManager, cmIds)
Set cms group mode to SEPARATEGROUPS.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of cm ids |
(async) cmShow(stateManager, cmIds)
Show cms.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of cm ids |
cmState(stateManager, cmids)
Get updated state data related to some cm ids.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state |
cmids |
array | the list of cm ids to update |
(async) cmStealth(stateManager, cmIds)
Stealth cms.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of cm ids |
cmUnselect(stateManager, cmIds)
Unselect a list of cms.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of cm ids |
(async) cmVisibleGroups(stateManager, cmIds)
Set cms group mode to VISIBLEGROUPS.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
cmIds |
array | the list of cm ids |
collapseGroup(item)
Collpase a group item.
Parameters:
| Name | Type | Description |
|---|---|---|
item |
JQuery | the jQuery object |
configDragDrop(cmid)
Configure the component drag and drop.
Parameters:
| Name | Type | Description |
|---|---|---|
cmid |
number | course module id |
configDragDrop(sectionitem)
Register state values and the drag and drop subcomponent.
Parameters:
| Name | Type | Description |
|---|---|---|
sectionitem |
BaseComponent | section item component |
configDragDrop(sectionid, state, fullregion)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
sectionid |
number | the section id |
state |
Object | the initial state |
fullregion |
Element | the complete section region to mark as dragged |
configState(state)
Save some values form the state.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the current state |
count(args) → {Promise}
Get a count of LTI tool types and tool proxies from Moodle for the given search args.
See also: mod/lti/classes/external.php get_tool_types_and_proxies_count()
Parameters:
| Name | Type | Description |
|---|---|---|
args |
Object | Search parameters |
Returns:
Promise that will be resolved when the ajax call returns.
- Type
- Promise
course(state) → {Object}
Generate the course export data from the state.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the current state. |
Returns:
- Type
- Object
(async) courseState(stateManager)
Get the full updated state data of the course.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state |
createWarnings(description, nodes, isImageType) → {Array.<ProblemDetail>}
Generate the data that describes the issues found.
Parameters:
| Name | Type | Description |
|---|---|---|
description |
String | Description of this failure. |
nodes |
Array.<HTMLElement> | An array of failing nodes. |
isImageType |
boolean | Whether the warnings are related to image type checks |
Returns:
A set of problem details
- Type
- Array.<ProblemDetail>
defaultCreate(stateManager, updateName, fields)
Process a create state message.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
Object | the state manager |
updateName |
String | the state element to update |
fields |
Object | the new data |
defaultDelete(stateManager, updateName, fields)
Process a delete state message.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
Object | the state manager |
updateName |
String | the state element to update |
fields |
Object | the new data |
defaultOverride(stateManager, updateName, fields)
Process an override state message.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
Object | the state manager |
updateName |
String | the state element to update |
fields |
Object | the new data |
defaultPrepareFields(stateManager, updateName, fields) → {Object}
Prepare fields for processing.
This method is used to add default values or calculations from the frontend side.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
Object | the state manager |
updateName |
String | the state element to update |
fields |
Object | the new data |
Returns:
final fields data
- Type
- Object
defaultPut(stateManager, updateName, fields)
Process a put state message.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
Object | the state manager |
updateName |
String | the state element to update |
fields |
Object | the new data |
defaultRemove(stateManager, updateName, fields)
Process a remove state message.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
Object | the state manager |
updateName |
String | the state element to update |
fields |
Object | the new data |
defaultUpdate(stateManager, updateName, fields)
Process a update state message.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
Object | the state manager |
updateName |
String | the state element to update |
fields |
Object | the new data |
destroy()
Component destroy hook.
BaseComponent call this method when a component is unregistered or removed.
Components may override this method to clean the HTML or do some action when the component is unregistered or removed.
destroy()
Remove all subcomponents dependencies.
destroy()
Remove all subcomponents dependencies.
destroy()
Remove all subcomponents dependencies.
dispatch(actionName, params)
Dispatch a change in the state.
This method is the only way for components to alter the state. Watchers will receive a read only state to prevent illegal changes. If some user action require a state change, the component should dispatch a mutation to trigger all the necessary logic to alter the state.
Parameters:
| Name | Type | Description |
|---|---|---|
actionName |
string | the action name (usually the mutation name) |
params |
mixed | any number of params the mutation needs. |
dispatch(args)
Dispatch a change in the state.
Usually reactive modules throw an error directly to the components when something goes wrong. However, course editor can directly display a notification.
Parameters:
| Name | Type | Description |
|---|---|---|
args |
mixed | any number of params the mutation needs. |
dispatchRegistrationFail()
Dispatch a component registration fail event to inform the parent node.
As dispatchRegistrationSuccess, this method will communicate the registration fail to the parent node to inform the possible parent component.
dispatchRegistrationSuccess()
Dispatch a component registration event to inform the parent node.
The registration event is different from the rest of the component events because is the only way in which components can communicate its existence to a possible parent. Most components will be created by including a mustache file, child components must emit a registration event to the parent DOM element to alert about the registration.
dragEnd(dropdata)
The element drop end hook.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the dropdata |
dragEnd(dropdata)
The element drop end hook.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the dropdata |
dragEnd(dropdata)
The element end start hook.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the dropdata |
dragStart(dropdata)
The element drop start hook.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the dropdata |
dragStart(dropdata)
The element drop start hook.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the dropdata |
dragStart(dropdata)
The element drop start hook.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the dropdata |
drop(dropdata, event)
Drop event handler.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the accepted drop data |
event |
Event | the drop event |
drop(dropdata, event)
Drop event handler.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the accepted drop data |
event |
Event | the drop event |
drop(dropdata, event)
Drop event handler.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the accepted drop data |
event |
Event | the drop event |
enterCallback(jQueryItem)
Handle enter key on a collpasible node.
Parameters:
| Name | Type | Description |
|---|---|---|
jQueryItem |
JQuery | the jQuery object |
expandAllGroups()
Expand all groups.
expandGroup(item)
Expand a group item.
Parameters:
| Name | Type | Description |
|---|---|---|
item |
JQuery | the jQuery object |
fileDraggableData(state, dataTransfer) → {Object|null}
Generate a file draggable structure.
This method is used when files are dragged on the browser.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
* | the state object |
dataTransfer |
* | the current data tranfer data |
Returns:
- Type
- Object | null
formatSeconds(secs) → {String}
- Source:
Helper method to convert time remaining in seconds into HH:MM:SS format.
Parameters:
| Name | Type | Description |
|---|---|---|
secs |
Number | Time remaining in seconds to get value for. |
Returns:
Time remaining in HH:MM:SS format.
- Type
- String
get(key) → {boolean|string}
- Source:
Get a value from local storage. Remember - all values must be strings.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
string | The cache key to check. |
Returns:
False if the value is not in the cache, or some other error - a string otherwise.
- Type
- boolean | string
get(type) → {object}
- Source:
Get a registered type of modal.
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | The type of modal to get |
Returns:
The registered config for the modal
- Type
- object
get(name, id) → {Object|undefined}
Get state data.
Components access the state frequently. This convenience method is a shortcut to this.reactive.state.stateManager.get() method.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | the state object name |
id |
* | an optional object id for state maps. |
Returns:
the state object found
- Type
- Object | undefined
get(name, id) → {Object|undefined}
Get an element from the state or form an alternative state object.
The altstate param is used by external update functions that gets the current state as param.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | the state object name |
id |
* | and object id for state maps. |
Returns:
the state object found
- Type
- Object | undefined
getActiveItem() → {Element|undefined}
Return the current active node.
Returns:
the active item if any
- Type
- Element | undefined
getAddFavouriteMenuItem(root, courseId) → {Object}
Get the action menu item
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
courseId |
Number | Course id. |
Returns:
The add to favourite menu item.
- Type
- Object
getClasses() → {Object}
Return the component drag and drop CSS classes.
Returns:
the dragdrop css classes
- Type
- Object
getContent() → {object}
Return the jQuery element with the content. This will return either the unread notification container or the all notification container depending on which is currently visible.
Returns:
jQuery object currently visible content contianer
- Type
- object
getCourseId(root) → {Number}
Get the course id from a favourite element.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The favourite icon container element. |
Returns:
Course id.
- Type
- Number
(async) getDialogueContent() → {Promise.<Array>}
Return the dialogue content.
Returns:
A template promise containing the rendered dialogue content.
- Type
- Promise.<Array>
getDraggableData() → {Object}
Get the draggable data of this component.
Returns:
exported course module drop data
- Type
- Object
getElementLocked(target) → {boolean}
Get the current locked value from the element.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the event target |
Returns:
- Type
- boolean
getElements(query, dataId) → {NodeList}
Get the all subelement that match a query selector.
Parameters:
| Name | Type | Description |
|---|---|---|
query |
string | undefined | optional subelement query |
dataId |
string | undefined | optional data-id value |
Returns:
the DOM elements
- Type
- NodeList
getEvents() → {Object}
Return the component custom event names.
Components may override this method to provide their own events.
Component custom events is an important part of component reusability. This function is static because is part of the component definition and should be accessible from outsite the instances. However, values will be available at instance level in the this.events object.
Returns:
the component events.
- Type
- Object
getExporter() → {Exporter}
Return a data exporter to transform state part into mustache contexts.
Returns:
the exporter class
- Type
- Exporter
getFavouriteIconContainer(root, courseId) → {Object}
Get the container element for the favourite icon.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
courseId |
Number | Course id number |
Returns:
The favourite icon container
- Type
- Object
(async) getFileHandlersPromise() → {Promise}
Return the course file handlers promise.
Returns:
the promise for file handlers.
- Type
- Promise
getFilesDraggableData(dataTransfer) → {Array}
Convert a file dragging event into a proper dragging file list.
Parameters:
| Name | Type | Description |
|---|---|---|
dataTransfer |
DataTransfer | the event to convert |
Returns:
of file list info.
- Type
- Array
getFilterValues(root) → {filters}
- Source:
Get filter values from DOM.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
object | The root element for the courses view. |
Returns:
Set filters.
- Type
- filters
getFormatString(key, param) → {Promise.<String>}
Execute a get string for a possible format overriden editor string.
Return the proper getString promise for an editor string using the core_courseformat of the format_PLUGINNAME compoment depending on the current view format setup.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
String | the string key |
param |
string | undefined | The param for variable expansion in the string. |
Returns:
a getString promise
- Type
- Promise.<String>
getHideCourseMenuItem(root, courseId) → {Object}
Get the action menu item
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
courseId |
Number | Course id. |
Returns:
The hide course menu item.
- Type
- Object
getIds(name) → {Array}
Get all element ids from the given state.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | the state object name |
Returns:
the element ids.
- Type
- Array
getInitialPromise() → {Promise}
Generate a promise that will be resolved when the initial state is loaded.
In most cases the final state will be loaded using an ajax call. This is the reason why states manager are created unlocked and won't be reactive until the initial state is set.
Returns:
the resulting promise
- Type
- Promise
getLastCm() → {element|null}
Get the last CM element of that section.
Returns:
- Type
- element | null
getLastCm() → {element|null}
Get the last CM element of that section.
Returns:
the las course module element of the section.
- Type
- element | null
getLastCm() → {element|null}
Get the last CM element of that section.
Returns:
- Type
- element | null
getMyCourses(filters, limit) → {promise}
- Source:
Get enrolled courses from backend.
Parameters:
| Name | Type | Description |
|---|---|---|
filters |
object | The filters for this view. |
limit |
int | The number of courses to show. |
Returns:
Resolved with an array of courses.
- Type
- promise
getNotificationElement(id) → {object|null}
Find the notification element for the given id.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
int |
Returns:
The notification element
- Type
- object | null
getOffset() → {int}
Get the offset value for the current state of the popover in order to sent to the backend to correctly paginate the notifications.
Returns:
current offset
- Type
- int
getPagedContentContainer(root, index) → {Object}
Get the paged content container element.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
index |
Number | Rendered page index. |
Returns:
The rendered paged container.
- Type
- Object
getRemoveFavouriteMenuItem(root, courseId) → {Object}
Get the action menu item
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
courseId |
Number | Course id. |
Returns:
The remove from favourites menu item.
- Type
- Object
getSearchMyCourses(filters, limit, searchValue) → {promise}
Search for enrolled courses from backend.
Parameters:
| Name | Type | Description |
|---|---|---|
filters |
object | The filters for this view. |
limit |
int | The number of courses to show. |
searchValue |
string | What does the user want to search within their courses. |
Returns:
Resolved with an array of courses.
- Type
- promise
getSelector(selectorName) → {string|undefined}
Return a component selector.
Parameters:
| Name | Type | Description |
|---|---|---|
selectorName |
string | the selector name |
Returns:
the query selector
- Type
- string | undefined
(async) getServerCourseState() → {Object}
Load the current course state from the server.
Returns:
the current course state
- Type
- Object
getShowCourseMenuItem(root, courseId) → {Object}
Get the action menu item
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
courseId |
Number | Course id. |
Returns:
The show course menu item.
- Type
- Object
getState() → {Promise}
Return the initial state promise.
Typically, components do not require to use this promise because registerComponent will trigger their stateReady method automatically. But it could be useful for complex components that require to combine state, template and string loadings.
Returns:
- Type
- Promise
getStorageValue(key) → {boolean|string}
Get a value from the course editor static storage if any.
The course editor static storage uses the sessionStorage to store values from the components. This is used to prevent unnecesary template loadings on every page. However, the storage does not work if no sessionStorage can be used (in debug mode for example), if the page is in editing mode or if the initial state change from the last page.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
string | the key to get |
Returns:
the storage value or false if cannot be loaded
- Type
- boolean | string
getTableRoot(e) → {HTMLElement|bool}
Get the table root from an event.
Parameters:
| Name | Type | Description |
|---|---|---|
e |
Event |
Returns:
- Type
- HTMLElement | bool
getWarnings() → {Array.<ProblemDetail>}
Find all problems with the content editable region.
Returns:
A complete list of all warnings and problems.
- Type
- Array.<ProblemDetail>
getWatchers() → {Array}
Return the component watchers.
Returns:
of watchers
- Type
- Array
getWatchers() → {Array}
Return the component watchers.
Returns:
of watchers
- Type
- Array
getWatchers() → {array}
Return the list of watchers that component has.
Each watcher is represented by an object with two attributes:
- watch (string) the specific state event to watch. Example 'section.visible:updated'
- handler (function) the function to call when the watching state change happens
Any component shoudl override this method to define their state watchers.
Returns:
array of watchers.
- Type
- array
getWatchers() → {Array}
Return the component watchers.
Returns:
of watchers
- Type
- Array
getWatchers() → {Array}
Return the component watchers.
Returns:
of watchers
- Type
- Array
getWatchers() → {Array}
Component watchers.
Returns:
of watchers
- Type
- Array
getWatchers() → {Array}
Component watchers.
Returns:
of watchers
- Type
- Array
getWatchers() → {Array}
Component watchers.
Returns:
of watchers
- Type
- Array
getWatchers() → {Array}
Component watchers.
Returns:
of watchers
- Type
- Array
getWatchers() → {Array}
Component watchers.
Returns:
of watchers
- Type
- Array
getWatchers() → {Array}
Component watchers.
Returns:
of watchers
- Type
- Array
getWatchers() → {Array}
Component watchers.
Returns:
of watchers
- Type
- Array
(async) handleBlockProtectToggle(tableRoot, e)
Handle toggling of block protection.
Parameters:
| Name | Type | Description |
|---|---|---|
tableRoot |
HTMLElement | |
e |
Event |
handleItemClick(event, jQueryItem)
Handle an item click.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | the click event |
jQueryItem |
jQuery | the item clicked |
(async) handleStateToggle(tableRoot, e)
Handle state toggling.
Parameters:
| Name | Type | Description |
|---|---|---|
tableRoot |
HTMLElement | |
e |
Event |
hasDoneInitialLoad() → {bool}
Check if the first load of notification has been triggered for the current state of the popover.
Returns:
true if first notification loaded, false otherwise
- Type
- bool
hasLoadedAllContent() → {bool}
Check if we've loaded all of the notifications for the current popover state.
Returns:
true if all notifications loaded, false otherwise
- Type
- bool
hideCourse(root, courseId)
Hide course
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
courseId |
Number | Course id number |
hideDropZone()
Hide the component dropzone.
hideDropZone()
Hide the component dropzone.
hideDropZone()
Hide the component dropzone.
hideElement(root, id)
Reset the loadedPages dataset to take into account the hidden element
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
id |
Number | The course id number |
hideFavouriteIcon(root, courseId)
Hide the favourite icon.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The favourite icon container element. |
courseId |
Number | Course id number. |
hideUnreadCount()
Hide the unread notification count badge on the menu toggle.
incrementOffset()
Increment the offset for the current state, if required.
init()
Initialize the page.
init(timerId)
- Source:
Set up the submission timer.
Parameters:
| Name | Type | Description |
|---|---|---|
timerId |
Number | Unique ID of the timer element. |
initializePagedContent(root, promiseFunction, inputValue)
Initialise the courses list and cards views on page load.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
root |
object | The root element for the courses view. |
|
promiseFunction |
function | How do we fetch the courses and what do we do with them? |
|
inputValue |
null | string |
null
|
What to search for |
isDropzoneVisible() → {boolean}
Return the current drop-zone visible of the element.
Returns:
if the dropzone should be visible or not
- Type
- boolean
isGroupCollapsed(jQueryItem) → {boolean}
Check if a gorup item is collapsed.
Parameters:
| Name | Type | Description |
|---|---|---|
jQueryItem |
JQuery | the jQuery object |
Returns:
if the element is collapsed
- Type
- boolean
itemsPerPageFunc(pagingLimit, root) → {Array.<Number>}
Figure out how many items are going to be allowed to be rendered in the block.
Parameters:
| Name | Type | Description |
|---|---|---|
pagingLimit |
Number | How many courses to display |
root |
Object | The course overview container |
Returns:
How many courses will be rendered
- Type
- Array.<Number>
listedSectionIds(state) → {Array.<Number>}
Get the IDs of the sections that are listed as regular sections.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the current state. |
Returns:
the list of section ids that are listed.
- Type
- Array.<Number>
(async) loadCourse(courseId, serverStateKey)
Set up the course editor when the page is ready.
The course can only be loaded once per instance. Otherwise an error is thrown.
The backend can inform the module of the current state key. This key changes every time some update in the course affect the current user state. Some examples are:
- The course content has been edited
- The user marks some activity as completed
- The user collapses or uncollapses a section (it is stored as a user preference)
Parameters:
| Name | Type | Description |
|---|---|---|
courseId |
number | course id |
serverStateKey |
string | the current backend course cache reference |
loadMoreNotifications() → {object}
Send a request for more notifications from the server, if we aren't already loading some and haven't already loaded all of them.
Takes into account the current mode of the popover and will request only unread notifications if required.
All notifications are marked as read by the server when they are returned.
Returns:
jQuery promise that is resolved when notifications have been retrieved and added to the DOM
- Type
- object
loadStaticContent() → {boolean}
Load the course index from the session storage if any.
Returns:
true if the static version is loaded form the session
- Type
- boolean
(async) loadTemplateContent(state)
Load the course index template.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the initial state |
markAllAsRead() → {Promise}
Send a request to the server to mark all unread notifications as read and update the unread count and unread notification elements appropriately.
Returns:
- Type
- Promise
module:core/emoji/auto_complete(root, textArea, hasSuggestionCallback, selectCallback)
Initialise the emoji auto complete.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Element | The root container element for the auto complete |
textArea |
Element | The text area element to monitor for auto complete |
hasSuggestionCallback |
function | Callback for when there are auto-complete suggestions |
selectCallback |
function | Callback for when the user selects an emoji |
module:core/emoji/picker(root, selectCallback)
- Source:
Initialise the emoji picker.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Element | The root element for the picker |
selectCallback |
function | Callback for when the user selects an emoji |
module:core/menu_navigation(elementRoot)
- Source:
The initial entry point that a given module can pass a HTMLElement.
Parameters:
| Name | Type | Description |
|---|---|---|
elementRoot |
HTMLElement | The menu to add handlers upon. |
module:core/moremenu(menu)
- Source:
Initialise the more menus.
Parameters:
| Name | Type | Description |
|---|---|---|
menu |
HTMLElement | The navbar moremenu. |
module:mod_forum/local/grades/local/grader/gradingpanel(component, context, gradingComponent, gradingSubtype, itemName) → {Object}
Get the grade panel setter and getter for the current component. This function dynamically pulls the relevant gradingpanel JS file defined in the grading method. We do this because we do not know until execution time what the grading type is and we do not want to import unused files.
Parameters:
| Name | Type | Description |
|---|---|---|
component |
String | The component being graded |
context |
Number | The contextid of the thing being graded |
gradingComponent |
String | The thing providing the grading type |
gradingSubtype |
String | The subtype fo the grading component |
itemName |
String | The name of the thing being graded |
Returns:
- Type
- Object
module:mod_forum/local/grades/local/grader/user_picker(users, showUserCallback, preChangeUserCallback, currentUserIDopt) → {UserPicker}
Create a new user picker.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
users |
Array | The list of users |
|
showUserCallback |
function | The function to call to show a specific user |
|
preChangeUserCallback |
function | The fucntion to call to save the grade for the current user |
|
currentUserID |
Number |
<optional> |
The userid of the current user |
Returns:
- Type
- UserPicker
noCoursesRender(root) → {promise}
Given there are no courses to render provide the rendered template.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
object | The root element for the courses view. |
Returns:
jQuery promise resolved after rendering is complete.
- Type
- promise
pageBuilder(coursesData, currentPage, pageData, actions, activeSearch)
Mutates and controls the loadedPages array and handles the bootstrapping.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
coursesData |
Array | Object | Array of all of the courses to start building the page from |
|
currentPage |
Number | What page are we currently on? |
|
pageData |
Object | Any current page information |
|
actions |
Object | Paged content helper |
|
activeSearch |
null | boolean |
null
|
Are we currently actively searching and building up search results? |
processUpdate(updateName, action, fields, updateTypes)
Process a single state update.
Note this method will not lock or unlock the state by itself.
Parameters:
| Name | Type | Description |
|---|---|---|
updateName |
string | the state element to update |
action |
string | to action to perform |
fields |
object | the new data |
updateTypes |
Object | optional functions to override the default update types. |
processUpdates(updates, updateTypes)
Process a state updates array and do all the necessary changes.
Note this method unlocks the state while it is executing and relocks it when finishes.
Parameters:
| Name | Type | Description |
|---|---|---|
updates |
array | |
updateTypes |
Object | optional functions to override the default update types. |
query(args) → {Promise}
Get a list of LTI tool types and tool proxies from Moodle for the given search args.
See also: mod/lti/classes/external.php get_tool_types_and_proxies()
Parameters:
| Name | Type | Description |
|---|---|---|
args |
Object | Search parameters |
Returns:
Promise that will be resolved when the ajax call returns.
- Type
- Promise
register(type, module, template)
- Source:
Register a modal with the registry.
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | The type of modal (must be unique) |
module |
function | The modal module (must be a constructor function of type core/modal) |
template |
string | The template name of the modal |
registerChildComponent(component)
Register a child component into the reactive instance.
Parameters:
| Name | Type | Description |
|---|---|---|
component |
self | the component to register. |
registerComponent(component) → {object}
Register a new component.
Component can provide some optional functions to the reactive module:
- getWatchers: returns an array of watchers
- stateReady: a method to call when the initial state is loaded
It can also provide some optional attributes:
- name: the component name (default value: "Unkown component") to customize debug messages.
The method will also use dispatchRegistrationSuccess and dispatchRegistrationFail. Those are BaseComponent methods to inform parent components of the registration status. Components should not override those methods.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
component |
object | the new component Properties
|
Returns:
the registered component
- Type
- object
registerEventListeners()
Register event listeners for the default_notification_preferences page.
registerEventListeners()
Add all of the required event listeners for this notification popover.
registerEventListeners(root, page)
Listen to, and handle events for the myoverview block.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The myoverview block container element. |
page |
HTMLElement | The whole HTMLElement for our block. |
registerPagedEventHandlers(root, namespace)
Intialise the paged list and cards views on page load. Returns an array of paged contents that we would like to handle here
Parameters:
| Name | Type | Description |
|---|---|---|
root |
object | The root element for the courses view |
namespace |
string | The namespace for all the events attached |
registerSearch(root, timelineViewRoot)
Event listener for the "search" input field in the timeline navigation that allows for searching the activity name, course name and activity type.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
object | The root element for the timeline block |
timelineViewRoot |
object | The root element for the timeline view |
registerSelector(root)
Event listener for the Display filter (cards, list).
Parameters:
| Name | Type | Description |
|---|---|---|
root |
object | The root element for the overview block |
registerStateAction(field, prop, action, data)
Register a state modification and generate the necessary events.
This method is used mainly by proxy helpers to dispatch state change event. However, mutations can use it to inform components about non reactive changes in the state (only the two first levels of the state are reactive).
Each action can produce several events:
- The specific attribute updated, created or deleter (example: "cm.visible:updated")
- The general state object updated, created or deleted (example: "cm:updated")
- If the element has an ID attribute, the specific event with id (example: "cm[42].visible:updated")
- If the element has an ID attribute, the general event with id (example: "cm[42]:updated")
- A generic state update event "state:update"
Parameters:
| Name | Type | Description |
|---|---|---|
field |
string | the affected state field name |
prop |
string | null | the affecter field property (null if affect the full object) |
action |
string | the action done (created/updated/deleted) |
data |
* | the affected data |
registerTimelineDaySelector(root, timelineViewRoot)
Event listener for the day selector ("Next 7 days", "Next 30 days", etc).
Parameters:
| Name | Type | Description |
|---|---|---|
root |
object | The root element for the timeline block |
timelineViewRoot |
object | The root element for the timeline view |
registerViewSelector(root, timelineViewRoot)
Event listener for the "sort" button in the timeline navigation that allows for changing between the timeline dates and courses views.
On a view change we tell the timeline view module that the view has been shown so that it can handle how to display the appropriate view.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
object | The root element for the timeline block |
timelineViewRoot |
object | The root element for the timeline view |
remove()
Remove a previously rendered component instance.
This method will remove the component HTML and unregister it from the reactive module.
removeAllEventListeners()
Remove all event listeners from this component.
This method is called also when the component is unregistered or removed.
Note that only listeners registered with the addEventListener method will be removed. Other manual listeners will keep active.
removeAllOverlays()
Remove all page overlais.
removeEventListener(target, type, listener)
Remove an event listener from a component.
This method allows components to remove listeners without keeping track of the listeners bind versions of the method. Both addEventListener and removeEventListener keeps internally the relation between the original class method and the bind one.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the event target |
type |
string | the event name |
listener |
function | the class method that recieve the event |
removeFromFavourites(root, courseId)
Remove course from favourites
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
courseId |
Number | Course id number |
removeOverlay()
Remove the current overlay.
renderComponent(target, file, data) → {Promise}
Render a new Component using a mustache file.
It is important to note that this method should NOT be used for loading regular mustache files as it returns a Promise that will only be resolved if the mustache registers a component instance.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
element | the DOM element that contains the component |
file |
string | the component mustache file to render |
data |
* | the mustache data |
Returns:
a promise of the resulting component instance
- Type
- Promise
renderCourses(root, coursesData) → {promise}
Render the dashboard courses.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
object | The root element for the courses view. |
coursesData |
array | containing array of returned courses. |
Returns:
jQuery promise resolved after rendering is complete.
- Type
- promise
renderNotifications(notifications, container) → {object}
Render the notification data with the appropriate template and add it to the DOM.
Parameters:
| Name | Type | Description |
|---|---|---|
notifications |
array | Notification data |
container |
object | jQuery object the container to append the rendered notifications |
Returns:
jQuery promise that is resolved when all notifications have been rendered and added to the DOM
- Type
- object
renderUnreadCount()
Show the unread notification count badge on the menu toggle if there are unread notifications, otherwise hide it.
resetGlobals()
In cases when switching between regular rendering and search rendering we need to reset some variables.
searchFunctionalityCurry() → {function}
Initialize the searching functionality so we can call it when required.
Returns:
- Type
- function
section(state, sectioninfo) → {Object}
Generate a section export data from the state.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the current state. |
sectioninfo |
Object | the section state data. |
Returns:
- Type
- Object
(async) sectionContentCollapsed(stateManager, sectionIds, collapsed)
Update the course content collapsed attribute of some sections.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the affected section ids |
collapsed |
boolean | the new collapsed value |
(async) sectionDelete(stateManager, sectionIds)
Delete sections.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the list of course modules ids |
sectionDrag(stateManager, sectionIds, dragValue)
Mark or unmark course sections as dragging.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the list of section ids |
dragValue |
bool | the new dragging value |
sectionDraggableData(state, sectionid) → {Object|null}
Generate a dragable cm data structure.
This method is used by any draggable section element to generate drop data for its reactive/dragdrop instance.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
* | the state object |
sectionid |
* | the cours section id |
Returns:
- Type
- Object | null
(async) sectionHide(stateManager, sectionIds)
Hides sections.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the list of section ids |
(async) sectionIndexCollapsed(stateManager, sectionIds, collapsed)
Update the course index collapsed attribute of some sections.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the affected section ids |
collapsed |
boolean | the new collapsed value |
sectionLock(stateManager, sectionIds, lockValue)
Lock or unlock course sections.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the list of section ids |
lockValue |
bool | the new locked value |
(async) sectionMove(stateManager, sectionIds, targetSectionId)
- Source:
- Deprecated:
- since Moodle 4.4 MDL-77038.
- To Do:
-
- MDL-80116 This will be deleted in Moodle 4.8.
Move course modules to specific course location.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the list of section ids to move |
targetSectionId |
number | the target section id |
(async) sectionMoveAfter(stateManager, sectionIds, targetSectionId)
Move course modules after a specific course location.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the list of section ids to move |
targetSectionId |
number | the target section id |
sectionSelect(stateManager, sectionIds)
Select a list of sections.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the list of cm ids |
(async) sectionShow(stateManager, sectionIds)
Show sections.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the list of section ids |
sectionState(stateManager, sectionIds)
Get updated state data related to some section ids.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state |
sectionIds |
array | the list of section ids to update |
sectionUnselect(stateManager, sectionIds)
Unselect a list of sections.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
sectionIds |
array | the list of cm ids |
selectAllBulk(courseEditor, value)
Select/unselect all element of the selected type.
Parameters:
| Name | Type | Description |
|---|---|---|
courseEditor |
CourseEditor | |
value |
Boolean | if the elements must be selected or unselected. |
selectAndScroll(node)
Set the selection and scroll to the selected element.
Parameters:
| Name | Type | Description |
|---|---|---|
node |
node |
set(key, value) → {boolean}
- Source:
Set a value to local storage. Remember - all values must be strings.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
string | The cache key to set. |
value |
string | The value to set. |
Returns:
False if the value can't be saved in the cache, or some other error - true otherwise.
- Type
- boolean
setBlockProtectState(plugin, state) → {Promise}
Set the block protection state.
Parameters:
| Name | Type | Description |
|---|---|---|
plugin |
string | |
state |
number |
Returns:
- Type
- Promise
setCourseFavouriteState(courseId, status) → {Promise}
Set the courses favourite status and push to repository
Parameters:
| Name | Type | Description |
|---|---|---|
courseId |
Number | Course id to favourite. |
status |
boolean | new favourite status. |
Returns:
Repository promise.
- Type
- Promise
setCourseHiddenState(courseId, status) → {Promise}
Set the courses hidden status and push to repository
Parameters:
| Name | Type | Description |
|---|---|---|
courseId |
Number | Course id to favourite. |
status |
Boolean | new hidden status. |
Returns:
Repository promise.
- Type
- Promise
setDraggable(value)
Enable or disable the draggable property.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
bool | the new draggable value |
setDraggable(value)
Enable or disable the draggable property.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
bool | the new draggable value |
setDraggable(value)
Enable or disable the draggable property.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
bool | the new draggable value |
setDragImage() → {HTMLElement}
Return the custom activity card drag shadow image.
The element returned will be used when the user drags the card.
Returns:
- Type
- HTMLElement
setElementLocked(target, locked)
Lock/unlock an element.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Element | the event target |
locked |
boolean | the new locked value |
setInitialState(stateData)
Set the initial state.
Parameters:
| Name | Type | Description |
|---|---|---|
stateData |
object | the initial state data. |
setInitialState(initialState)
Loads the initial state.
Note this method will trigger a state changed event with "state:loaded" actionname.
The state mode will be set to read only when the initial state is loaded.
Parameters:
| Name | Type | Description |
|---|---|---|
initialState |
object |
setLimit(root) → {function}
Return the callback to be passed to the subscribe event
Parameters:
| Name | Type | Description |
|---|---|---|
root |
object | The root element for the courses view |
Returns:
Partially applied function that'll execute when passed a limit
- Type
- function
setLoadedAllContent(val)
Set the state of the loaded all content property for the current state of the popover.
Parameters:
| Name | Type | Description |
|---|---|---|
val |
bool | True if all content is loaded, false otherwise |
setLogger(logger)
Set the logger class instance.
Reactive instances can provide alternative loggers to provide advanced logging.
Parameters:
| Name | Type | Description |
|---|---|---|
logger |
Logger |
setMutations(manager)
Replace the current mutations with a new object.
This method is designed to override the full mutations class, for example by extending the original one. To add some individual mutations, use addMutations instead.
Parameters:
| Name | Type | Description |
|---|---|---|
manager |
object | the new mutations intance |
setPageItem(stateManager, type, id, isStatic)
Set the page current item.
Only one element of the course state can be the page item at a time.
There are several actions that can alter the page current item. For example, when the user is in an activity page, the page item is always the activity one. However, in a course page, when the user scrolls to an element, this element get the page item.
If the page item is static means that it is not meant to change. This is important because static page items has some special logic. For example, if a cm is the static page item and it is inside a collapsed section, the course index will expand the section to make it visible.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
type |
String | undefined | the element type (section or cm). Undefined will remove the current page item. |
id |
Number | undefined | the element id |
isStatic |
boolean | undefined | if the page item is static |
setPluginState(methodname, plugin, state) → {Promise}
Set the plugin state (enabled or disabled)
Parameters:
| Name | Type | Description |
|---|---|---|
methodname |
string | The web service to call |
plugin |
string | The name of the plugin to set the state for |
state |
number | The state to set |
Returns:
- Type
- Promise
setReadOnly(readonly)
Locks or unlocks the state to prevent illegal updates.
Mutations use this method to modify the state. Once the state is updated, they must block again the state.
All changes done while the state is writable will be registered using registerStateAction. When the state is set again to read only the method will trigger _publishEvents to communicate changes to all watchers.
Parameters:
| Name | Type | Description |
|---|---|---|
readonly |
bool | if the state is in read only mode enabled |
setStorageValue(key, value) → {boolean}
Stores a value into the course editor static storage if available
Parameters:
| Name | Type | Description |
|---|---|---|
key |
String | the key to store |
value |
* | the value to store (must be compatible with JSON,stringify) |
Returns:
true if the value is stored
- Type
- boolean
showCourse(root, courseId)
Show course
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container |
courseId |
Number | Course id number |
showDropZone(dropdata)
Display the component dropzone.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the accepted drop data |
showDropZone(dropdata)
Display the component dropzone.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the accepted drop data |
showDropZone()
Display the component dropzone.
showFavouriteIcon(root, courseId)
Show the favourite icon.
Parameters:
| Name | Type | Description |
|---|---|---|
root |
Object | The course overview container. |
courseId |
Number | Course id number. |
standardFunctionalityCurry() → {function}
The default functionality of fetching paginated courses without special handling.
Returns:
- Type
- function
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the initial state |
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the initial state |
stateReady()
Reactive module will call this method when the state is ready.
Component can override this method to update/load the component HTML or to bind listeners to HTML entities.
stateReady()
Initial state ready method.
This method will add all the necessary event listeners to the component depending on the parent methods.
- Add drop events to the element if the parent component has validateDropData method.
- Configure the elements draggable if the parent component has getDraggableData method.
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the state data |
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the state data. |
stateReady()
Initial state ready method.
stateReady()
Initial state ready method.
stateReady()
Initial state ready method.
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the initial state |
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the state data |
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the initial state |
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the course state. |
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the state data |
(async) stateReady(state)
Initial state ready method.
This stateReady to be async because it loads the real courseindex.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
object | the initial state |
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the initial state |
stateReady(state)
Initial state ready method.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
Object | the initial state |
stop()
- Source:
Stop the timer, if it is running.
submitTagCreateUpdateForm(questionId, contextId, formdata) → {promise}
Submit the form data for the question tags form.
Parameters:
| Name | Type | Description |
|---|---|---|
questionId |
Number | |
contextId |
Number | |
formdata |
string | The URL encoded values from the form |
Returns:
- Type
- promise
switchBulkSelection(courseEditor)
Switch the current bulk selection.
Parameters:
| Name | Type | Description |
|---|---|---|
courseEditor |
CourseEditor |
toggleBulkSelectionAction(courseEditor, target, event, elementType)
Process a bulk selection toggle action.
Parameters:
| Name | Type | Description |
|---|---|---|
courseEditor |
CourseEditor | |
target |
HTMLElement | the action element |
event |
Event | |
elementType |
String | cm or section |
toggleGroup(item)
Toggle a group item.
Parameters:
| Name | Type | Description |
|---|---|---|
item |
JQuery | the jQuery object |
unlockAll(stateManager)
Unlock all course elements.
Parameters:
| Name | Type | Description |
|---|---|---|
stateManager |
StateManager | the current state manager |
unregister()
Unregister the component from the reactive module.
This method will disable the component logic, event listeners and watchers but it won't remove any HTML created by the component. However, it will trigger the destroy hook to allow the component to clean parts of the interface.
unregisterComponent(component) → {object}
Unregister a component and its watchers.
Parameters:
| Name | Type | Description |
|---|---|---|
component |
object | the object instance to unregister |
Returns:
the deleted component
- Type
- object
update()
- Source:
Function to update the clock with the current time left.
updateButtonAriaLabel()
Set the correct aria label on the menu toggle button to be read out by screen readers. The message will indicate the state of the unread notifications.
updatePreferences(filter, value) → {Promise}
Update the user preference for the block.
Parameters:
| Name | Type | Description |
|---|---|---|
filter |
String | The type of filter: display/sort/grouping. |
value |
String | The current preferred value. |
Returns:
- Type
- Promise
uploadFiles(sectionId, sectionNum, files) → {Promise}
Upload a file list to the course.
This method is a wrapper to the course file uploader.
Parameters:
| Name | Type | Description |
|---|---|---|
sectionId |
number | the section id |
sectionNum |
number | the section number |
files |
Array | and array of files |
Returns:
the file queue promise
- Type
- Promise
validateDropData(dropdata) → {boolean}
Validate if the drop data can be dropped over the component.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the exported drop data. |
Returns:
- Type
- boolean
validateDropData(dropdata) → {boolean}
Validate if the drop data can be dropped over the component.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the exported drop data. |
Returns:
- Type
- boolean
validateDropData(dropdata) → {boolean}
Validate if the drop data can be dropped over the component.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the exported drop data. |
Returns:
- Type
- boolean
validateDropData(dropdata) → {boolean}
Validate if the drop data can be dropped over the component.
Parameters:
| Name | Type | Description |
|---|---|---|
dropdata |
Object | the exported drop data. |
Returns:
- Type
- boolean
Type Definitions
description
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
eventName |
string | the custom event name used for state changed events |
|
eventDispatch |
function | the state update event dispatch function |
|
target |
Element |
<optional> |
the target of the event dispatch. If not passed a fake element will be created |
mutations |
Object |
<optional> |
an object with state mutations functions |
state |
Object |
<optional> |
an object to initialize the state. |
The component descriptor data structure.
Type:
- object
descriptor
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
reactive |
Reactive | an optional reactive module to register in |
|
element |
DOMElement | all components needs an element to anchor events |
|
selectors |
object |
<optional> |
an optional object to override query selectors |
The component descriptor data structure.
This structure is used by any component and init method to define the way the component will interact with the interface and whith reactive instance operates. The logic behind this object is to avoid unnecessary dependancies between the final interface and the state logic.
Any component interacts with a single main DOM element (description.element) but it can use internal selector to select elements within this main element (descriptor.selectors). By default each component will provide it's own default selectors, but those can be overridden by the "descriptor.selectors" property in case the mustache wants to reuse the same component logic but with a different interface.
Type:
- object
LoggerEntry
Properties:
| Name | Type | Description |
|---|---|---|
feedbackMessage |
string | Feedback message. |
Logger entry structure.
Type:
- object
LoggerEntry
Properties:
| Name | Type | Description |
|---|---|---|
feedbackMessage |
string | Feedback message. |
Logger entry structure.
Type:
- object
ProblemDetail
Type:
- object
ProblemNode
Type:
- object