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

changeset 16	a86126ab1dd4
parent 9	177826044cd9

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	/**
 	 * A helper mixin function to avoid truthy and falsey values being
 	 *   passed as an input that expects booleans. If key is undefined in the map,
 	 *   but has a default value, set it.
 	 *
-	 * @param {object} attrs Map of props from a shortcode or settings.
+	 * @param {Object} attrs Map of props from a shortcode or settings.
 	 * @param {string} key The key within the passed map to check for a value.
-	 * @returns {mixed|undefined} The original or coerced value of key within attrs
+	 * @return {mixed|undefined} The original or coerced value of key within attrs.
 	 */
 	wp.media.coerce = function ( attrs, key ) {
 		if ( _.isUndefined( attrs[ key ] ) && ! _.isUndefined( this.defaults[ key ] ) ) {
 			attrs[ key ] = this.defaults[ key ];
 		} else if ( 'true' === attrs[ key ] ) {
 		 * outputting the proper object format based on the
 		 * attachment's type.
 		 *
 		 * @param {Object} [props={}] Attachment details (align, link, size, etc).
 		 * @param {Object} attachment The attachment object, media version of Post.
-		 * @returns {Object} Joined props
+		 * @return {Object} Joined props
 		 */
 		props: function( props, attachment ) {
 			var link, linkUrl, size, sizes,
 				defaultProps = wp.media.view.settings.defaultProps;
 		/**
 		 * Create link markup that is suitable for passing to the editor
 		 *
 		 * @param {Object} props Attachment details (align, link, size, etc).
 		 * @param {Object} attachment The attachment object, media version of Post.
-		 * @returns {string} The link markup
+		 * @return {string} The link markup
 		 */
 		link: function( props, attachment ) {
 			var options;
 			props = wp.media.string.props( props, attachment );
 		/**
 		 * Create an Audio shortcode string that is suitable for passing to the editor
 		 *
 		 * @param {Object} props Attachment details (align, link, size, etc).
 		 * @param {Object} attachment The attachment object, media version of Post.
-		 * @returns {string} The audio shortcode
+		 * @return {string} The audio shortcode
 		 */
 		audio: function( props, attachment ) {
 			return wp.media.string._audioVideo( 'audio', props, attachment );
 		},
 		/**
 		 * Create a Video shortcode string that is suitable for passing to the editor
 		 *
 		 * @param {Object} props Attachment details (align, link, size, etc).
 		 * @param {Object} attachment The attachment object, media version of Post.
-		 * @returns {string} The video shortcode
+		 * @return {string} The video shortcode
 		 */
 		video: function( props, attachment ) {
 			return wp.media.string._audioVideo( 'video', props, attachment );
 		},
 		/**
 		 * @access private
 		 *
 		 * @param {string} type The shortcode tag name: 'audio' or 'video'.
 		 * @param {Object} props Attachment details (align, link, size, etc).
 		 * @param {Object} attachment The attachment object, media version of Post.
-		 * @returns {string} The media shortcode
+		 * @return {string} The media shortcode
 		 */
 		_audioVideo: function( type, props, attachment ) {
 			var shortcode, html, extension;
 			props = wp.media.string.props( props, attachment );
-			if ( props.link !== 'embed' )
+			if ( props.link !== 'embed' ) {
 				return wp.media.string.link( props );
+			}
 			shortcode = {};
 			if ( 'video' === type ) {
 				if ( attachment.image && -1 === attachment.image.src.indexOf( attachment.icon ) ) {
 		 * Create image markup, optionally with a link and/or wrapped in a caption shortcode,
 		 *  that is suitable for passing to the editor
 		 *
 		 * @param {Object} props Attachment details (align, link, size, etc).
 		 * @param {Object} attachment The attachment object, media version of Post.
-		 * @returns {string}
+		 * @return {string}
 		 */
 		image: function( props, attachment ) {
 			var img = {},
 				options, classes, shortcode, html;
 			coerce : wp.media.coerce,
 			/**
 			 * Retrieve attachments based on the properties of the passed shortcode
 			 *
 			 * @param {wp.shortcode} shortcode An instance of wp.shortcode().
-			 * @returns {wp.media.model.Attachments} A Backbone.Collection containing
+			 * @return {wp.media.model.Attachments} A Backbone.Collection containing
-			 *      the media items belonging to a collection.
+			 *                                      the media items belonging to a collection.
-			 *      The query[ this.tag ] property is a Backbone.Model
+			 *                                      The query[ this.tag ] property is a Backbone.Model
-			 *          containing the 'props' for the collection.
+			 *                                      containing the 'props' for the collection.
 			 */
 			attachments: function( shortcode ) {
 				var shortcodeString = shortcode.string(),
 					result = collections[ shortcodeString ],
 					attrs, args, query, others, self = this;
 			 *
 			 * @param {wp.media.model.Attachments} attachments A Backbone.Collection containing
 			 *      the media items belonging to a collection.
 			 *      The query[ this.tag ] property is a Backbone.Model
 			 *          containing the 'props' for the collection.
-			 * @returns {wp.shortcode}
+			 * @return {wp.shortcode}
 			 */
 			shortcode: function( attachments ) {
 				var props = attachments.props.toJSON(),
 					attrs = _.pick( props, 'orderby', 'order' ),
 					shortcode, clone;
 				if ( attachments[this.tag] ) {
 					_.extend( attrs, attachments[this.tag].toJSON() );
 				}
-				// Convert all gallery shortcodes to use the `ids` property.
+				/*
-				// Ignore `post__in` and `post__not_in`; the attachments in
+				 * Convert all gallery shortcodes to use the `ids` property.
-				// the collection will already reflect those properties.
+				 * Ignore `post__in` and `post__not_in`; the attachments in
+				 * the collection will already reflect those properties.
+				 */
 				attrs.ids = attachments.pluck('id');
 				// Copy the `uploadedTo` post ID.
 				if ( props.uploadedTo ) {
 					attrs.id = props.uploadedTo;
 				// Check if the gallery is randomly ordered.
 				delete attrs.orderby;
 				if ( attrs._orderbyRandom ) {
 					attrs.orderby = 'rand';
-				} else if ( attrs._orderByField && attrs._orderByField != 'rand' ) {
+				} else if ( attrs._orderByField && 'rand' !== attrs._orderByField ) {
 					attrs.orderby = attrs._orderByField;
 				}
 				delete attrs._orderbyRandom;
 				delete attrs._orderByField;
 			 * @param {string} content Content that is searched for possible
 			 *    shortcode markup matching the passed tag name,
 			 *
 			 * @this wp.media.{prop}
 			 *
-			 * @returns {wp.media.view.MediaFrame.Select} A media workflow.
+			 * @return {wp.media.view.MediaFrame.Select} A media workflow.
 			 */
 			edit: function( content ) {
 				var shortcode = wp.shortcode.next( this.tag, content ),
 					defaultPostId = this.defaults.id,
 					attachments, selection, state;
 	 */
 	wp.media.featuredImage = {
 		/**
 		 * Get the featured image post ID
 		 *
-		 * @returns {wp.media.view.settings.post.featuredImageId|number}
+		 * @return {wp.media.view.settings.post.featuredImageId|number}
 		 */
 		get: function() {
 			return wp.media.view.settings.post.featuredImageId;
 		},
 		/**
 			wp.media.post( 'get-post-thumbnail-html', {
 				post_id:      settings.post.id,
 				thumbnail_id: settings.post.featuredImageId,
 				_wpnonce:     settings.post.nonce
 			}).done( function( html ) {
-				if ( html == '0' ) {
+				if ( '0' === html ) {
-					window.alert( window.setPostThumbnailL10n.error );
+					window.alert( wp.i18n.__( 'Could not set that as the thumbnail image. Try a different attachment.' ) );
 					return;
 				}
 				$( '.inside', '#postimagediv' ).html( html );
 			});
 		},
 		/**
 		 * The Featured Image workflow
 		 *
 		 * @this wp.media.featuredImage
 		 *
-		 * @returns {wp.media.view.MediaFrame.Select} A media workflow.
+		 * @return {wp.media.view.MediaFrame.Select} A media workflow.
 		 */
 		frame: function() {
 			if ( this._frame ) {
 				wp.media.frame = this._frame;
 				return this._frame;
 				var selection = this.state('featured-image').get('selection'),
 					view = new wp.media.view.EditImage( { model: selection.single(), controller: this } ).render();
 				this.content.set( view );
-				// after bringing in the frame, load the actual editor via an ajax call
+				// After bringing in the frame, load the actual editor via an Ajax call.
 				view.loadEditor();
 			}, this._frame );
 			this._frame.state('featured-image').on( 'select', this.select );
 				wpActiveEditor = window.wpActiveEditor = this.activeEditor;
 			} else {
 				wpActiveEditor = window.wpActiveEditor;
 			}
-			// Delegate to the global `send_to_editor` if it exists.
+			/*
-			// This attempts to play nice with any themes/plugins that have
+			 * Delegate to the global `send_to_editor` if it exists.
-			// overridden the insert functionality.
+			 * This attempts to play nice with any themes/plugins
+			 * that have overridden the insert functionality.
+			 */
 			if ( window.send_to_editor ) {
 				return window.send_to_editor.apply( this, arguments );
 			}
 			if ( ! wpActiveEditor ) {
 		 * @param {string} id A slug used to identify the workflow.
 		 * @param {Object} [options={}]
 		 *
 		 * @this wp.media.editor
 		 *
-		 * @returns {wp.media.view.MediaFrame.Select} A media workflow.
+		 * @return {wp.media.view.MediaFrame.Select} A media workflow.
 		 */
 		add: function( id, options ) {
 			var workflow = this.get( id );
-			// only add once: if exists return existing
+			// Only add once: if exists return existing.
 			if ( workflow ) {
 				return workflow;
 			}
 			workflow = workflows[ id ] = wp.media( _.defaults( options || {}, {
 			workflow.on( 'insert', function( selection ) {
 				var state = workflow.state();
 				selection = selection || state.get('selection');
-				if ( ! selection )
+				if ( ! selection ) {
 					return;
+				}
 				$.when.apply( $, selection.map( function( attachment ) {
 					var display = state.display( attachment ).toJSON();
 					/**
 					 * @this wp.media.editor
 		/**
 		 * Determines the proper current workflow id
 		 *
 		 * @param {string} [id=''] A slug used to identify the workflow.
 		 *
-		 * @returns {wpActiveEditor|string|tinymce.activeEditor.id}
+		 * @return {wpActiveEditor|string|tinymce.activeEditor.id}
 		 */
 		id: function( id ) {
 			if ( id ) {
 				return id;
 			}
 		 *
 		 * @param {string} id A slug used to identify the workflow.
 		 *
 		 * @this wp.media.editor
 		 *
-		 * @returns {wp.media.view.MediaFrame} A media workflow.
+		 * @return {wp.media.view.MediaFrame} A media workflow.
 		 */
 		get: function( id ) {
 			id = this.id( id );
 			return workflows[ id ];
 		},
 			 * Called when sending an attachment to the editor
 			 *   from the medial modal.
 			 *
 			 * @param {Object} props Attachment details (align, link, size, etc).
 			 * @param {Object} attachment The attachment object, media version of Post.
-			 * @returns {Promise}
+			 * @return {Promise}
 			 */
 			attachment: function( props, attachment ) {
 				var caption = attachment.caption,
 					options, html;
 					_.each({
 						align: 'align',
 						size:  'image-size',
 						alt:   'image_alt'
 					}, function( option, prop ) {
-						if ( props[ prop ] )
+						if ( props[ prop ] ) {
 							options[ option ] = props[ prop ];
+						}
 					});
 				} else if ( 'video' === attachment.type ) {
 					html = wp.media.string.video( props, attachment );
 				} else if ( 'audio' === attachment.type ) {
 					html = wp.media.string.audio( props, attachment );
 			},
 			/**
 			 * Called when 'Insert From URL' source is not an image. Example: YouTube url.
 			 *
 			 * @param {Object} embed
-			 * @returns {Promise}
+			 * @return {Promise}
 			 */
 			link: function( embed ) {
 				return wp.media.post( 'send-link-to-editor', {
 					nonce:     wp.media.view.settings.nonce.sendToEditor,
 					src:       embed.linkUrl,
 		 * @param {string} [id=undefined] Optional. A slug used to identify the workflow.
 		 * @param {Object} [options={}]
 		 *
 		 * @this wp.media.editor
 		 *
-		 * @returns {wp.media.view.MediaFrame}
+		 * @return {wp.media.view.MediaFrame}
 		 */
 		open: function( id, options ) {
 			var workflow;
 			options = options || {};
 			id = this.id( id );
 			this.activeEditor = id;
 			workflow = this.get( id );
-			// Redo workflow if state has changed
+			// Redo workflow if state has changed.
 			if ( ! workflow || ( workflow.options && options.state !== workflow.options.state ) ) {
 				workflow = this.add( id, options );
 			}
 			wp.media.frame = workflow;

enmi-conf.org