mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-05-13 11:06:03 +02:00
Code Issues Releases Wiki Activity

[ticket/10271] Added some documentation to phpbb.ajaxify.

Browse Source 
PHPBB3-10271
This commit is contained in:
Callum Macrae 2011-11-30 16:58:17 +00:00 committed by Igor Wiedler
parent eee0624a69
commit 3e53dff95c
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
phpBB/assets/javascript/core.js
View File

@ -252,9 +252,11 @@ phpbb.ajaxify = function(options, refresh, callback) {
*/ */
function return_handler(res) function return_handler(res)
{ {
// Is a confirmation required?
if (typeof res.S_CONFIRM_ACTION === 'undefined') 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') if (typeof res.MESSAGE_TITLE !== 'undefined')
{ {
var alert = phpbb.alert(res.MESSAGE_TITLE, res.MESSAGE_TEXT); 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); 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 (res.REFRESH_DATA)
{ {
if (typeof refresh === 'function') if (typeof refresh === 'function')
@ -286,15 +290,17 @@ phpbb.ajaxify = function(options, refresh, callback) {
window.location = res.REFRESH_DATA.url; 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() { dark.fadeOut(phpbb.alert_time, function() {
alert.hide(); alert.hide();
}); });
}, res.REFRESH_DATA.time * 1000); }, res.REFRESH_DATA.time * 1000); // Server specifies time in seconds
} }
} }
else 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) { phpbb.confirm(res.MESSAGE_TEXT, function(del) {
if (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'); var run_exception = (typeof options.exception === 'function');
if (is_form) if (is_form)
{ {
@ -323,6 +331,8 @@ phpbb.ajaxify = function(options, refresh, callback) {
data += '&' + this.name + '=' + this.value; 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)) if (run_exception && options.exception.call($this.parents('form')[0], action, data))
{ {
return true; return true;
@ -332,6 +342,8 @@ phpbb.ajaxify = function(options, refresh, callback) {
} }
else 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)) if (run_exception && options.exception.call(this))
{ {
return true; return true;