diff options
Diffstat (limited to 'js/classes')
-rw-r--r-- | js/classes/ElggEntity.js | 20 | ||||
-rw-r--r-- | js/classes/ElggPriorityList.js | 92 | ||||
-rw-r--r-- | js/classes/ElggUser.js | 28 |
3 files changed, 140 insertions, 0 deletions
diff --git a/js/classes/ElggEntity.js b/js/classes/ElggEntity.js new file mode 100644 index 000000000..9461a463f --- /dev/null +++ b/js/classes/ElggEntity.js @@ -0,0 +1,20 @@ +/** + * Create a new ElggEntity + * + * @class Represents an ElggEntity + * @property {number} guid + * @property {string} type + * @property {string} subtype + * @property {number} owner_guid + * @property {number} site_guid + * @property {number} container_guid + * @property {number} access_id + * @property {number} time_created + * @property {number} time_updated + * @property {number} last_action + * @property {string} enabled + * + */ +elgg.ElggEntity = function(o) { + $.extend(this, o); +};
\ No newline at end of file diff --git a/js/classes/ElggPriorityList.js b/js/classes/ElggPriorityList.js new file mode 100644 index 000000000..b4cec5044 --- /dev/null +++ b/js/classes/ElggPriorityList.js @@ -0,0 +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) { + var priority = 500; + if (arguments.length == 2 && opt_priority != undefined) { + priority = parseInt(opt_priority, 10); + } + + priority = Math.max(priority, 0); + + if (elgg.isUndefined(this.priorities_[priority])) { + this.priorities_[priority] = []; + } + + 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; + + 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; + + 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) { + var index; + 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 new file mode 100644 index 000000000..b8a976fba --- /dev/null +++ b/js/classes/ElggUser.js @@ -0,0 +1,28 @@ +/** + * Create a new ElggUser + * + * @param {Object} o + * @extends ElggEntity + * @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); + +/** + * 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 |