From 441c9e85dcb824dba2a44657a31fa29ad71a4ee1 Mon Sep 17 00:00:00 2001 From: ewinslow Date: Tue, 2 Nov 2010 16:06:53 +0000 Subject: Refs #2538: Moved js directory to elgg root. git-svn-id: http://code.elgg.org/elgg/trunk@7189 36083f99-b078-4883-b0ff-0f9b5a30f544 --- engine/js/lib/ajax.js | 252 -------------------------------------------------- 1 file changed, 252 deletions(-) delete mode 100644 engine/js/lib/ajax.js (limited to 'engine/js/lib/ajax.js') diff --git a/engine/js/lib/ajax.js b/engine/js/lib/ajax.js deleted file mode 100644 index 184fd0da3..000000000 --- a/engine/js/lib/ajax.js +++ /dev/null @@ -1,252 +0,0 @@ -elgg.provide('elgg.ajax'); - -/** - * @author Evan Winslow - * Provides a bunch of useful shortcut functions for making ajax calls - */ - -/** - * Wrapper function for jQuery.ajax which ensures that the url being called - * is relative to the elgg site root. - * - * You would most likely use elgg.get or elgg.post, rather than this function - * - * @param {string} url Optionally specify the url as the first argument - * @param {Object} options Optional. {@see jQuery#ajax} - * @return {XmlHttpRequest} - */ -elgg.ajax = function(url, options) { - options = elgg.ajax.handleOptions(url, options); - - options.url = elgg.normalize_url(options.url); - return $.ajax(options); -}; -/** - * @const - */ -elgg.ajax.SUCCESS = 0; - -/** - * @const - */ -elgg.ajax.ERROR = -1; - -/** - * Handle optional arguments and return the resulting options object - * - * @param url - * @param options - * @return {Object} - * @private - */ -elgg.ajax.handleOptions = function(url, options) { - //elgg.ajax('example/file.php', {...}); - if(typeof url == 'string') { - options = options || {}; - - //elgg.ajax({...}); - } else { - options = url || {}; - url = options.url; - } - - var data_only = true; - - //elgg.ajax('example/file.php', function() {...}); - if (typeof options == 'function') { - data_only = false; - options = {success: options}; - } - - //elgg.ajax('example/file.php', {data:{...}}); - if(options.data) { - data_only = false; - } else { - for (var member in options) { - //elgg.ajax('example/file.php', {callback:function(){...}}); - if(typeof options[member] == 'function') { - data_only = false; - } - } - } - - //elgg.ajax('example/file.php', {notdata:notfunc}); - if (data_only) { - var data = options; - options = {data: data}; - } - - if (url) { - options.url = url; - } - - return options; -}; - -/** - * Wrapper function for elgg.ajax which forces the request type to 'get.' - * - * @param {string} url Optionally specify the url as the first argument - * @param {Object} options {@see jQuery#ajax} - * @return {XmlHttpRequest} - */ -elgg.get = function(url, options) { - options = elgg.ajax.handleOptions(url, options); - - options.type = 'get'; - return elgg.ajax(options); -}; - -/** - * Wrapper function for elgg.get which forces the dataType to 'json.' - * - * @param {string} url Optionally specify the url as the first argument - * @param {Object} options {@see jQuery#ajax} - * @return {XmlHttpRequest} - */ -elgg.getJSON = function(url, options) { - options = elgg.ajax.handleOptions(url, options); - - options.dataType = 'json'; - return elgg.get(options); -}; - -/** - * Wrapper function for elgg.ajax which forces the request type to 'post.' - * - * @param {string} url Optionally specify the url as the first argument - * @param {Object} options {@see jQuery#ajax} - * @return {XmlHttpRequest} - */ -elgg.post = function(url, options) { - options = elgg.ajax.handleOptions(url, options); - - options.type = 'post'; - return elgg.ajax(options); -}; - -/** - * Perform an action via ajax - * - * @example Usage 1: - * At its simplest, only the action name is required (and anything more than the - * action name will be invalid). - * 
- * elgg.action('name/of/action');
- *
- * Note that it will *not* love you if you specify the full url as the action - * (i.e. elgg.yoursite.com/action/name/of/action), but why would you want to do - * that anyway, when you can just specify the action name? - * - * @example Usage 2: - * If you want to pass some data along with it, use the second parameter - * 
- * elgg.action('friend/add', { friend: some_guid });
- *
- * - * @example Usage 3: - * Of course, you will have no control over what happens when the request - * completes if you do it like that, so there's also the most verbose method - * 
- * elgg.action('friend/add', {
- *     data: {
- *         friend: some_guid
- *     },
- *     success: function(json) {
- *         //do something
- *     },
- * }
- *
- * You can pass any of your favorite $.ajax arguments into this second parameter. - * - * Note: If you intend to use the second field in the "verbose" way, you must - * specify a callback method or the data parameter. If you do not, elgg.action - * will think you mean to send the second parameter as data. - * - * @param {String} action The action to call. - * @param {Object} options {@see jQuery#ajax} - * @return {XMLHttpRequest} - */ -elgg.action = function(action, options) { - if(!action) { - throw new TypeError("action must be specified"); - } else if (typeof action != 'string') { - throw new TypeError("action must be a string"); - } - - options = elgg.ajax.handleOptions('action/' + action, options); - - options.data = elgg.security.addToken(options.data); - options.dataType = 'json'; - - //Always display system messages after actions - var custom_success = options.success || function(){}; - options.success = function(json, two, three, four) { - if (json.system_messages) { - elgg.register_error(json.system_messages.errors); - elgg.system_message(json.system_messages.messages); - } - custom_success(json, two, three, four); - }; - - return elgg.post(options); -}; - -/** - * Make an API call - * - * @example Usage: - * 
- * elgg.api('system.api.list', {
- *     success: function(data) {
- *         console.log(data);
- *     }
- * });
- *
- * - * @param {String} method The API method to be called - * @param {Object} options {@see jQuery#ajax} - * @return {XmlHttpRequest} - */ -elgg.api = function(method, options) { - if (!method) { - throw new TypeError("method must be specified"); - } else if (typeof method != 'string') { - throw new TypeError("method must be a string"); - } - - var defaults = { - dataType: 'json', - data: {} - }; - - options = elgg.ajax.handleOptions(method, options); - options = $.extend(defaults, options); - - options.url = 'services/api/rest/' + options.dataType + '/'; - options.data.method = method; - - return elgg.ajax(options); -}; - -/** - * @param {string} selector a jQuery selector - * @param {Function} complete A function to execute when the refresh is done - * @return {XMLHttpRequest} - */ -elgg.refresh = function(selector, complete) { - $(selector).html('
'); - return $(selector).load(location.href + ' ' + selector + ' > *', complete); -}; - -/** - * @param {string} selector a jQuery selector (usually an #id) - * @param {number} interval The refresh interval in seconds - * @param {Function} complete A function to execute when the refresh is done - * @return {number} The interval identifier - */ -elgg.feed = function(selector, interval, complete) { - return setInterval(function() { - elgg.refresh(selector, complete); - }, interval); -}; \ No newline at end of file -- cgit v1.2.3