enmi-conf.org: comparison wp/wp-includes/js/autosave.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/autosave.js

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 /**
 * @output wp-includes/js/autosave.js
 */
 /* global tinymce, wpCookies, autosaveL10n, switchEditors */
-// Back-compat
+// Back-compat.
 window.autosave = function() {
 	return true;
 };
 /**
 	/**
 	 * Auto saves the post.
 	 *
 	 * @since 3.9.0
 	 *
-	 * @returns {Object}
+	 * @return {Object}
 	 * 	{{
 	 * 		getPostData: getPostData,
 	 * 		getCompareString: getCompareString,
 	 * 		disableButtons: disableButtons,
 	 * 		enableButtons: enableButtons,
 		 *
 		 * @since 3.9.0
 		 *
 		 * @param {string} type The type of autosave either local or remote.
 		 *
-		 * @returns {Object} Object containing the post data.
+		 * @return {Object} Object containing the post data.
 		 */
 		function getPostData( type ) {
 			var post_name, parent_id, data,
 				time = ( new Date() ).getTime(),
 				cats = [],
 		 *
 		 * @since 3.9.0
 		 *
 		 * @param {Object} postData The object containing the post data.
 		 *
-		 * @returns {string} A concatenated string with title, content and excerpt.
+		 * @return {string} A concatenated string with title, content and excerpt.
 		 */
 		function getCompareString( postData ) {
 			if ( typeof postData === 'object' ) {
 				return ( postData.post_title || '' ) + '::' + ( postData.content || '' ) + '::' + ( postData.excerpt || '' );
 			}
 		/**
 		 * Disables save buttons.
 		 *
 		 * @since 3.9.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function disableButtons() {
 			$document.trigger('autosave-disable-buttons');
 			// Re-enable 5 sec later. Just gives autosave a head start to avoid collisions.
 		/**
 		 * Enables save buttons.
 		 *
 		 * @since 3.9.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function enableButtons() {
 			$document.trigger( 'autosave-enable-buttons' );
 		}
 		/**
 		 * Gets the content editor.
 		 *
 		 * @since 4.6.0
 		 *
-		 * @returns {boolean|*} Returns either false if the editor is undefined,
+		 * @return {boolean|*} Returns either false if the editor is undefined,
-		 * 						or the instance of the content editor.
+		 *                     or the instance of the content editor.
 		 */
 		function getEditor() {
 			return typeof tinymce !== 'undefined' && tinymce.get('content');
 		}
 		/**
 		 * Autosave in localStorage.
 		 *
 		 * @since 3.9.0
 		 *
-		 * @returns {
+		 * @return {
 		 * {
 		 * 	hasStorage: *,
 		 * 	getSavedPostData: getSavedPostData,
 		 * 	save: save,
 		 * 	suspend: suspend,
 			/**
 			 * Checks if the browser supports sessionStorage and it's not disabled.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {boolean} True if the sessionStorage is supported and enabled.
+			 * @return {boolean} True if the sessionStorage is supported and enabled.
 			 */
 			function checkStorage() {
 				var test = Math.random().toString(),
 					result = false;
 			/**
 			 * Initializes the local storage.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {boolean|Object} False if no sessionStorage in the browser or an Object
+			 * @return {boolean|Object} False if no sessionStorage in the browser or an Object
-			 *                           containing all postData for this blog.
+			 *                          containing all postData for this blog.
 			 */
 			function getStorage() {
 				var stored_obj = false;
-				// Separate local storage containers for each blog_id
+				// Separate local storage containers for each blog_id.
 				if ( hasStorage && blog_id ) {
 					stored_obj = sessionStorage.getItem( 'wp-autosave-' + blog_id );
 					if ( stored_obj ) {
 						stored_obj = JSON.parse( stored_obj );
 			 * Sets the storage for this blog. Confirms that the data was saved
 			 * successfully.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {boolean} True if the data was saved successfully, false if it wasn't saved.
+			 * @return {boolean} True if the data was saved successfully, false if it wasn't saved.
 			 */
 			function setStorage( stored_obj ) {
 				var key;
 				if ( hasStorage && blog_id ) {
 			/**
 			 * Gets the saved post data for the current post.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {boolean|Object} False if no storage or no data or the postData as an Object.
+			 * @return {boolean|Object} False if no storage or no data or the postData as an Object.
 			 */
 			function getSavedPostData() {
 				var stored = getStorage();
 				if ( ! stored || ! post_id ) {
 			 *
 			 * @since 3.9.0
 			 *
 			 * @param {Object|boolean|null} stored_data The post data to store or null/false/empty to delete the key.
 			 *
-			 * @returns {boolean} True if data is stored, false if data was removed.
+			 * @return {boolean} True if data is stored, false if data was removed.
 			 */
 			function setData( stored_data ) {
 				var stored = getStorage();
 				if ( ! stored || ! post_id ) {
 			/**
 			 * Sets isSuspended to true.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function suspend() {
 				isSuspended = true;
 			}
 			/**
 			 * Sets isSuspended to false.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function resume() {
 				isSuspended = false;
 			}
 			/**
 			 * Saves post data for the current post.
 			 *
-			 * Runs on a 15 sec. interval, saves when there are differences in the post title or content.
+			 * Runs on a 15 seconds interval, saves when there are differences in the post title or content.
 			 * When the optional data is provided, updates the last saved post data.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @param {Object} data The post data for saving, minimum 'post_title' and 'content'.
 			 *
-			 * @returns {boolean} Returns true when data has been saved, otherwise it returns false.
+			 * @return {boolean} Returns true when data has been saved, otherwise it returns false.
 			 */
 			function save( data ) {
 				var postData, compareString,
 					result = false;
 			 *
 			 * Runs on DOM ready.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function run() {
 				post_id = $('#post_ID').val() || 0;
 				// Check if the local post data is different than the loaded post data.
 				if ( $( '#wp-content-wrap' ).hasClass( 'tmce-active' ) ) {
-					// If TinyMCE loads first, check the post 1.5 sec. after it is ready.
+					/*
-					// By this time the content has been loaded in the editor and 'saved' to the textarea.
+					 * If TinyMCE loads first, check the post 1.5 seconds after it is ready.
-					// This prevents false positives.
+					 * By this time the content has been loaded in the editor and 'saved' to the textarea.
+					 * This prevents false positives.
+					 */
 					$document.on( 'tinymce-editor-init.autosave', function() {
 						window.setTimeout( function() {
 							checkPost();
 						}, 1500 );
 					});
 				} else {
 					checkPost();
 				}
-				// Save every 15 sec.
+				// Save every 15 seconds.
 				intervalTimer = window.setInterval( save, 15000 );
 				$( 'form#post' ).on( 'submit.autosave-local', function() {
 					var editor = getEditor(),
 						post_id = $('#post_ID').val() || 0;
 			 *
 			 * @since 3.9.0
 			 *
 			 * @param {string} str1 The first string.
 			 * @param {string} str2 The second string.
-			 * @returns {boolean} True if the strings are the same.
+			 * @return {boolean} True if the strings are the same.
 			 */
 			function compare( str1, str2 ) {
 				function removeSpaces( string ) {
 					return string.toString().replace(/[\x20\t\r\n\f]+/g, '');
 				}
 			 *
 			 * Shows a standard message letting the user restore the post data if different.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function checkPost() {
 				var content, post_title, excerpt, $notice,
 					postData = getSavedPostData(),
 					cookie = wpCookies.get( 'wp-saving-post' ),
 					$newerAutosaveNotice = $( '#has-newer-autosave' ).parent( '.notice' ),
 					$headerEnd = $( '.wp-header-end' );
 				if ( cookie === post_id + '-saved' ) {
 					wpCookies.remove( 'wp-saving-post' );
-					// The post was saved properly, remove old data and bail
+					// The post was saved properly, remove old data and bail.
 					setData( false );
 					return;
 				}
 				if ( ! postData ) {
 			 *
 			 * @since 3.9.0
 			 *
 			 * @param {Object} postData The object containing all post data.
 			 *
-			 * @returns {boolean} True if the post is restored.
+			 * @return {boolean} True if the post is restored.
 			 */
 			function restorePost( postData ) {
 				var editor;
 				if ( postData ) {
-					// Set the last saved data
+					// Set the last saved data.
 					lastCompareString = getCompareString( postData );
 					if ( $( '#title' ).val() !== postData.post_title ) {
 						$( '#title' ).focus().val( postData.post_title || '' );
 					}
 					if ( editor && ! editor.isHidden() && typeof switchEditors !== 'undefined' ) {
 						if ( editor.settings.wpautop && postData.content ) {
 							postData.content = switchEditors.wpautop( postData.content );
 						}
-						// Make sure there's an undo level in the editor
+						// Make sure there's an undo level in the editor.
 						editor.undoManager.transact( function() {
 							editor.setContent( postData.content || '' );
 							editor.nodeChanged();
 						});
 					} else {
-						// Make sure the Text editor is selected
+						// Make sure the Text editor is selected.
 						$( '#content-html' ).click();
 						$( '#content' ).focus();
 						// Using document.execCommand() will let the user undo.
 						document.execCommand( 'selectAll' );
 				return false;
 			}
 			blog_id = typeof window.autosaveL10n !== 'undefined' && window.autosaveL10n.blog_id;
-			// Check if the browser supports sessionStorage and it's not disabled,
+			/*
-			// then initialize and run checkPost().
+			 * Check if the browser supports sessionStorage and it's not disabled,
-			// Don't run if the post type supports neither 'editor' (textarea#content) nor 'excerpt'.
+			 * then initialize and run checkPost().
+			 * Don't run if the post type supports neither 'editor' (textarea#content) nor 'excerpt'.
+			 */
 			if ( checkStorage() && blog_id && ( $('#content').length || $('#excerpt').length ) ) {
 				$document.ready( run );
 			}
 			return {
 		/**
 		 * Auto saves the post on the server.
 		 *
 		 * @since 3.9.0
 		 *
-		 * @returns {Object} {
+		 * @return {Object} {
 		 * 	{
 		 * 		tempBlockSave: tempBlockSave,
 		 * 		triggerSave: triggerSave,
 		 * 		postChanged: postChanged,
 		 * 		suspend: suspend,
 			/**
 			 * Blocks saving for the next 10 seconds.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function tempBlockSave() {
 				_blockSave = true;
 				window.clearTimeout( _blockSaveTimer );
 			/**
 			 * Sets isSuspended to true.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function suspend() {
 				isSuspended = true;
 			}
 			/**
 			 * Sets isSuspended to false.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function resume() {
 				isSuspended = false;
 			}
 			 *
 			 * @since 3.9.0
 			 *
 			 * @param {Object} data The post data.
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function response( data ) {
 				_schedule();
 				_blockSave = false;
 				lastCompareString = previousCompareString;
 				$document.trigger( 'after-autosave', [data] );
 				enableButtons();
 				if ( data.success ) {
-					// No longer an auto-draft
+					// No longer an auto-draft.
 					$( '#auto_draft' ).val('');
 				}
 			}
 			/**
 			 *
 			 * Resets the timing and tells heartbeat to connect now.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function triggerSave() {
 				nextRun = 0;
 				wp.heartbeat.connectNow();
 			}
 			 * If the post hasn't changed or it cannot be updated,
 			 * because the autosave is blocked or suspended, the function returns false.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {Object} Returns the post data.
+			 * @return {Object} Returns the post data.
 			 */
 			function save() {
 				var postData, compareString;
-				// window.autosave() used for back-compat
+				// window.autosave() used for back-compat.
 				if ( isSuspended || _blockSave || ! window.autosave() ) {
 					return false;
 				}
 				if ( ( new Date() ).getTime() < nextRun ) {
 				}
 				postData = getPostData();
 				compareString = getCompareString( postData );
-				// First check
+				// First check.
 				if ( typeof lastCompareString === 'undefined' ) {
 					lastCompareString = initialCompareString;
 				}
-				// No change
+				// No change.
 				if ( compareString === lastCompareString ) {
 					return false;
 				}
 				previousCompareString = compareString;
 			 *
 			 * @private
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function _schedule() {
 				nextRun = ( new Date() ).getTime() + ( autosaveL10n.autosaveInterval * 1000 ) || 60000;
 			}
 			/**
 			 * Sets the autosaveData on the autosave heartbeat.
 			 *
 			 * @since 3.9.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			$document.on( 'heartbeat-send.autosave', function( event, data ) {
 				var autosaveData = save();
 				if ( autosaveData ) {
 				 * Triggers the autosave of the post with the autosave data on the autosave
 				 * heartbeat.
 				 *
 				 * @since 3.9.0
 				 *
-				 * @returns {void}
+				 * @return {void}
 				 */
 			}).on( 'heartbeat-tick.autosave', function( event, data ) {
 				if ( data.wp_autosave ) {
 					response( data.wp_autosave );
 				}
 				/**
 				 * Disables buttons and throws a notice when the connection is lost.
 				 *
 				 * @since 3.9.0
 				 *
-				 * @returns {void}
+				 * @return {void}
 				 */
 			}).on( 'heartbeat-connection-lost.autosave', function( event, error, status ) {
 				// When connection is lost, keep user from submitting changes.
 				if ( 'timeout' === error || 603 === status ) {
 				/**
 				 * Enables buttons when the connection is restored.
 				 *
 				 * @since 3.9.0
 				 *
-				 * @returns {void}
+				 * @return {void}
 				 */
 			}).on( 'heartbeat-connection-restored.autosave', function() {
 				$('#lost-connection-notice').hide();
 				enableButtons();
 			}).ready( function() {
 		 * This avoids any insignificant differences between the initial textarea content and the content
 		 * extracted from the editor.
 		 *
 		 * @since 3.9.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		$document.on( 'tinymce-editor-init.autosave', function( event, editor ) {
 			if ( editor.id === 'content' ) {
 				window.setTimeout( function() {
 					editor.save();
 					initialCompareString = getCompareString();
 				}, 1000 );
 			}
 		}).ready( function() {
-			// Set the initial compare string in case TinyMCE is not used or not loaded first
+			// Set the initial compare string in case TinyMCE is not used or not loaded first.
 			initialCompareString = getCompareString();
 		});
 		return {
 			getPostData: getPostData,

enmi-conf.org