MDL-63044 block_timeline: add timeline block

admin/tool/usertours/tests/behat/create_tour.feature

@@ -27,16 +27,16 @@ Feature: Add a new user tour
       | Selector                    | .usermenu            | User menu         | This is your personal user menu. You'll find your personal preferences and your user profile here. |
     When I am on homepage
     Then I should see "Welcome to your personal learning space. We'd like to give you a quick tour to show you some of the areas you may find helpful"
-    And I press "Next"
+    And I click on "Next" "button" in the "[data-role='flexitour-step']" "css_element"
     And I should see "This area shows you what's happening in some of your courses"
     And I should not see "This is the Calendar. All of your assignments and due dates can be found here"
-    And I press "Next"
+    And I click on "Next" "button" in the "[data-role='flexitour-step']" "css_element"
     And I should see "This is the Calendar. All of your assignments and due dates can be found here"
     And I should not see "This area shows you what's happening in some of your courses"
-    And I press "Prev"
+    And I click on "Prev" "button" in the "[data-role='flexitour-step']" "css_element"
     And I should not see "This is the Calendar. All of your assignments and due dates can be found here"
     And I should see "This area shows you what's happening in some of your courses"
-    And I press "End tour"
+    And I click on "End tour" "button" in the "[data-role='flexitour-step']" "css_element"
     And I should not see "This area shows you what's happening in some of your courses"
     And I am on homepage
     And I should not see "Welcome to your personal learning space. We'd like to give you a quick tour to show you some of the areas you may find helpful"

blocks/timeline/amd/src/calendar_events_repository.js

@@ -0,0 +1,166 @@
+// 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 calendar events from the server.
+ *
+ * @module     block_timeline/calendar_events_repository
+ * @copyright  2018 Ryan Wyllie <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+define(['jquery', 'core/ajax', 'core/notification'], function($, Ajax, Notification) {
+
+    var DEFAULT_LIMIT = 20;
+
+    /**
+     * Retrieve a list of calendar events for the logged in user for the
+     * given course.
+     *
+     * Valid args are:
+     * int courseid     Only get events for this course
+     * int starttime    Only get events after this time
+     * int endtime      Only get events before this time
+     * int limit        Limit the number of results returned
+     * int aftereventid Offset the result set from the given id
+     *
+     * @method queryByCourse
+     * @param {object} args The request arguments
+     * @return {promise} Resolved with an array of the calendar events
+     */
+    var queryByCourse = function(args) {
+        if (!args.hasOwnProperty('limit')) {
+            args.limit = DEFAULT_LIMIT;
+        }
+
+        args.limitnum = args.limit;
+        delete args.limit;
+
+        if (args.hasOwnProperty('starttime')) {
+            args.timesortfrom = args.starttime;
+            delete args.starttime;
+        }
+
+        if (args.hasOwnProperty('endtime')) {
+            args.timesortto = args.endtime;
+            delete args.endtime;
+        }
+
+        var request = {
+            methodname: 'core_calendar_get_action_events_by_course',
+            args: args
+        };
+
+        var promise = Ajax.call([request])[0];
+
+        promise.fail(Notification.exception);
+
+        return promise;
+    };
+
+    /**
+     * Retrieve a list of calendar events for the given courses for the
+     * logged in user.
+     *
+     * Valid args are:
+     * array courseids    Get events for these courses
+     * int   starttime    Only get events after this time
+     * int   endtime      Only get events before this time
+     * int   limit        Limit the number of results returned
+     *
+     * @method queryByCourses
+     * @param {object} args The request arguments
+     * @return {promise} Resolved with an array of the calendar events
+     */
+    var queryByCourses = function(args) {
+        if (!args.hasOwnProperty('limit')) {
+            // This is intentionally smaller than the default limit.
+            args.limit = 10;
+        }
+
+        args.limitnum = args.limit;
+        delete args.limit;
+
+        if (args.hasOwnProperty('starttime')) {
+            args.timesortfrom = args.starttime;
+            delete args.starttime;
+        }
+
+        if (args.hasOwnProperty('endtime')) {
+            args.timesortto = args.endtime;
+            delete args.endtime;
+        }
+
+        var request = {
+            methodname: 'core_calendar_get_action_events_by_courses',
+            args: args
+        };
+
+        var promise = Ajax.call([request])[0];
+
+        promise.fail(Notification.exception);
+
+        return promise;
+    };
+
+    /**
+     * Retrieve a list of calendar events for the logged in user after the given
+     * time.
+     *
+     * Valid args are:
+     * int starttime    Only get events after this time
+     * int endtime      Only get events before this time
+     * int limit        Limit the number of results returned
+     * int aftereventid Offset the result set from the given id
+     *
+     * @method queryByTime
+     * @param {object} args The request arguments
+     * @return {promise} Resolved with an array of the calendar events
+     */
+    var queryByTime = function(args) {
+        if (!args.hasOwnProperty('limit')) {
+            args.limit = DEFAULT_LIMIT;
+        }
+
+        args.limitnum = args.limit;
+        delete args.limit;
+
+        if (args.hasOwnProperty('starttime')) {
+            args.timesortfrom = args.starttime;
+            delete args.starttime;
+        }
+
+        if (args.hasOwnProperty('endtime')) {
+            args.timesortto = args.endtime;
+            delete args.endtime;
+        }
+
+        var request = {
+            methodname: 'core_calendar_get_action_events_by_timesort',
+            args: args
+        };
+
+        var promise = Ajax.call([request])[0];
+
+        promise.fail(Notification.exception);
+
+        return promise;
+    };
+
+    return {
+        queryByTime: queryByTime,
+        queryByCourse: queryByCourse,
+        queryByCourses: queryByCourses,
+    };
+});