diff options
| author | Callum Macrae <callum@lynxphp.com> | 2011-10-15 17:29:34 +0100 |
|---|---|---|
| committer | Igor Wiedler <igor@wiedler.ch> | 2012-03-31 02:09:18 +0200 |
| commit | 3648dd99f7d5c640e9b6c92b182f8b88fd867842 (patch) | |
| tree | b6b0a3a1c986093aab3de24e7ad779088bc88927 | |
| parent | 3166cbb33d5ce44fff380d53c4c51ba5f6a2224a (diff) | |
| download | forums-3648dd99f7d5c640e9b6c92b182f8b88fd867842.tar forums-3648dd99f7d5c640e9b6c92b182f8b88fd867842.tar.gz forums-3648dd99f7d5c640e9b6c92b182f8b88fd867842.tar.bz2 forums-3648dd99f7d5c640e9b6c92b182f8b88fd867842.tar.xz forums-3648dd99f7d5c640e9b6c92b182f8b88fd867842.zip | |
[ticket/10271] Added comments to the JavaScript ajax functions.
PHPBB3-10271
| -rw-r--r-- | phpBB/assets/javascript/core.js | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/phpBB/assets/javascript/core.js b/phpBB/assets/javascript/core.js index 22465a040d..a82760c159 100644 --- a/phpBB/assets/javascript/core.js +++ b/phpBB/assets/javascript/core.js @@ -194,10 +194,20 @@ phpbb.parse_querystring = function(string) { /** * Makes a link use AJAX instead of loading an entire page. * + * This function will work for links (both standard links and links which + * invoke confirm_box) and forms. It will be called automatically for links + * and forms with the data-ajax attribute set, and will call the necessary + * callback. + * + * For more info, view the following page on the phpBB wiki: + * http://wiki.phpbb.com/JavaScript_Function.phpbb.ajaxify + * * @param object options Options, if a string will be the selector. * @param bool/function refresh If we are sent back a refresh, should it be * acted upon? This can either be true / false / a function. - * @param function callback Callback. + * @param function callback Callback to call on completion of event. Has + * three parameters: the element that the event was evoked from, the JSON + * that was returned and (if it is a form) the form action. */ phpbb.ajaxify = function(options, refresh, callback) { var selector = $((typeof options === 'string') ? options : options.selector); @@ -215,6 +225,11 @@ phpbb.ajaxify = function(options, refresh, callback) { return true; } + /** + * This is a private function used to handle the callbacks, refreshes + * and alert. It cannot be called from outside this function, and is purely + * here to avoid repetition of code. + */ function return_handler(res) { if (typeof res.S_CONFIRM_ACTION === 'undefined') @@ -311,6 +326,15 @@ phpbb.ajaxify = function(options, refresh, callback) { } phpbb.ajax_callbacks = {}; + +/** + * Adds an AJAX callback to be used by phpbb.ajaxify. + * + * See the phpbb.ajaxify comments for information on stuff like parameters. + * + * @param string id The name of the callback. + * @param function callback The callback to be called. + */ phpbb.add_ajax_callback = function(id, callback) { if (typeof callback === 'function') |