Part of MDL-55611 epic.
* @method isLoading
* @private
* @param {object} root The container element
+ * @returns {Boolean}
*/
var isLoading = function(root) {
return root.hasClass('loading');
* @private
* @param {object} group The group container element
* @param {array} calendarEvents The list of calendar events
+ * @param {string} templateName The template name
* @return {promise} Resolved when the elements are attached to the DOM
*/
var renderGroup = function(group, calendarEvents, templateName) {
* Register the event listeners for the container element.
*
* @method registerEventListeners
- * @param {object} The root element of the event list
- * @param {promise} A jquery promise
+ * @param {object} root The root element of the event list
*/
var registerEventListeners = function(root) {
CustomEvents.define(root, [CustomEvents.events.activate]);
// Once all of the course events have been loaded then we need
// to extract just the ones relevant to this course block and
// hand them to the event list to render.
- coursesPromise.done(function (result) {
+ coursesPromise.done(function(result) {
var events = [];
// Get this course block's events from the collection returned
// from the server.
/**
* Get the page element by number.
*
- * @param root
- * @param pageNumber
+ * @param {object} root The root element.
+ * @param {Number} pageNumber The page number.
* @returns {*}
*/
var getPageByNumber = function(root, pageNumber) {
/**
* Get the page number.
*
- * @param root the root element.
- * @param page the page.
+ * @param {object} root The root element.
+ * @param {object} page The page.
* @returns {*} the page number
*/
var getPageNumber = function(root, page) {
/**
* Register event listeners for the module.
- * @param root the root element.
+ * @param {object} root The root element.
*/
var registerEventListeners = function(root) {
root = $(root);
/**
* Constructor of the paging content module.
*
- * @param root
- * @param pagingBarElement
- * @param loadContentCallback
+ * @param {object} root
+ * @param {object} pagingBarElement
* @constructor
*/
var PagingContent = function(root, pagingBarElement) {
/**
* Load content and create page.
*
- * @param pageNumber
+ * @param {Number} pageNumber
* @returns {*|Promise}
*/
PagingContent.prototype.createPage = function(pageNumber) {
return this.loadContent(pageNumber).then(function(html, js) {
Templates.appendNodeContents(this.root, html, js);
- }.bind(this)).then(function () {
+ }.bind(this)).then(function() {
return this.findPage(pageNumber);
}.bind(this)
);
/**
* Find a page by the number.
*
- * @param pageNumber The number of the page to be found.
+ * @param {Number} pageNumber The number of the page to be found.
* @returns {*} Page root
*/
PagingContent.prototype.findPage = function(pageNumber) {
- return this.root.find('[data-page="'+pageNumber+'"]');
+ return this.root.find('[data-page="' + pageNumber + '"]');
};
/**
* Make a page visible.
*
- * @param pageNumber The number of the page to be visible.
+ * @param {Number} pageNumber The number of the page to be visible.
*/
PagingContent.prototype.showPage = function(pageNumber) {
if (existingPage.length) {
existingPage.removeClass('hidden');
} else {
- this.createPage(pageNumber).done(function (newPage) {
+ this.createPage(pageNumber).done(function(newPage) {
newPage.removeClass('hidden');
});
}
$coursesview[$status]['pagingbar']['last'] = ['page' => '»', 'url' => '#'];
for ($page = 0; $page < $quantpages; $page++) {
$coursesview[$status]['pagingbar']['pages'][$page] = [
- 'number' => $page+1,
- 'page' => $page+1,
+ 'number' => $page + 1,
+ 'page' => $page + 1,
'url' => '#',
'active' => ($page == 0 ? true : false)
];