diff options
Diffstat (limited to 'js/classes')
| -rw-r--r-- | js/classes/ElggPriorityList.js | 96 | ||||
| -rw-r--r-- | js/classes/ElggUser.js | 16 |
2 files changed, 79 insertions, 33 deletions
diff --git a/js/classes/ElggPriorityList.js b/js/classes/ElggPriorityList.js index 521fbbb64..b4cec5044 100644 --- a/js/classes/ElggPriorityList.js +++ b/js/classes/ElggPriorityList.js @@ -1,60 +1,92 @@ +/** + * Priority lists allow you to create an indexed list that can be iterated through in a specific + * order. + */ elgg.ElggPriorityList = function() { this.length = 0; this.priorities_ = []; }; +/** + * Inserts an element into the priority list at the priority specified. + * + * @param {Object} obj The object to insert + * @param {Number} opt_priority An optional priority to insert at. + * + * @return {Void} + */ elgg.ElggPriorityList.prototype.insert = function(obj, opt_priority) { - if (opt_priority == undefined) { - opt_priority = 500; - } - - opt_priority = parseInt(opt_priority); - if (opt_priority < 0) { - opt_priority = 0; + var priority = 500; + if (arguments.length == 2 && opt_priority != undefined) { + priority = parseInt(opt_priority, 10); } - - if (this.priorities_[opt_priority] == undefined) { - this.priorities_[opt_priority] = []; + + priority = Math.max(priority, 0); + + if (elgg.isUndefined(this.priorities_[priority])) { + this.priorities_[priority] = []; } - - this.priorities_[opt_priority].push(obj); + + this.priorities_[priority].push(obj); this.length++; }; +/** + * Iterates through each element in order. + * + * Unlike every, this ignores the return value of the callback. + * + * @param {Function} callback The callback function to pass each element through. See + * Array.prototype.every() for details. + * @return {Object} + */ elgg.ElggPriorityList.prototype.forEach = function(callback) { elgg.assertTypeOf('function', callback); var index = 0; - for (var p in this.priorities_) { - var elems = this.priorities_[p]; - for (var i in elems) { - callback(elems[i], index); - index++; - } - } + + this.priorities_.forEach(function(elems) { + elems.forEach(function(elem) { + callback(elem, index++); + }); + }); + + return this; }; +/** + * Iterates through each element in order. + * + * Unlike forEach, this returns the value of the callback and will break on false. + * + * @param {Function} callback The callback function to pass each element through. See + * Array.prototype.every() for details. + * @return {Object} + */ elgg.ElggPriorityList.prototype.every = function(callback) { elgg.assertTypeOf('function', callback); - + var index = 0; - for (var p in this.priorities_) { - var elems = this.priorities_[p]; - for (var i in elems) { - if (!callback(elems[i], index)) { - return false; - }; - } - } - - return true; + + return this.priorities_.every(function(elems) { + return elems.every(function(elem) { + return callback(elem, index++); + }); + }); }; +/** + * Removes an element from the priority list + * + * @param {Object} obj The object to remove. + * @return {Void} + */ elgg.ElggPriorityList.prototype.remove = function(obj) { - this.priorities_.forEach(function(elems, priority) { + this.priorities_.forEach(function(elems) { var index; - while ((index = elems.indexOf(obj)) != -1) { + while ((index = elems.indexOf(obj)) !== -1) { elems.splice(index, 1); + this.length--; } }); };
\ No newline at end of file diff --git a/js/classes/ElggUser.js b/js/classes/ElggUser.js index 8a7a8b7eb..b8a976fba 100644 --- a/js/classes/ElggUser.js +++ b/js/classes/ElggUser.js @@ -6,9 +6,23 @@ * @class Represents an ElggUser * @property {string} name * @property {string} username + * @property {string} language + * @property {boolean} admin */ elgg.ElggUser = function(o) { elgg.ElggEntity.call(this, o); }; -elgg.inherit(elgg.ElggUser, elgg.ElggEntity);
\ No newline at end of file +elgg.inherit(elgg.ElggUser, elgg.ElggEntity); + +/** + * Is this user an admin? + * + * @warning The admin state of the user should be checked on the server for any + * actions taken that require admin privileges. + * + * @return {boolean} + */ +elgg.ElggUser.prototype.isAdmin = function() { + return this.admin; +};
\ No newline at end of file |
