// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* A javascript module to handle user AJAX actions.
*
* @module core_course/local/activitychooser/repository
* @copyright 2019 Mathew May <mathew.solutions>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
import ajax from 'core/ajax';
/**
* Fetch all the information on modules we'll need in the activity chooser.
*
* @method activityModules
* @param {Number} courseid What course to fetch the modules for
* @param {Number} sectionnum What course section to fetch the modules for
* @return {object} jQuery promise
*/
export const activityModules = (courseid, sectionnum) => {
const request = {
methodname: 'core_course_get_course_content_items',
args: {
courseid: courseid,
sectionnum: sectionnum,
},
};
return ajax.call([request])[0];
};
/**
* Given a module name, module ID & the current course we want to specify that the module
* is a users' favourite.
*
* @method favouriteModule
* @param {String} modName Frankenstyle name of the component to add favourite
* @param {int} modID ID of the module. Mainly for LTI cases where they have same / similar names
* @return {object} jQuery promise
*/
export const favouriteModule = (modName, modID) => {
const request = {
methodname: 'core_course_add_content_item_to_user_favourites',
args: {
componentname: modName,
contentitemid: modID,
},
};
return ajax.call([request])[0];
};
/**
* Given a module name, module ID & the current course we want to specify that the module
* is no longer a users' favourite.
*
* @method unfavouriteModule
* @param {String} modName Frankenstyle name of the component to add favourite
* @param {int} modID ID of the module. Mainly for LTI cases where they have same / similar names
* @return {object} jQuery promise
*/
export const unfavouriteModule = (modName, modID) => {
const request = {
methodname: 'core_course_remove_content_item_from_user_favourites',
args: {
componentname: modName,
contentitemid: modID,
},
};
return ajax.call([request])[0];
};
/**
* Fetch all the information on modules we'll need in the activity chooser.
*
* @method fetchFooterData
* @param {Number} courseid What course to fetch the data for
* @param {Number} sectionid What section to fetch the data for
* @return {object} jQuery promise
*/
export const fetchFooterData = (courseid, sectionid) => {
const request = {
methodname: 'core_course_get_activity_chooser_footer',
args: {
courseid: courseid,
sectionid: sectionid,
},
};
return ajax.call([request])[0];
};