Ticket #44364: 44364.diff

src/js/_enqueues/lib/auth-check.js

@@ -3 +3 @@
 (function($){
         var wrap, next;
 
+        /**
+         * Shows the authentification form popup.
+         *
+         * @since 3.6
+         */
         function show() {
                 var parent = $('#wp-auth-check'),
                         form = $('#wp-auth-check-form'),
@@ -10 +15 @@
                         frame, loaded = false;
 
                 if ( form.length ) {
-                        // Add unload confirmation to counter (frame-busting) JS redirects
+                        // Add unload confirmation to counter (frame-busting) JS redirects.
                         $(window).on( 'beforeunload.wp-auth-check', function(e) {
                                 e.originalEvent.returnValue = window.authcheckL10n.beforeunload;
                         });
@@ -40 +45 @@
                                         else
                                                 parent.css( 'max-height', height + 40 + 'px' );
                                 } else if ( ! body || ! body.length ) {
-                                        // Catch "silent" iframe origin exceptions in WebKit after another page is loaded in the iframe
+                                        // Catch "silent" iframe origin exceptions in WebKit after another page is 
+                                        // loaded in the iframe.
                                         wrap.addClass('fallback');
                                         parent.css( 'max-height', '' );
                                         form.remove();
@@ -56 +62 @@
 
                 if ( frame ) {
                         frame.focus();
-                        // WebKit doesn't throw an error if the iframe fails to load because of "X-Frame-Options: DENY" header.
+                        // WebKit doesn't throw an error if the iframe fails to load because of 
+                        // "X-Frame-Options: DENY" header.
                         // Wait for 10 sec. and switch to the fallback text.
                         setTimeout( function() {
                                 if ( ! loaded ) {
@@ -70 +77 @@
                 }
         }
 
+        /**
+         * Hides the authentification form popup.
+         *
+         * @since 3.6
+         */
         function hide() {
                 $(window).off( 'beforeunload.wp-auth-check' );
 
-                // When on the Edit Post screen, speed up heartbeat after the user logs in to quickly refresh nonces
+                // When on the Edit Post screen, speed up heartbeat after the user logs in to 
+                // quickly refresh nonces.
                 if ( typeof adminpage !== 'undefined' && ( adminpage === 'post-php' || adminpage === 'post-new-php' ) &&
                         typeof wp !== 'undefined' && wp.heartbeat ) {
 
@@ -88 +101 @@
                 });
         }
 
+        /**
+         * Schedules the next time authentification check will be done.
+         * 
+         * @since 3.6
+         */
         function schedule() {
-                var interval = parseInt( window.authcheckL10n.interval, 10 ) || 180; // in seconds, default 3 min.
+                // In seconds, default 3 min.
+                var interval = parseInt( window.authcheckL10n.interval, 10 ) || 180;
                 next = ( new Date() ).getTime() + ( interval * 1000 );
         }
 
+        /**
+         * Binds to the Heartbeat Tick event.
+         * Shows the authentification form popup if user is not logged in. 
+         * Hides the authentification form popup if it is already visible and user 
+         * is logged in.
+         *
+         * @since 3.6
+         * 
+         * @param {object} e The heartbeat-tick event that has been triggered.
+         * @param {object} data Response data.
+         */
         $( document ).on( 'heartbeat-tick.wp-auth-check', function( e, data ) {
                 if ( 'wp-auth-check' in data ) {
                         schedule();
@@ -102 +132 @@
                                 hide();
                         }
                 }
+
+        /**
+         * Binds to the Heartbeat Send event.
+         *
+         * @since 3.6
+         * 
+         * @param {object} e The heartbeat-send event that has been triggered.
+         * @param {object} data Response data.
+         */
         }).on( 'heartbeat-send.wp-auth-check', function( e, data ) {
                 if ( ( new Date() ).getTime() > next ) {
                         data['wp-auth-check'] = true;
                 }
+        
+        /**
+         * Binds to the document ready event.
+         *
+         * @since 3.6
+         */
         }).ready( function() {
                 schedule();
+
+                /**
+                 * Hides the authentification form popup when the close icon is clicked.
+                 *
+                 * @since 3.6
+                 * 
+                 * @listens .wp-auth-check-close:click
+                 */
                 wrap = $('#wp-auth-check-wrap');
                 wrap.find('.wp-auth-check-close').on( 'click', function() {
                         hide();