enmi-conf.org: comparison wp/wp-includes/js/heartbeat.js

Mercurial Mercurial > enmi-conf.org / comparison

summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help

wp/wp-includes/js/heartbeat.js

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	/**
 	 * Constructs the Heartbeat API.
 	 *
 	 * @since 3.6.0
 	 *
-	 * @returns {Object} An instance of the Heartbeat class.
+	 * @return {Object} An instance of the Heartbeat class.
 	 * @constructor
 	 */
 	var Heartbeat = function() {
 		var $document = $(document),
 			settings = {
 				queue: {},
 				// Connect interval (in seconds).
 				mainInterval: 60,
-				// Used when the interval is set to 5 sec. temporarily.
+				// Used when the interval is set to 5 seconds temporarily.
 				tempInterval: 0,
 				// Used when the interval is reset.
 				originalInterval: 0,
-				// Used to limit the number of AJAX requests.
+				// Used to limit the number of Ajax requests.
 				minimalInterval: 0,
 				// Used together with tempInterval.
 				countdown: 0,
 				hasConnected: false,
 				// Whether the current browser window is in focus and the user is active.
 				hasFocus: true,
-				// Timestamp, last time the user was active. Checked every 30 sec.
+				// Timestamp, last time the user was active. Checked every 30 seconds.
 				userActivity: 0,
 				// Flag whether events tracking user activity were set.
 				userActivityEvents: false,
 			};
 		/**
 		 * Sets local variables and events, then starts the heartbeat.
 		 *
-		 * @access private
-		 *
 		 * @since 3.8.0
-		 *
+		 * @access private
-		 * @returns {void}
+		 *
+		 * @return {void}
 		 */
 		function initialize() {
 			var options, hidden, visibilityState, visibilitychange;
 			if ( typeof window.pagenow === 'string' ) {
 				if ( ! settings.url && options.ajaxurl ) {
 					settings.url = options.ajaxurl;
 				}
 				/*
-				 * The interval can be from 15 to 120 sec. and can be set temporarily to 5 sec.
+				 * The interval can be from 15 to 120 seconds and can be set temporarily to 5 seconds.
-				 * It can be set in the initial options or changed later through JS and/or
+				 * It can be set in the initial options or changed later through JS and/or through PHP.
-				 * through PHP.
 				 */
 				if ( options.interval ) {
 					settings.mainInterval = options.interval;
 					if ( settings.mainInterval < 15 ) {
 						settings.mainInterval = 120;
 					}
 				}
 				/*
-				 * Used to limit the number of AJAX requests. Overrides all other intervals if
+				 * Used to limit the number of Ajax requests. Overrides all other intervals
-				 * they are shorter. Needed for some hosts that cannot handle frequent requests
+				 * if they are shorter. Needed for some hosts that cannot handle frequent requests
-				 * and the user may exceed the allocated server CPU time, etc. The minimal
+				 * and the user may exceed the allocated server CPU time, etc. The minimal interval
-				 * interval can be up to 600 sec. however setting it to longer than 120 sec.
+				 * can be up to 600 seconds, however setting it to longer than 120 seconds
-				 * will limit or disable some of the functionality (like post locks). Once set
+				 * will limit or disable some of the functionality (like post locks).
-				 * at initialization, minimalInterval cannot be changed/overridden.
+				 * Once set at initialization, minimalInterval cannot be changed/overridden.
 				 */
 				if ( options.minimalInterval ) {
 					options.minimalInterval = parseInt( options.minimalInterval, 10 );
 					settings.minimalInterval = options.minimalInterval > 0 && options.minimalInterval <= 600 ? options.minimalInterval * 1000 : 0;
 				}
 			 */
 			if ( typeof document.hidden !== 'undefined' ) {
 				hidden = 'hidden';
 				visibilitychange = 'visibilitychange';
 				visibilityState = 'visibilityState';
-			} else if ( typeof document.msHidden !== 'undefined' ) { // IE10
+			} else if ( typeof document.msHidden !== 'undefined' ) { // IE10.
 				hidden = 'msHidden';
 				visibilitychange = 'msvisibilitychange';
 				visibilityState = 'msVisibilityState';
-			} else if ( typeof document.webkitHidden !== 'undefined' ) { // Android
+			} else if ( typeof document.webkitHidden !== 'undefined' ) { // Android.
 				hidden = 'webkitHidden';
 				visibilitychange = 'webkitvisibilitychange';
 				visibilityState = 'webkitVisibilityState';
 			}
 		}
 		/**
 		 * Returns the current time according to the browser.
 		 *
-		 * @access private
+		 * @since 3.6.0
-		 *
+		 * @access private
-		 * @since 3.6.0
+		 *
-		 *
+		 * @return {number} Returns the current time.
-		 * @returns {number} Returns the current time.
 		 */
 		function time() {
 			return (new Date()).getTime();
 		}
 		/**
 		 * Checks if the iframe is from the same origin.
 		 *
-		 * @access private
+		 * @since 3.6.0
-		 *
+		 * @access private
-		 * @since 3.6.0
+		 *
-		 *
+		 * @return {boolean} Returns whether or not the iframe is from the same origin.
-		 * @returns {boolean} Returns whether or not the iframe is from the same origin.
 		 */
 		function isLocalFrame( frame ) {
 			var origin, src = frame.src;
 			/*
 		}
 		/**
 		 * Checks if the document's focus has changed.
 		 *
-		 * @access private
-		 *
 		 * @since 4.1.0
-		 *
+		 * @access private
-		 * @returns {void}
+		 *
+		 * @return {void}
 		 */
 		function checkFocus() {
 			if ( settings.hasFocus && ! document.hasFocus() ) {
 				blurred();
 			} else if ( ! settings.hasFocus && document.hasFocus() ) {
 		}
 		/**
 		 * Sets error state and fires an event on XHR errors or timeout.
 		 *
-		 * @access private
-		 *
 		 * @since 3.8.0
+		 * @access private
 		 *
 		 * @param {string} error  The error type passed from the XHR.
 		 * @param {number} status The HTTP status code passed from jqXHR
 		 *                        (200, 404, 500, etc.).
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function setErrorState( error, status ) {
 			var trigger;
 			if ( error ) {
 				switch ( error ) {
 					case 'abort':
 						// Do nothing.
 						break;
 					case 'timeout':
-						// No response for 30 sec.
+						// No response for 30 seconds.
 						trigger = true;
 						break;
 					case 'error':
 						if ( 503 === status && settings.hasConnected ) {
 							trigger = true;
 		}
 		/**
 		 * Clears the error state and fires an event if there is a connection error.
 		 *
-		 * @access private
-		 *
 		 * @since 3.8.0
-		 *
+		 * @access private
-		 * @returns {void}
+		 *
+		 * @return {void}
 		 */
 		function clearErrorState() {
 			// Has connected successfully.
 			settings.hasConnected = true;
 		}
 		/**
 		 * Gathers the data and connects to the server.
 		 *
-		 * @access private
+		 * @since 3.6.0
-		 *
+		 * @access private
-		 * @since 3.6.0
+		 *
-		 *
+		 * @return {void}
-		 * @returns {void}
 		 */
 		function connect() {
 			var ajaxData, heartbeatData;
 			// If the connection to the server is slower than the interval,
 			settings.connecting = true;
 			settings.xhr = $.ajax({
 				url: settings.url,
 				type: 'post',
-				timeout: 30000, // throw an error if not completed after 30 sec.
+				timeout: 30000, // Throw an error if not completed after 30 seconds.
 				data: ajaxData,
 				dataType: 'json'
 			}).always( function() {
 				settings.connecting = false;
 				scheduleNextTick();
 				if ( response.nonces_expired ) {
 					$document.trigger( 'heartbeat-nonces-expired' );
 					wp.hooks.doAction( 'heartbeat.nonces-expired' );
 				}
-				// Change the interval from PHP
+				// Change the interval from PHP.
 				if ( response.heartbeat_interval ) {
 					newInterval = response.heartbeat_interval;
 					delete response.heartbeat_interval;
 				}
 				}
 				$document.trigger( 'heartbeat-tick', [response, textStatus, jqXHR] );
 				wp.hooks.doAction( 'heartbeat.tick', response, textStatus, jqXHR );
-				// Do this last. Can trigger the next XHR if connection time > 5 sec. and newInterval == 'fast'.
+				// Do this last. Can trigger the next XHR if connection time > 5 seconds and newInterval == 'fast'.
 				if ( newInterval ) {
 					interval( newInterval );
 				}
 			}).fail( function( jqXHR, textStatus, error ) {
 				setErrorState( textStatus || 'unknown', jqXHR.status );
 		/**
 		 * Schedules the next connection.
 		 *
 		 * Fires immediately if the connection time is longer than the interval.
 		 *
-		 * @access private
-		 *
 		 * @since 3.8.0
-		 *
+		 * @access private
-		 * @returns {void}
+		 *
+		 * @return {void}
 		 */
 		function scheduleNextTick() {
 			var delta = time() - settings.lastTick,
 				interval = settings.mainInterval;
 			if ( settings.suspend ) {
 				return;
 			}
 			if ( ! settings.hasFocus ) {
-				interval = 120000; // 120 sec. Post locks expire after 150 sec.
+				interval = 120000; // 120 seconds. Post locks expire after 150 seconds.
 			} else if ( settings.countdown > 0 && settings.tempInterval ) {
 				interval = settings.tempInterval;
 				settings.countdown--;
 				if ( settings.countdown < 1 ) {
 		}
 		/**
 		 * Sets the internal state when the browser window becomes hidden or loses focus.
 		 *
-		 * @access private
+		 * @since 3.6.0
-		 *
+		 * @access private
-		 * @since 3.6.0
+		 *
-		 *
+		 * @return {void}
-		 * @returns {void}
 		 */
 		function blurred() {
 			settings.hasFocus = false;
 		}
 		/**
 		 * Sets the internal state when the browser window becomes visible or is in focus.
 		 *
-		 * @access private
+		 * @since 3.6.0
-		 *
+		 * @access private
-		 * @since 3.6.0
+		 *
-		 *
+		 * @return {void}
-		 * @returns {void}
 		 */
 		function focused() {
 			settings.userActivity = time();
-			// Resume if suspended
+			// Resume if suspended.
 			settings.suspend = false;
 			if ( ! settings.hasFocus ) {
 				settings.hasFocus = true;
 				scheduleNextTick();
 		}
 		/**
 		 * Runs when the user becomes active after a period of inactivity.
 		 *
-		 * @access private
+		 * @since 3.6.0
-		 *
+		 * @access private
-		 * @since 3.6.0
+		 *
-		 *
+		 * @return {void}
-		 * @returns {void}
 		 */
 		function userIsActive() {
 			settings.userActivityEvents = false;
 			$document.off( '.wp-heartbeat-active' );
 		}
 		/**
 		 * Checks for user activity.
 		 *
-		 * Runs every 30 sec. Sets 'hasFocus = true' if user is active and the window is
+		 * Runs every 30 seconds. Sets 'hasFocus = true' if user is active and the window
-		 * in the background. Sets 'hasFocus = false' if the user has been inactive
+		 * is in the background. Sets 'hasFocus = false' if the user has been inactive
-		 * (no mouse or keyboard activity) for 5 min. even when the window has focus.
+		 * (no mouse or keyboard activity) for 5 minutes even when the window has focus.
-		 *
-		 * @access private
 		 *
 		 * @since 3.8.0
-		 *
+		 * @access private
-		 * @returns {void}
+		 *
+		 * @return {void}
 		 */
 		function checkUserActivity() {
 			var lastActive = settings.userActivity ? time() - settings.userActivity : 0;
-			// Throttle down when no mouse or keyboard activity for 5 min.
+			// Throttle down when no mouse or keyboard activity for 5 minutes.
 			if ( lastActive > 300000 && settings.hasFocus ) {
 				blurred();
 			}
-			// Suspend after 10 min. of inactivity when suspending is enabled.
+			// Suspend after 10 minutes of inactivity when suspending is enabled.
-			// Always suspend after 60 min. of inactivity. This will release the post lock, etc.
+			// Always suspend after 60 minutes of inactivity. This will release the post lock, etc.
 			if ( ( settings.suspendEnabled && lastActive > 600000 ) || lastActive > 3600000 ) {
 				settings.suspend = true;
 			}
 			if ( ! settings.userActivityEvents ) {
 		 * is active.
 		 *
 		 * @since 3.6.0
 		 * @memberOf wp.heartbeat.prototype
 		 *
-		 * @returns {boolean} True if the window or the user is active.
+		 * @return {boolean} True if the window or the user is active.
 		 */
 		function hasFocus() {
 			return settings.hasFocus;
 		}
 		 *
 		 * @since 3.6.0
 		 *
 		 * @memberOf wp.heartbeat.prototype
 		 *
-		 * @returns {boolean} True if a connection error was found.
+		 * @return {boolean} True if a connection error was found.
 		 */
 		function hasConnectionError() {
 			return settings.connectionError;
 		}
 		 *
 		 * @since 3.8.0
 		 *
 		 * @memberOf wp.heartbeat.prototype
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function connectNow() {
 			settings.lastTick = 0;
 			scheduleNextTick();
 		}
 		/**
 		 * Disables suspending.
 		 *
 		 * Should be used only when Heartbeat is performing critical tasks like
-		 * autosave, post-locking, etc. Using this on many screens may overload the
+		 * autosave, post-locking, etc. Using this on many screens may overload
-		 * user's hosting account if several browser windows/tabs are left open for a
+		 * the user's hosting account if several browser windows/tabs are left open
-		 * long time.
+		 * for a long time.
 		 *
 		 * @since 3.8.0
 		 *
 		 * @memberOf wp.heartbeat.prototype
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function disableSuspend() {
 			settings.suspendEnabled = false;
 		}
 		/**
 		 * Gets/Sets the interval.
 		 *
 		 * When setting to 'fast' or 5, the interval is 5 seconds for the next 30 ticks
 		 * (for 2 minutes and 30 seconds) by default. In this case the number of 'ticks'
-		 * can be passed as second argument. If the window doesn't have focus, the
+		 * can be passed as second argument. If the window doesn't have focus,
-		 * interval slows down to 2 min.
+		 * the interval slows down to 2 minutes.
 		 *
 		 * @since 3.6.0
 		 *
 		 * @memberOf wp.heartbeat.prototype
 		 *
-		 * @param {string|number} speed Interval: 'fast' or 5, 15, 30, 60, 120. Fast
+		 * @param {string|number} speed Interval: 'fast' or 5, 15, 30, 60, 120.
-		 *                              equals 5.
+		 *                              Fast equals 5.
 		 * @param {string}        ticks Tells how many ticks before the interval reverts
 		 *                              back. Used with speed = 'fast' or 5.
 		 *
-		 * @returns {number} Current interval in seconds.
+		 * @return {number} Current interval in seconds.
 		 */
 		function interval( speed, ticks ) {
 			var newInterval,
 				oldInterval = settings.tempInterval ? settings.tempInterval : settings.mainInterval;
 						break;
 					case 120:
 						newInterval = 120000;
 						break;
 					case 'long-polling':
-						// Allow long polling, (experimental)
+						// Allow long polling (experimental).
 						settings.mainInterval = 0;
 						return 0;
 					default:
 						newInterval = settings.originalInterval;
 				}
 					settings.countdown = 0;
 					settings.tempInterval = 0;
 					settings.mainInterval = newInterval;
 				}
-				// Change the next connection time if new interval has been set.
+				/*
-				// Will connect immediately if the time since the last connection
+				 * Change the next connection time if new interval has been set.
-				// is greater than the new interval.
+				 * Will connect immediately if the time since the last connection
+				 * is greater than the new interval.
+				 */
 				if ( newInterval !== oldInterval ) {
 					scheduleNextTick();
 				}
 			}
 		 * @param {string}  handle      Unique handle for the data, used in PHP to
 		 *                              receive the data.
 		 * @param {*}       data        The data to send.
 		 * @param {boolean} noOverwrite Whether to overwrite existing data in the queue.
 		 *
-		 * @returns {boolean} True if the data was queued.
+		 * @return {boolean} True if the data was queued.
 		 */
 		function enqueue( handle, data, noOverwrite ) {
 			if ( handle ) {
 				if ( noOverwrite && this.isQueued( handle ) ) {
 					return false;
 		 *
 		 * @since 3.6.0
 		 *
 		 * @param {string} handle The handle for the data.
 		 *
-		 * @returns {boolean} True if the data is queued with this handle.
+		 * @return {boolean} True if the data is queued with this handle.
 		 */
 		function isQueued( handle ) {
 			if ( handle ) {
 				return settings.queue.hasOwnProperty( handle );
 			}
 		 *
 		 * @memberOf wp.heartbeat.prototype
 		 *
 		 * @param {string} handle The handle for the data.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function dequeue( handle ) {
 			if ( handle ) {
 				delete settings.queue[handle];
 			}
 		 *
 		 * @memberOf wp.heartbeat.prototype
 		 *
 		 * @param {string} handle The handle for the data.
 		 *
-		 * @returns {*} The data or undefined.
+		 * @return {*} The data or undefined.
 		 */
 		function getQueuedItem( handle ) {
 			if ( handle ) {
 				return this.isQueued( handle ) ? settings.queue[handle] : undefined;
 			}

enmi-conf.org