diff options
| author | Callum Macrae <callum@lynxphp.com> | 2011-11-30 16:58:17 +0000 |
|---|---|---|
| committer | Igor Wiedler <igor@wiedler.ch> | 2012-03-31 02:09:23 +0200 |
| commit | 3e53dff95c0957cd26d0256f40b5288094550f90 (patch) | |
| tree | 80d57a833100c52297614d4b7343aefc4f318154 | |
| parent | eee0624a69389a10d3dcb97a5587fa6007be90f8 (diff) | |
| download | forums-3e53dff95c0957cd26d0256f40b5288094550f90.tar forums-3e53dff95c0957cd26d0256f40b5288094550f90.tar.gz forums-3e53dff95c0957cd26d0256f40b5288094550f90.tar.bz2 forums-3e53dff95c0957cd26d0256f40b5288094550f90.tar.xz forums-3e53dff95c0957cd26d0256f40b5288094550f90.zip | |
[ticket/10271] Added some documentation to phpbb.ajaxify.
PHPBB3-10271
| -rw-r--r-- | phpBB/assets/javascript/core.js | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/phpBB/assets/javascript/core.js b/phpBB/assets/javascript/core.js index 235fa41a1a..d32bb2d1c2 100644 --- a/phpBB/assets/javascript/core.js +++ b/phpBB/assets/javascript/core.js @@ -252,9 +252,11 @@ phpbb.ajaxify = function(options, refresh, callback) { */ function return_handler(res) { + // Is a confirmation required? if (typeof res.S_CONFIRM_ACTION === 'undefined') { - // It is a standard link, no confirm_box required. + // If a confirmation is not required, display an alert and call the + // callbacks. if (typeof res.MESSAGE_TITLE !== 'undefined') { var alert = phpbb.alert(res.MESSAGE_TITLE, res.MESSAGE_TEXT); @@ -269,6 +271,8 @@ phpbb.ajaxify = function(options, refresh, callback) { phpbb.ajax_callbacks[callback].call(that, res, (is_form) ? act : null); } + // If the server says to refresh the page, check whether the page should + // be refreshed and refresh page after specified time if required. if (res.REFRESH_DATA) { if (typeof refresh === 'function') @@ -286,15 +290,17 @@ phpbb.ajaxify = function(options, refresh, callback) { window.location = res.REFRESH_DATA.url; } + // Hide the alert even if we refresh the page, in case the user + // presses the back button. dark.fadeOut(phpbb.alert_time, function() { alert.hide(); }); - }, res.REFRESH_DATA.time * 1000); + }, res.REFRESH_DATA.time * 1000); // Server specifies time in seconds } } else { - // confirm_box - confirm with the user and send back + // If confirmation is required, display a diologue to the user. phpbb.confirm(res.MESSAGE_TEXT, function(del) { if (del) { @@ -306,6 +312,8 @@ phpbb.ajaxify = function(options, refresh, callback) { } } + // If the element is a form, POST must be used and some extra data must + // be taken from the form. var run_exception = (typeof options.exception === 'function'); if (is_form) { @@ -323,6 +331,8 @@ phpbb.ajaxify = function(options, refresh, callback) { data += '&' + this.name + '=' + this.value; } + // If exception function returns true, cancel the AJAX functionality, + // and return true (meaning that the HTTP request will be sent normally). if (run_exception && options.exception.call($this.parents('form')[0], action, data)) { return true; @@ -332,6 +342,8 @@ phpbb.ajaxify = function(options, refresh, callback) { } else { + // If exception function returns true, cancel the AJAX functionality, + // and return true (meaning that the HTTP request will be sent normally). if (run_exception && options.exception.call(this)) { return true; |