Code Cleanup

This commit is contained in:
PMKuipers 2024-07-19 14:26:08 +02:00
parent 3bef1118b2
commit c2c5383e10

View File

@ -2,15 +2,15 @@
/* eslint no-unused-vars: "off" */ /* eslint no-unused-vars: "off" */
/* eslint linebreak-style: "off" */ /* eslint linebreak-style: "off" */
/* eslint no-trailing-spaces: "off" */ /* eslint no-trailing-spaces: "off" */
/* eslint no-empty-function: "off" */
/* eslint-env es6*/ /* eslint-env es6*/
// Put this file in path/to/plugin/amd/src // Put this file in path/to/plugin/amd/src
// You can call it anything you like // You can call it anything you like
import {get_string,get_strings} from 'core/str';
import {call} from 'core/ajax'; import {call} from 'core/ajax';
import notification from 'core/notification'; import notification from 'core/notification';
//import {resetAllFormDirtyStates} from 'core_form/changechecker'; // Moodle 4.00+ only // Commented out: import {resetAllFormDirtyStates} from 'core_form/changechecker'; // Moodle 4.00+ only
import Vue from './vue/vue'; import Vue from './vue/vue';
@ -27,9 +27,9 @@ import {addBrowserButtonEvent} from './util/browserbuttonevents';
import {loadStrings} from './util/string-helper'; import {loadStrings} from './util/string-helper';
import {processStudyplan} from './studyplan-processor'; import {processStudyplan} from './studyplan-processor';
import {download,upload} from './downloader'; import {download, upload} from './downloader';
import {studyplanTiming} from './util/date-helper'; import {studyplanTiming} from './util/date-helper';
import { premiumenabled, premiumstatus } from "./util/premium"; import {premiumenabled, premiumstatus} from "./util/premium";
import mFormComponents from "./util/mform-helper"; import mFormComponents from "./util/mform-helper";
Vue.use(mFormComponents); Vue.use(mFormComponents);
@ -41,22 +41,21 @@ Vue.use(BootstrapVue);
const debug = new Debugger("treestudyplan"); const debug = new Debugger("treestudyplan");
let resetAllFormDirtyStates = () => {}; let resetAllFormDirtyStates = () => { };
import('core_form/changechecker').then((ns) => { import('core_form/changechecker').then((ns) => {
debug.info(ns); debug.info(ns);
if(ns.resetAllFormDirtyStates) { if (ns.resetAllFormDirtyStates) {
resetAllFormDirtyStates = ns.resetAllFormDirtyStates; resetAllFormDirtyStates = ns.resetAllFormDirtyStates;
} }
return;
}).catch(()=>{}); }).catch(()=>{});
let strings = loadStrings({ let strings = loadStrings({
studyplan: { studyplan: {
studyplan_select_placeholder: 'studyplan_select_placeholder', 'studyplan_select_placeholder': 'studyplan_select_placeholder',
advanced_import_from_file: 'advanced_import_from_file', 'advanced_import_from_file': 'advanced_import_from_file',
advanced_create_from_template: 'advanced_create_from_template', 'advanced_create_from_template': 'advanced_create_from_template',
studyplan_add: "studyplan_add", 'studyplan_add': "studyplan_add",
}, },
}); });
@ -66,21 +65,27 @@ let strings = loadStrings({
* @param {int} categoryid The category we shoud attempt to work in (1:1 related to the context) * @param {int} categoryid The category we shoud attempt to work in (1:1 related to the context)
* @param {object} options Options to be passed to this script * @param {object} options Options to be passed to this script
*/ */
export function init(contextid,categoryid,options) { export function init(contextid, categoryid, options) {
// Make sure the id's are numeric and integer // Make sure the id's are numeric and integer
if(undefined === contextid || !Number.isInteger(Number(contextid)) || contextid < 1 ){ contextid = 1;} if (undefined === contextid || !Number.isInteger(Number(contextid)) || contextid < 1) {
else { contextid = Number(contextid);} // ensure a numeric value instead of string contextid = 1;
if(undefined === categoryid || !Number.isInteger(Number(categoryid))){ categoryid = 0;} } else {
else { categoryid = Number(categoryid);} // ensure a numeric value instead of string contextid = Number(contextid); // Ensure a numeric value instead of string
}
if (undefined === categoryid || !Number.isInteger(Number(categoryid))) {
categoryid = 0;
} else {
categoryid = Number(categoryid); // Ensure a numeric value instead of string
}
debug.info("options",options); debug.info("options", options);
if ( options !== null && typeof options === 'object' && !Array.isArray(options) ) { if (options !== null && typeof options === 'object' && !Array.isArray(options)) {
if ( !options.defaultAggregation ) { if (!options.defaultAggregation) {
options.defaultAggregation = "core"; options.defaultAggregation = "core";
} }
} else { } else {
options = { defaultAggregation: "core"}; options = {defaultAggregation: "core"};
} }
// Setup the initial Vue app for this page // Setup the initial Vue app for this page
@ -93,12 +98,12 @@ export function init(contextid,categoryid,options) {
shortname: '', shortname: '',
description: '', description: '',
idnumber: '', idnumber: '',
slots : 4, slots: 4,
startdate: '2020-08-01', startdate: '2020-08-01',
enddate: '', enddate: '',
context: contextid, context: contextid,
aggregation: options.defaultAggregation, aggregation: options.defaultAggregation,
aggregation_config: '', 'aggregation_config': '',
} }
}, },
@ -112,21 +117,21 @@ export function init(contextid,categoryid,options) {
usedcontexts: [], usedcontexts: [],
}, },
created() { created() {
this.$root.$on('studyplanRemoved',(studyplan)=>{ this.$root.$on('studyplanRemoved', (studyplan)=>{
if(app.activestudyplan == studyplan){ if (app.activestudyplan == studyplan) {
app.activestudyplan = null; app.activestudyplan = null;
} }
// remove studyplan from index list // Remove studyplan from index list
let index = null; let index = null;
for(let idx in app.studyplans){ for (let idx in app.studyplans) {
if(app.studyplans[idx].id == studyplan.id){ if (app.studyplans[idx].id == studyplan.id) {
index = idx; index = idx;
break; break;
} }
} }
if(index){ if (index) {
app.studyplans.splice(index, 1); app.studyplans.splice(index, 1);
} }
@ -141,15 +146,14 @@ export function init(contextid,categoryid,options) {
}, },
computed: { computed: {
premiumenabled, premiumenabled,
dropdown_title(){ dropdownTitle() {
if(this.activestudyplan && this.activestudyplan.name){ if (this.activestudyplan && this.activestudyplan.name) {
return this.activestudyplan.name; return this.activestudyplan.name;
} } else {
else{
return this.text.studyplan_select_placeholder; return this.text.studyplan_select_placeholder;
} }
}, },
contextid(){ contextid() {
return contextid; return contextid;
}, },
@ -165,20 +169,20 @@ export function init(contextid,categoryid,options) {
initialize() { initialize() {
call([{ call([{
methodname: 'local_treestudyplan_list_studyplans', methodname: 'local_treestudyplan_list_studyplans',
args: { context_id: contextid} args: {'context_id': contextid}
}])[0].then(function(response){ }])[0].then(function(response) {
const timingval = { future: 0, present: 1, past: 2, }; const timingval = {future: 0, present: 1, past: 2};
response.sort((a,b) => { response.sort((a, b) => {
const timinga = studyplanTiming(a); const timinga = studyplanTiming(a);
const timingb = studyplanTiming(b); const timingb = studyplanTiming(b);
let t = timingval[timinga] - timingval[timingb]; let t = timingval[timinga] - timingval[timingb];
if(t == 0){ if (t == 0) {
// sort by start date if timing is equal // Sort by start date if timing is equal
t = new Date(b.startdate).getTime() - new Date(a.startdate).getTime(); t = new Date(b.startdate).getTime() - new Date(a.startdate).getTime();
if (t == 0) { if (t == 0) {
// sort by name if timing is equal // Sort by name if timing is equal
t = a.name.localeCompare(b.name); t = a.name.localeCompare(b.name);
} }
} }
@ -186,51 +190,54 @@ export function init(contextid,categoryid,options) {
}); });
app.studyplans = response; app.studyplans = response;
// load studyplan from hash if applicable // Load studyplan from hash if applicable
const hash = location.hash.replace('#',''); const hash = location.hash.replace('#', '');
if(hash){ if (hash) {
const id = hash; const id = hash;
for(const p of app.studyplans) { for (const p of app.studyplans) {
if (p.id == id) { if (p.id == id) {
app.selectStudyplan(id); app.selectStudyplan(id);
break; break;
} }
} }
} }
return;
}).catch(notification.exception); }).catch(notification.exception);
call([{ call([{
methodname: 'local_treestudyplan_list_available_categories', methodname: 'local_treestudyplan_list_available_categories',
args: { operation: 'edit', refcontext_id: contextid} args: {operation: 'edit', 'refcontext_id': contextid}
}])[0].then(function(response){ }])[0].then(function(response) {
app.usedcontexts = response; app.usedcontexts = response;
return;
}).catch(notification.exception); }).catch(notification.exception);
this.refreshTemplateCount(); this.refreshTemplateCount();
}, },
refreshTemplateCount(){ refreshTemplateCount() {
call([{ call([{
methodname: 'local_treestudyplan_count_templates', methodname: 'local_treestudyplan_count_templates',
args: { } args: { }
}])[0].then(function(response){ }])[0].then(function(response) {
app.templatecount = response; app.templatecount = response;
return;
}).catch(notification.exception); }).catch(notification.exception);
}, },
closeStudyplan() { closeStudyplan() {
app.activestudyplan = null; app.activestudyplan = null;
window.location.hash = ''; window.location.hash = '';
}, },
movedStudyplan(plan,from,to) { movedStudyplan(plan, from, to) {
// reload the page in the new context (needed, since a number of links are not reactive in the page) // Reload the page in the new context (needed, since a number of links are not reactive in the page)
const params = new URLSearchParams(location.search); const params = new URLSearchParams(location.search);
params.delete('categoryid'); params.delete('categoryid');
params.set("contextid", to); params.set("contextid", to);
setTimeout(() => { setTimeout(() => {
// Reload page in a timeout to give other form javasccript the change to remove the beforeunload handler. // Reload page in a timeout to give other form javasccript the change to remove the beforeunload handler.
window.location.search = params.toString(); window.location.search = params.toString();
},50); }, 50);
}, },
onStudyPlanCreated(newstudyplan){ onStudyPlanCreated(newstudyplan) {
if (newstudyplan.context_id != contextid) { if (newstudyplan.context_id != contextid) {
// Study plan has changed context id - reload page into new context id and show the plan // Study plan has changed context id - reload page into new context id and show the plan
const params = new URLSearchParams(location.search); const params = new URLSearchParams(location.search);
@ -244,69 +251,53 @@ export function init(contextid,categoryid,options) {
app.selectStudyplan(newstudyplan.id); app.selectStudyplan(newstudyplan.id);
} }
}, },
switchContext(ctxid){ switchContext(ctxid) {
const params = new URLSearchParams(location.search); const params = new URLSearchParams(location.search);
params.delete('categoryid'); params.delete('categoryid');
params.set('contextid', ctxid); params.set('contextid', ctxid);
setTimeout(() => { setTimeout(() => {
// Reload page in a timeout to give other form javasccript the change to remove the beforeunload handler. // Reload page in a timeout to give other form javasccript the change to remove the beforeunload handler.
window.location.href = window.location.pathname + "?" + params.toString(); window.location.href = window.location.pathname + "?" + params.toString();
},50); }, 50);
}, },
selectStudyplan(studyplanid){ selectStudyplan(studyplanid) {
// fetch studyplan // Fetch studyplan
app.loadingstudyplan = true; app.loadingstudyplan = true;
app.activestudyplan = null; app.activestudyplan = null;
call([{ call([{
methodname: 'local_treestudyplan_get_studyplan_map', methodname: 'local_treestudyplan_get_studyplan_map',
args: { id: studyplanid} args: {id: studyplanid}
}])[0].then(function(response){ }])[0].then(function(response) {
app.activestudyplan = processStudyplan(response); app.activestudyplan = processStudyplan(response);
debug.info('studyplan processed'); debug.info('studyplan processed');
app.loadingstudyplan = false; app.loadingstudyplan = false;
window.location.hash = app.activestudyplan.id; window.location.hash = app.activestudyplan.id;
}).catch(function(error){ return;
}).catch(function(error) {
notification.exception(error); notification.exception(error);
app.loadingstudyplan = false; app.loadingstudyplan = false;
}); });
}, },
import_studyplan(){ importStudyplan() {
const self = this; const self = this;
upload((filename,content)=>{ upload((filename, content)=>{
call([{ call([{
methodname: 'local_treestudyplan_import_plan', methodname: 'local_treestudyplan_import_plan',
args: { args: {
content: content, content: content,
format: "application/json", format: "application/json",
context_id: contextid, 'context_id': contextid,
}, },
}])[0].then(function(response){ }])[0].then(function(response) {
if(response.success){ if (response.success) {
self.initialize(); self.initialize();
} else { } else {
debug.error("Import failed: ",response.msg); debug.error("Import failed: ", response.msg);
} }
return;
}).catch(notification.exception); }).catch(notification.exception);
}, "application/json"); }, "application/json");
}, },
export_plan(plan,format){
let self = this;
if(format == undefined || !["json","csv"].includes(format)){
format = "json";
}
call([{
methodname: 'local_treestudyplan_export_plan',
args: {
studyplan_id: plan.id,
format: format
},
}])[0].then(function(response){
download(plan.shortname+".json",response.content,response.format);
}).catch(notification.exception);
},
}, },
}); });
} }