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

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	/**
 	 * Helper function to correctly set up the prototype chain, for subclasses.
 	 * Similar to `goog.inherits`, but uses a hash of prototype properties and
 	 * class properties to be extended.
 	 *
-	 * @param  object parent      Parent class constructor to inherit from.
+	 * @param object parent      Parent class constructor to inherit from.
-	 * @param  object protoProps  Properties to apply to the prototype for use as class instance properties.
+	 * @param object protoProps  Properties to apply to the prototype for use as class instance properties.
-	 * @param  object staticProps Properties to apply directly to the class constructor.
+	 * @param object staticProps Properties to apply directly to the class constructor.
-	 * @return child              The subclassed constructor.
+	 * @return child The subclassed constructor.
 	 */
 	inherits = function( parent, protoProps, staticProps ) {
 		var child;
-		// The constructor function for the new subclass is either defined by you
+		/*
-		// (the "constructor" property in your `extend` definition), or defaulted
+		 * The constructor function for the new subclass is either defined by you
-		// by us to simply call `super()`.
+		 * (the "constructor" property in your `extend` definition), or defaulted
+		 * by us to simply call `super()`.
+		 */
 		if ( protoProps && protoProps.hasOwnProperty( 'constructor' ) ) {
 			child = protoProps.constructor;
 		} else {
 			child = function() {
-				// Storing the result `super()` before returning the value
+				/*
-				// prevents a bug in Opera where, if the constructor returns
+				 * Storing the result `super()` before returning the value
-				// a function, Opera will reject the return value in favor of
+				 * prevents a bug in Opera where, if the constructor returns
-				// the original object. This causes all sorts of trouble.
+				 * a function, Opera will reject the return value in favor of
+				 * the original object. This causes all sorts of trouble.
+				 */
 				var result = parent.apply( this, arguments );
 				return result;
 			};
 		}
 		// Inherit class (static) properties from parent.
 		$.extend( child, parent );
-		// Set the prototype chain to inherit from `parent`, without calling
+		// Set the prototype chain to inherit from `parent`,
-		// `parent`'s constructor function.
+		// without calling `parent`'s constructor function.
 		ctor.prototype  = parent.prototype;
 		child.prototype = new ctor();
 		// Add prototype properties (instance properties) to the subclass,
 		// if supplied.
-		if ( protoProps )
+		if ( protoProps ) {
 			$.extend( child.prototype, protoProps );
+		}
 		// Add static properties to the constructor function, if supplied.
-		if ( staticProps )
+		if ( staticProps ) {
 			$.extend( child, staticProps );
+		}
 		// Correctly set child's `prototype.constructor`.
 		child.prototype.constructor = child;
 		// Set a convenience property in case the parent's prototype is needed later.
 	};
 	/**
 	 * Creates a subclass of the class.
 	 *
-	 * @param  object protoProps  Properties to apply to the prototype.
+	 * @param object protoProps  Properties to apply to the prototype.
-	 * @param  object staticProps Properties to apply directly to the class.
+	 * @param object staticProps Properties to apply directly to the class.
-	 * @return child              The subclass.
+	 * @return child The subclass.
 	 */
 	api.Class.extend = function( protoProps, classProps ) {
 		var child = inherits( this, protoProps, classProps );
 		child.extend = this.extend;
 		return child;
 	 */
 	api.Class.prototype.extended = function( constructor ) {
 		var proto = this;
 		while ( typeof proto.constructor !== 'undefined' ) {
-			if ( proto.constructor === constructor )
+			if ( proto.constructor === constructor ) {
 				return true;
-			if ( typeof proto.constructor.__super__ === 'undefined' )
+			}
+			if ( typeof proto.constructor.__super__ === 'undefined' ) {
 				return false;
+			}
 			proto = proto.constructor.__super__;
 		}
 		return false;
 	};
 	 *
 	 * Used as a mixin.
 	 */
 	api.Events = {
 		trigger: function( id ) {
-			if ( this.topics && this.topics[ id ] )
+			if ( this.topics && this.topics[ id ] ) {
 				this.topics[ id ].fireWith( this, slice.call( arguments, 1 ) );
+			}
 			return this;
 		},
 		bind: function( id ) {
 			this.topics = this.topics || {};
 			this.topics[ id ].add.apply( this.topics[ id ], slice.call( arguments, 1 ) );
 			return this;
 		},
 		unbind: function( id ) {
-			if ( this.topics && this.topics[ id ] )
+			if ( this.topics && this.topics[ id ] ) {
 				this.topics[ id ].remove.apply( this.topics[ id ], slice.call( arguments, 1 ) );
+			}
 			return this;
 		}
 	};
 	/**
 	 * @constructor
 	 */
 	api.Value = api.Class.extend(/** @lends wp.customize.Value.prototype */{
 		/**
 		 * @param {mixed}  initial The initial value.
-		 * @param {object} options
+		 * @param {Object} options
 		 */
 		initialize: function( initial, options ) {
-			this._value = initial; // @todo: potentially change this to a this.set() call.
+			this._value = initial; // @todo Potentially change this to a this.set() call.
 			this.callbacks = $.Callbacks();
 			this._dirty = false;
 			$.extend( this, options || {} );
 		},
 		/**
 		 * Set the value and trigger all bound callbacks.
 		 *
-		 * @param {object} to New value.
+		 * @param {Object} to New value.
 		 */
 		set: function( to ) {
 			var from = this._value;
 			to = this._setter.apply( this, arguments );
 		 * the last to be a function callback that will be invoked when the requested
 		 * items are available.
 		 *
 		 * @see {api.Values.when}
 		 *
-		 * @param  {string}   id ID of the item.
+		 * @param {string} id ID of the item.
-		 * @param  {...}         Zero or more IDs of items to wait for and a callback
+		 * @param {...}       Zero or more IDs of items to wait for and a callback
-		 *                       function to invoke when they're available. Optional.
+		 *                    function to invoke when they're available. Optional.
-		 * @return {mixed}    The item instance if only one ID was supplied.
+		 * @return {mixed} The item instance if only one ID was supplied.
-		 *                    A Deferred Promise object if a callback function is supplied.
+		 *                 A Deferred Promise object if a callback function is supplied.
 		 */
 		instance: function( id ) {
-			if ( arguments.length === 1 )
+			if ( arguments.length === 1 ) {
 				return this.value( id );
+			}
 			return this.when.apply( this, arguments );
 		},
 		/**
 		 * Get the instance of an item.
 		 *
-		 * @param  {string} id The ID of the item.
+		 * @param {string} id The ID of the item.
-		 * @return {[type]}    [description]
+		 * @return {[type]} [description]
 		 */
 		value: function( id ) {
 			return this._value[ id ];
 		},
 		/**
 		 * Whether the collection has an item with the given ID.
 		 *
-		 * @param  {string}  id The ID of the item to look for.
+		 * @param {string} id The ID of the item to look for.
-		 * @return {Boolean}
+		 * @return {boolean}
 		 */
 		has: function( id ) {
 			return typeof this._value[ id ] !== 'undefined';
 		},
 		/**
 		 * Create a new item of the collection using the collection's default constructor
 		 * and store it in the collection.
 		 *
-		 * @param  {string} id    The ID of the item.
+		 * @param {string} id    The ID of the item.
-		 * @param  {mixed}  value Any extra arguments are passed into the item's initialize method.
+		 * @param {mixed}  value Any extra arguments are passed into the item's initialize method.
-		 * @return {mixed}  The new item's instance.
+		 * @return {mixed} The new item's instance.
 		 */
 		create: function( id ) {
 			return this.add( id, new this.defaultConstructor( api.Class.applicator, slice.call( arguments, 1 ) ) );
 		},
 		/**
 		 * Iterate over all items in the collection invoking the provided callback.
 		 *
-		 * @param  {Function} callback Function to invoke.
+		 * @param {Function} callback Function to invoke.
-		 * @param  {object}   context  Object context to invoke the function with. Optional.
+		 * @param {Object}   context  Object context to invoke the function with. Optional.
 		 */
 		each: function( callback, context ) {
 			context = typeof context === 'undefined' ? this : context;
 			$.each( this._value, function( key, obj ) {
 		},
 		/**
 		 * Remove an item from the collection.
 		 *
-		 * @param  {string} id The ID of the item to remove.
+		 * @param {string} id The ID of the item to remove.
 		 */
 		remove: function( id ) {
 			var value = this.value( id );
 			if ( value ) {
 		 * when( ids*, [callback] );
 		 *
 		 * For example:
 		 *     when( id1, id2, id3, function( value1, value2, value3 ) {} );
 		 *
-		 * @returns $.Deferred.promise();
+		 * @return $.Deferred.promise();
 		 */
 		when: function() {
 			var self = this,
 				ids  = slice.call( arguments ),
 				dfd  = $.Deferred();
-			// If the last argument is a callback, bind it to .done()
+			// If the last argument is a callback, bind it to .done().
-			if ( $.isFunction( ids[ ids.length - 1 ] ) )
+			if ( $.isFunction( ids[ ids.length - 1 ] ) ) {
 				dfd.done( ids.pop() );
+			}
 			/*
 			 * Create a stack of deferred objects for each item that is not
 			 * yet available, and invoke the supplied callback when they are.
 			 */
 			$.when.apply( $, $.map( ids, function( id ) {
-				if ( self.has( id ) )
+				if ( self.has( id ) ) {
 					return;
+				}
 				/*
 				 * The requested item is not available yet, create a deferred
 				 * object to resolve when it becomes available.
 				 */
 	 * Cast a string to a jQuery collection if it isn't already.
 	 *
 	 * @param {string|jQuery collection} element
 	 */
 	api.ensure = function( element ) {
-		return typeof element == 'string' ? $( element ) : element;
+		return typeof element === 'string' ? $( element ) : element;
 	};
 	/**
 	 * An observable value that syncs with an element.
 	 *
 	 */
 	api.Messenger = api.Class.extend(/** @lends wp.customize.Messenger.prototype */{
 		/**
 		 * Create a new Value.
 		 *
-		 * @param  {string} key     Unique identifier.
+		 * @param {string} key     Unique identifier.
-		 * @param  {mixed}  initial Initial value.
+		 * @param {mixed}  initial Initial value.
-		 * @param  {mixed}  options Options hash. Optional.
+		 * @param {mixed}  options Options hash. Optional.
-		 * @return {Value}          Class instance of the Value.
+		 * @return {Value} Class instance of the Value.
 		 */
 		add: function( key, initial, options ) {
 			return this[ key ] = new api.Value( initial, options );
 		},
 		/**
 		 * Initialize Messenger.
 		 *
-		 * @param  {object} params - Parameters to configure the messenger.
+		 * @param {Object} params  - Parameters to configure the messenger.
-		 *         {string} params.url - The URL to communicate with.
+		 *        {string} params.url          - The URL to communicate with.
-		 *         {window} params.targetWindow - The window instance to communicate with. Default window.parent.
+		 *        {window} params.targetWindow - The window instance to communicate with. Default window.parent.
-		 *         {string} params.channel - If provided, will send the channel with each message and only accept messages a matching channel.
+		 *        {string} params.channel      - If provided, will send the channel with each message and only accept messages a matching channel.
-		 * @param  {object} options - Extend any instance parameter or method with this object.
+		 * @param {Object} options - Extend any instance parameter or method with this object.
 		 */
 		initialize: function( params, options ) {
 			// Target the parent frame by default, but only if a parent frame exists.
 			var defaultTarget = window.parent === window ? null : window.parent;
 				urlParser.href = to;
 				// Port stripping needed by IE since it adds to host but not to event.origin.
 				return urlParser.protocol + '//' + urlParser.host.replace( /:(80|443)$/, '' );
 			});
-			// first add with no value
+			// First add with no value.
 			this.add( 'targetWindow', null );
 			// This avoids SecurityErrors when setting a window object in x-origin iframe'd scenarios.
 			this.targetWindow.set = function( to ) {
 				var from = this._value;
 				this.callbacks.fireWith( this, [ to, from ] );
 				return this;
 			};
-			// now set it
+			// Now set it.
 			this.targetWindow( params.targetWindow || defaultTarget );
-			// Since we want jQuery to treat the receive function as unique
+			/*
-			// to this instance, we give the function a new guid.
+			 * Since we want jQuery to treat the receive function as unique
-			//
+			 * to this instance, we give the function a new guid.
-			// This will prevent every Messenger's receive function from being
+			 *
-			// unbound when calling $.off( 'message', this.receive );
+			 * This will prevent every Messenger's receive function from being
+			 * unbound when calling $.off( 'message', this.receive );
+			 */
 			this.receive = $.proxy( this.receive, this );
 			this.receive.guid = $.guid++;
 			$( window ).on( 'message', this.receive );
 		},
 		},
 		/**
 		 * Receive data from the other window.
 		 *
-		 * @param  {jQuery.Event} event Event with embedded data.
+		 * @param {jQuery.Event} event Event with embedded data.
 		 */
 		receive: function( event ) {
 			var message;
 			event = event.originalEvent;
 			if ( ! this.targetWindow || ! this.targetWindow() ) {
 				return;
 			}
 			// Check to make sure the origin is valid.
-			if ( this.origin() && event.origin !== this.origin() )
+			if ( this.origin() && event.origin !== this.origin() ) {
 				return;
+			}
-			// Ensure we have a string that's JSON.parse-able
+			// Ensure we have a string that's JSON.parse-able.
 			if ( typeof event.data !== 'string' || event.data[0] !== '{' ) {
 				return;
 			}
 			message = JSON.parse( event.data );
 			// Check required message properties.
-			if ( ! message || ! message.id || typeof message.data === 'undefined' )
+			if ( ! message || ! message.id || typeof message.data === 'undefined' ) {
 				return;
+			}
 			// Check if channel names match.
-			if ( ( message.channel || this.channel() ) && this.channel() !== message.channel )
+			if ( ( message.channel || this.channel() ) && this.channel() !== message.channel ) {
 				return;
+			}
 			this.trigger( message.id, message.data );
 		},
 		/**
 		 * Send data to the other window.
 		 *
-		 * @param  {string} id   The event name.
+		 * @param {string} id   The event name.
-		 * @param  {object} data Data.
+		 * @param {Object} data Data.
 		 */
 		send: function( id, data ) {
 			var message;
 			data = typeof data === 'undefined' ? null : data;
-			if ( ! this.url() || ! this.targetWindow() )
+			if ( ! this.url() || ! this.targetWindow() ) {
 				return;
+			}
 			message = { id: id, data: data };
-			if ( this.channel() )
+			if ( this.channel() ) {
 				message.channel = this.channel();
+			}
 			this.targetWindow().postMessage( JSON.stringify( message ), this.origin() );
 		}
 	});
 		 * Initialize notification.
 		 *
 		 * @since 4.9.0
 		 *
 		 * @param {string}   code - Notification code.
-		 * @param {object}   params - Notification parameters.
+		 * @param {Object}   params - Notification parameters.
 		 * @param {string}   params.message - Message.
 		 * @param {string}   [params.type=error] - Type.
 		 * @param {string}   [params.setting] - Related setting ID.
 		 * @param {Function} [params.template] - Function for rendering template. If not provided, this will come from templateId.
 		 * @param {string}   [params.templateId] - ID for template to render the notification.
 		/**
 		 * Render the notification.
 		 *
 		 * @since 4.9.0
 		 *
-		 * @returns {jQuery} Notification container element.
+		 * @return {jQuery} Notification container element.
 		 */
 		render: function() {
 			var notification = this, container, data;
 			if ( ! notification.template ) {
 				notification.template = wp.template( notification.templateId );
 	/**
 	 * Get all customize settings.
 	 *
 	 * @alias wp.customize.get
 	 *
-	 * @return {object}
+	 * @return {Object}
 	 */
 	api.get = function() {
 		var result = {};
 		this.each( function( obj, key ) {
 	 * @access public
 	 *
 	 * @alias wp.customize.utils.parseQueryString
 	 *
 	 * @param {string} queryString Query string.
-	 * @returns {object} Parsed query string.
+	 * @return {Object} Parsed query string.
 	 */
 	api.utils.parseQueryString = function parseQueryString( queryString ) {
 		var queryParams = {};
 		_.each( queryString.split( '&' ), function( pair ) {
 			var parts, key, value;

enmi-conf.org