diff options
Diffstat (limited to 'js/classes')
| -rw-r--r-- | js/classes/ElggPriorityList.js | 28 | ||||
| -rw-r--r-- | js/classes/ElggUser.js | 16 |
2 files changed, 41 insertions, 3 deletions
diff --git a/js/classes/ElggPriorityList.js b/js/classes/ElggPriorityList.js index 7b5d16473..b4cec5044 100644 --- a/js/classes/ElggPriorityList.js +++ b/js/classes/ElggPriorityList.js @@ -1,5 +1,6 @@ /** - * + * Priority lists allow you to create an indexed list that can be iterated through in a specific + * order. */ elgg.ElggPriorityList = function() { this.length = 0; @@ -7,10 +8,18 @@ elgg.ElggPriorityList = function() { }; /** + * 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) { - var priority = parseInt(opt_priority || 500, 10); + var priority = 500; + if (arguments.length == 2 && opt_priority != undefined) { + priority = parseInt(opt_priority, 10); + } priority = Math.max(priority, 0); @@ -23,7 +32,13 @@ elgg.ElggPriorityList.prototype.insert = function(obj, opt_priority) { }; /** + * 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); @@ -40,7 +55,13 @@ elgg.ElggPriorityList.prototype.forEach = function(callback) { }; /** + * 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); @@ -55,7 +76,10 @@ elgg.ElggPriorityList.prototype.every = function(callback) { }; /** + * 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) { 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 |
