enmi-conf.org: comparison wp/wp-admin/js/theme-plugin-editor.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-admin/js/theme-plugin-editor.js

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	window.wp = {};
 }
 wp.themePluginEditor = (function( $ ) {
 	'use strict';
-	var component, TreeLinks;
+	var component, TreeLinks,
+		__ = wp.i18n.__, _n = wp.i18n._n, sprintf = wp.i18n.sprintf;
 	component = {
-		l10n: {
-			lintError: {
-				singular: '',
-				plural: ''
-			},
-			saveAlert: '',
-			saveError: ''
-		},
 		codeEditor: {},
 		instance: null,
 		noticeElements: {},
 		dirty: false,
 		lintErrors: []
 	 * Initialize component.
 	 *
 	 * @since 4.9.0
 	 *
 	 * @param {jQuery}         form - Form element.
-	 * @param {object}         settings - Settings.
+	 * @param {Object}         settings - Settings.
-	 * @param {object|boolean} settings.codeEditor - Code editor settings (or `false` if syntax highlighting is disabled).
+	 * @param {Object|boolean} settings.codeEditor - Code editor settings (or `false` if syntax highlighting is disabled).
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.init = function init( form, settings ) {
 		component.form = form;
 		if ( settings ) {
 		$( component.initFileBrowser );
 		$( window ).on( 'beforeunload', function() {
 			if ( component.dirty ) {
-				return component.l10n.saveAlert;
+				return __( 'The changes you made will be lost if you navigate away from this page.' );
 			}
 			return undefined;
 		} );
 		component.docsLookUpList.on( 'change', function() {
 	/**
 	 * Set up and display the warning modal.
 	 *
 	 * @since 4.9.0
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.showWarning = function() {
 		// Get the text within the modal.
 		var rawMessage = component.warning.find( '.file-editor-warning-message' ).text();
 		// Hide all the #wpwrap content from assistive technologies.
 	/**
 	 * Constrain tabbing within the warning modal.
 	 *
 	 * @since 4.9.0
-	 * @param {object} event jQuery event object.
+	 * @param {Object} event jQuery event object.
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.constrainTabbing = function( event ) {
 		var firstTabbable, lastTabbable;
 		if ( 9 !== event.which ) {
 	/**
 	 * Dismiss the warning modal.
 	 *
 	 * @since 4.9.0
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.dismissWarning = function() {
 		wp.ajax.post( 'dismiss-wp-pointer', {
 			pointer: component.themeOrPlugin + '_editor_notice'
 	/**
 	 * Callback for when a change happens.
 	 *
 	 * @since 4.9.0
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.onChange = function() {
 		component.dirty = true;
 		component.removeNotice( 'file_saved' );
 	};
 	/**
 	 * Submit file via Ajax.
 	 *
 	 * @since 4.9.0
 	 * @param {jQuery.Event} event - Event.
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.submit = function( event ) {
 		var data = {}, request;
 		event.preventDefault(); // Prevent form submission in favor of Ajax below.
 		$.each( component.form.serializeArray(), function() {
 		request.fail( function( response ) {
 			var notice = $.extend(
 				{
 					code: 'save_error',
-					message: component.l10n.saveError
+					message: __( 'Something went wrong. Your change may not have been saved. Please try again. There is also a chance that you may need to manually fix and upload the file over FTP.' )
 				},
 				response,
 				{
 					type: 'error',
 					dismissible: true
 	/**
 	 * Add notice.
 	 *
 	 * @since 4.9.0
 	 *
-	 * @param {object}   notice - Notice.
+	 * @param {Object}   notice - Notice.
 	 * @param {string}   notice.code - Code.
 	 * @param {string}   notice.type - Type.
 	 * @param {string}   notice.message - Message.
 	 * @param {boolean}  [notice.dismissible=false] - Dismissible.
 	 * @param {Function} [notice.onDismiss] - Callback for when a user dismisses the notice.
-	 * @returns {jQuery} Notice element.
+	 * @return {jQuery} Notice element.
 	 */
 	component.addNotice = function( notice ) {
 		var noticeElement;
 		if ( ! notice.code ) {
 	 * Remove notice.
 	 *
 	 * @since 4.9.0
 	 *
 	 * @param {string} code - Notice code.
-	 * @returns {boolean} Whether a notice was removed.
+	 * @return {boolean} Whether a notice was removed.
 	 */
 	component.removeNotice = function( code ) {
 		if ( component.noticeElements[ code ] ) {
 			component.noticeElements[ code ].slideUp( 'fast', function() {
 				$( this ).remove();
 	/**
 	 * Initialize code editor.
 	 *
 	 * @since 4.9.0
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.initCodeEditor = function initCodeEditor() {
 		var codeEditorSettings, editor;
 		codeEditorSettings = $.extend( {}, component.codeEditor );
 		/**
 		 * Handle tabbing to the field before the editor.
 		 *
 		 * @since 4.9.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		codeEditorSettings.onTabPrevious = function() {
 			$( '#templateside' ).find( ':tabbable' ).last().focus();
 		};
 		/**
 		 * Handle tabbing to the field after the editor.
 		 *
 		 * @since 4.9.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		codeEditorSettings.onTabNext = function() {
 			$( '#template' ).find( ':tabbable:not(.CodeMirror-code)' ).first().focus();
 		};
 		 * Handle change to the linting errors.
 		 *
 		 * @since 4.9.0
 		 *
 		 * @param {Array} errors - List of linting errors.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		codeEditorSettings.onChangeLintingErrors = function( errors ) {
 			component.lintErrors = errors;
 			// Only disable the button in onUpdateErrorNotice when there are errors so users can still feel they can click the button.
 		 * Update error notice.
 		 *
 		 * @since 4.9.0
 		 *
 		 * @param {Array} errorAnnotations - Error annotations.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		codeEditorSettings.onUpdateErrorNotice = function onUpdateErrorNotice( errorAnnotations ) {
-			var message, noticeElement;
+			var noticeElement;
 			component.submitButton.toggleClass( 'disabled', errorAnnotations.length > 0 );
 			if ( 0 !== errorAnnotations.length ) {
-				if ( 1 === errorAnnotations.length ) {
-					message = component.l10n.lintError.singular.replace( '%d', '1' );
-				} else {
-					message = component.l10n.lintError.plural.replace( '%d', String( errorAnnotations.length ) );
-				}
 				noticeElement = component.addNotice({
 					code: 'lint_errors',
 					type: 'error',
-					message: message,
+					message: sprintf(
+						/* translators: %s: Error count. */
+						_n(
+							'There is %s error which must be fixed before you can update this file.',
+							'There are %s errors which must be fixed before you can update this file.',
+							errorAnnotations.length
+						),
+						String( errorAnnotations.length )
+					),
 					dismissible: false
 				});
 				noticeElement.find( 'input[type=checkbox]' ).on( 'click', function() {
 					codeEditorSettings.onChangeLintingErrors( [] );
 					component.removeNotice( 'lint_errors' );
 	/**
 	 * Initialization of the file browser's folder states.
 	 *
 	 * @since 4.9.0
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.initFileBrowser = function initFileBrowser() {
 		var $templateside = $( '#templateside' );
 		 *       An element with the role=tree attribute
 		 */
 		var TreeitemLink = function (node, treeObj, group) {
-			// Check whether node is a DOM element
+			// Check whether node is a DOM element.
 			if (typeof node !== 'object') {
 				return;
 			}
 			node.tabIndex = -1;
 			}
 		};
 		TreeitemLink.prototype.handleClick = function (event) {
-			// only process click events that directly happened on this treeitem
+			// Only process click events that directly happened on this treeitem.
 			if (event.target !== this.domNode && event.target !== this.domNode.firstElementChild) {
 				return;
 			}
 			if (this.isExpandable) {
 		 *   @param node
 		 *       An element with the role=tree attribute
 		 */
 		var TreeLinks = function (node) {
-			// Check whether node is a DOM element
+			// Check whether node is a DOM element.
 			if (typeof node !== 'object') {
 				return;
 			}
 			this.domNode = node;
 					elem = elem.nextElementSibling;
 				}
 			}
-			// initialize pop up menus
+			// Initialize pop up menus.
 			if (!this.domNode.getAttribute('role')) {
 				this.domNode.setAttribute('role', 'tree');
 			}
 			findTreeitems(this.domNode, this, false);
 		TreeLinks.prototype.setFocusByFirstCharacter = function (currentItem, _char) {
 			var start, index;
 			_char = _char.toLowerCase();
-			// Get start index for search based on position of currentItem
+			// Get start index for search based on position of currentItem.
 			start = this.treeitems.indexOf(currentItem) + 1;
 			if (start === this.treeitems.length) {
 				start = 0;
 			}
-			// Check remaining slots in the menu
+			// Check remaining slots in the menu.
 			index = this.getIndexFirstChars(start, _char);
-			// If not found in remaining slots, check from beginning
+			// If not found in remaining slots, check from beginning.
 			if (index === -1) {
 				index = this.getIndexFirstChars(0, _char);
 			}
 			// If match was found...
 	/* jscs:enable */
 	/* eslint-enable */
 	return component;
 })( jQuery );
+/**
+* Removed in 5.5.0, needed for back-compatibility.
+*
+* @since 4.9.0
+* @deprecated 5.5.0
+*
+* @type {object}
+*/
+wp.themePluginEditor.l10n = wp.themePluginEditor.l10n || {
+	saveAlert: '',
+	saveError: '',
+	lintError: {
+		alternative: 'wp.i18n',
+		func: function() {
+			return {
+				singular: '',
+				plural: ''
+			};
+		}
+	}
+};
+wp.themePluginEditor.l10n = window.wp.deprecateL10nObject( 'wp.themePluginEditor.l10n', wp.themePluginEditor.l10n );

enmi-conf.org