first commit

blocks/starredcourses/amd/build/main.min.js

@@ -0,0 +1,10 @@
+/**
+ * Javascript to initialise the starred courses block.
+ *
+ * @module block_starredcourses/main
+ * @copyright   2018 Simey Lameze <simey@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+define("block_starredcourses/main",["jquery","core/notification","block_starredcourses/repository","core/pubsub","core/templates","core_course/events"],(function($,Notification,Repository,PubSub,Templates,CourseEvents){var SELECTORS_BLOCK_CONTAINER='[data-region="starred-courses"]',SELECTORS_STARRED_COURSES_REGION_VIEW='[data-region="starred-courses-view"]',SELECTORS_STARRED_COURSES_REGION='[data-region="starred-courses-view-content"]',reloadContent=function(root){var content=root.find(SELECTORS_STARRED_COURSES_REGION);return Repository.getStarredCourses({limit:0,offset:0}).then((function(courses){var showcoursecategory=$(SELECTORS_BLOCK_CONTAINER).data("displaycoursecategory");return courses=courses.map((function(course){return course.showcoursecategory=showcoursecategory,course})),function(root,courses){if(courses.length>0)return Templates.render("core_course/view-cards",{courses:courses});var nocoursesimg=root.find(SELECTORS_STARRED_COURSES_REGION_VIEW).attr("data-nocoursesimg");return Templates.render("block_starredcourses/no-courses",{nocoursesimg:nocoursesimg})}(root,courses)})).then((function(html,js){return Templates.replaceNodeContents(content,html,js)})).catch(Notification.exception)};return{init:function(root){(function(root){PubSub.subscribe(CourseEvents.favourited,(function(){reloadContent(root)})),PubSub.subscribe(CourseEvents.unfavorited,(function(){reloadContent(root)}))})(root=$(root)),reloadContent(root)}}}));
+
+//# sourceMappingURL=main.min.js.map

blocks/starredcourses/amd/build/repository.min.js

@@ -0,0 +1,10 @@
+/**
+ * A javascript module to retrieve user's starred courses.
+ *
+ * @module block_starredcourses/repository
+ * @copyright  2018 Simey Lameze <simey@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+define("block_starredcourses/repository",["jquery","core/ajax","core/notification"],(function($,Ajax,Notification){return{getStarredCourses:function(args){var request={methodname:"block_starredcourses_get_starred_courses",args:args},promise=Ajax.call([request])[0];return promise.fail(Notification.exception),promise}}}));
+
+//# sourceMappingURL=repository.min.js.map

blocks/starredcourses/amd/build/repository.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.min.js","sources":["../src/repository.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * A javascript module to retrieve user's starred courses.\n *\n * @module block_starredcourses/repository\n * @copyright  2018 Simey Lameze <simey@moodle.com>\n * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\ndefine(['jquery', 'core/ajax', 'core/notification'], function($, Ajax, Notification) {\n\n    /**\n     * Retrieve a list of starred courses.\n     *\n     * Valid args are:\n     * int limit    number of records to retrieve\n     * int offset   the offset of records to retrieve\n     *\n     * @method getStarredCourses\n     * @param {object} args The request arguments\n     * @return {promise} Resolved with an array of courses\n     */\n    var getStarredCourses = function(args) {\n\n        var request = {\n            methodname: 'block_starredcourses_get_starred_courses',\n            args: args\n        };\n\n        var promise = Ajax.call([request])[0];\n\n        promise.fail(Notification.exception);\n\n        return promise;\n    };\n\n    return {\n        getStarredCourses: getStarredCourses\n    };\n});\n"],"names":["define","$","Ajax","Notification","getStarredCourses","args","request","methodname","promise","call","fail","exception"],"mappings":";;;;;;;AAsBAA,yCAAO,CAAC,SAAU,YAAa,sBAAsB,SAASC,EAAGC,KAAMC,oBA2B5D,CACHC,kBAfoB,SAASC,UAEzBC,QAAU,CACVC,WAAY,2CACZF,KAAMA,MAGNG,QAAUN,KAAKO,KAAK,CAACH,UAAU,UAEnCE,QAAQE,KAAKP,aAAaQ,WAEnBH"}

blocks/starredcourses/amd/src/main.js

@@ -0,0 +1,127 @@
+// 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/>.
+
+/**
+ * Javascript to initialise the starred courses block.
+ *
+ * @module block_starredcourses/main
+ * @copyright   2018 Simey Lameze <simey@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+define(
+[
+    'jquery',
+    'core/notification',
+    'block_starredcourses/repository',
+    'core/pubsub',
+    'core/templates',
+    'core_course/events'
+],
+function(
+    $,
+    Notification,
+    Repository,
+    PubSub,
+    Templates,
+    CourseEvents
+) {
+
+    var SELECTORS = {
+        BLOCK_CONTAINER: '[data-region="starred-courses"]',
+        STARRED_COURSES_REGION_VIEW: '[data-region="starred-courses-view"]',
+        STARRED_COURSES_REGION: '[data-region="starred-courses-view-content"]'
+    };
+
+    /**
+     * Render the starred courses.
+     *
+     * @method renderCourses
+     * @param {object} root The root element for the starred view.
+     * @param {array} courses containing array of returned courses.
+     * @returns {promise} Resolved with HTML and JS strings
+     */
+    var renderCourses = function(root, courses) {
+        if (courses.length > 0) {
+            return Templates.render('core_course/view-cards', {
+                courses: courses
+            });
+        } else {
+            var nocoursesimg = root.find(SELECTORS.STARRED_COURSES_REGION_VIEW).attr('data-nocoursesimg');
+            return Templates.render('block_starredcourses/no-courses', {
+                nocoursesimg: nocoursesimg
+            });
+        }
+    };
+
+    /**
+     * Fetch user's starred courses and reload the content of the block.
+     *
+     * @param {object} root The root element for the starred view.
+     * @returns {promise} The updated content for the block.
+     */
+    var reloadContent = function(root) {
+        var content = root.find(SELECTORS.STARRED_COURSES_REGION);
+
+        var args = {
+            limit: 0,
+            offset: 0,
+        };
+
+        return Repository.getStarredCourses(args)
+            .then(function(courses) {
+                // Whether the course category should be displayed in the course item.
+                var showcoursecategory = $(SELECTORS.BLOCK_CONTAINER).data('displaycoursecategory');
+                courses = courses.map(function(course) {
+                    course.showcoursecategory = showcoursecategory;
+                    return course;
+                });
+                return renderCourses(root, courses);
+            }).then(function(html, js) {
+                return Templates.replaceNodeContents(content, html, js);
+            }).catch(Notification.exception);
+    };
+
+    /**
+     * Register event listeners for the block.
+     *
+     * @param {object} root The calendar root element
+     */
+    var registerEventListeners = function(root) {
+        PubSub.subscribe(CourseEvents.favourited, function() {
+            reloadContent(root);
+        });
+
+        PubSub.subscribe(CourseEvents.unfavorited, function() {
+            reloadContent(root);
+        });
+    };
+
+    /**
+     * Initialise all of the modules for the starred courses block.
+     *
+     * @param {object} root The root element for the block.
+     */
+    var init = function(root) {
+        root = $(root);
+
+        registerEventListeners(root);
+        reloadContent(root);
+    };
+
+    return {
+        init: init
+    };
+});

blocks/starredcourses/amd/src/repository.js

@@ -0,0 +1,53 @@
+// 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 retrieve user's starred courses.
+ *
+ * @module block_starredcourses/repository
+ * @copyright  2018 Simey Lameze <simey@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+define(['jquery', 'core/ajax', 'core/notification'], function($, Ajax, Notification) {
+
+    /**
+     * Retrieve a list of starred courses.
+     *
+     * Valid args are:
+     * int limit    number of records to retrieve
+     * int offset   the offset of records to retrieve
+     *
+     * @method getStarredCourses
+     * @param {object} args The request arguments
+     * @return {promise} Resolved with an array of courses
+     */
+    var getStarredCourses = function(args) {
+
+        var request = {
+            methodname: 'block_starredcourses_get_starred_courses',
+            args: args
+        };
+
+        var promise = Ajax.call([request])[0];
+
+        promise.fail(Notification.exception);
+
+        return promise;
+    };
+
+    return {
+        getStarredCourses: getStarredCourses
+    };
+});