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 5	5e2f62d02dcd
parent 0	d970ebf37754
child 7	cf61fcea0001

equal deleted inserted replaced

-:346c88efed21
+:5e2f62d02dcd
 window.wp = window.wp || {};
 (function( exports, $ ){
-	var api, extend, ctor, inherits,
+	var api = {}, ctor, inherits,
 		slice = Array.prototype.slice;
-	/* =====================================================================
-	 * Micro-inheritance - thank you, backbone.js.
-	 * ===================================================================== */
-	extend = function( protoProps, classProps ) {
-		var child = inherits( this, protoProps, classProps );
-		child.extend = this.extend;
-		return child;
-	};
 	// Shared empty constructor function to aid in prototype-chain creation.
 	ctor = function() {};
-	// Helper function to correctly set up the prototype chain, for subclasses.
+	/**
-	// Similar to `goog.inherits`, but uses a hash of prototype properties and
+	 * Helper function to correctly set up the prototype chain, for subclasses.
-	// class properties to be extended.
+	 * 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 protoProps  Properties to apply to the prototype for use as class instance properties.
+	 * @param  object staticProps Properties to apply directly to the class 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
 		child.__super__ = parent.prototype;
 		return child;
 	};
-	api = {};
+	/**
+	 * Base class for object inheritance.
-	/* =====================================================================
+	 */
-	 * Base class.
-	 * ===================================================================== */
 	api.Class = function( applicator, argsArray, options ) {
 		var magic, args = arguments;
 		if ( applicator && argsArray && api.Class.applicator === applicator ) {
 			args = argsArray;
 			$.extend( magic, this );
 		}
 		magic.initialize.apply( magic, args );
 		return magic;
+	};
+	/**
+	 * Creates a subclass of the class.
+	 *
+	 * @param  object protoProps  Properties to apply to the prototype.
+	 * @param  object staticProps Properties to apply directly to the class.
+	 * @return child              The subclass.
+	 */
+	api.Class.extend = function( protoProps, classProps ) {
+		var child = inherits( this, protoProps, classProps );
+		child.extend = this.extend;
+		return child;
 	};
 	api.Class.applicator = {};
 	api.Class.prototype.initialize = function() {};
 			proto = proto.constructor.__super__;
 		}
 		return false;
 	};
-	api.Class.extend = extend;
+	/**
+	 * An events manager object, offering the ability to bind to and trigger events.
-	/* =====================================================================
+	 *
-	 * Events mixin.
+	 * Used as a mixin.
-	 * ===================================================================== */
+	 */
 	api.Events = {
 		trigger: function( id ) {
 			if ( this.topics && this.topics[ id ] )
 				this.topics[ id ].fireWith( this, slice.call( arguments, 1 ) );
 			return this;
 		},
-		bind: function( id, callback ) {
+		bind: function( id ) {
 			this.topics = this.topics || {};
 			this.topics[ id ] = this.topics[ id ] || $.Callbacks();
 			this.topics[ id ].add.apply( this.topics[ id ], slice.call( arguments, 1 ) );
 			return this;
 		},
-		unbind: function( id, callback ) {
+		unbind: function( id ) {
 			if ( this.topics && this.topics[ id ] )
 				this.topics[ id ].remove.apply( this.topics[ id ], slice.call( arguments, 1 ) );
 			return this;
 		}
 	};
-	/* =====================================================================
+	/**
 	 * Observable values that support two-way binding.
-	 * ===================================================================== */
+	 *
+	 * @constuctor
+	 */
 	api.Value = api.Class.extend({
 		initialize: function( initial, options ) {
 			this._value = initial; // @todo: potentially change this to a this.set() call.
 			this.callbacks = $.Callbacks();
+			this._dirty = false;
 			$.extend( this, options || {} );
 			this.set = $.proxy( this.set, this );
 		},
 			to = this._setter.apply( this, arguments );
 			to = this.validate( to );
 			// Bail if the sanitized value is null or unchanged.
-			if ( null === to || this._value === to )
+			if ( null === to || _.isEqual( from, to ) ) {
 				return this;
+			}
 			this._value = to;
+			this._dirty = true;
 			this.callbacks.fireWith( this, [ to, from ] );
 			return this;
 		},
 		validate: function( value ) {
 			return value;
 		},
-		bind: function( callback ) {
+		bind: function() {
 			this.callbacks.add.apply( this.callbacks, arguments );
 			return this;
 		},
-		unbind: function( callback ) {
+		unbind: function() {
 			this.callbacks.remove.apply( this.callbacks, arguments );
 			return this;
 		},
 		link: function() { // values*
 			});
 			return this;
 		}
 	});
-	/* =====================================================================
+	/**
 	 * A collection of observable values.
-	 * ===================================================================== */
+	 *
+	 * @constuctor
+	 * @augments wp.customize.Class
+	 * @mixes wp.customize.Events
+	 */
 	api.Values = api.Class.extend({
 		defaultConstructor: api.Value,
 		initialize: function( options ) {
 			$.extend( this, options || {} );
 		}
 	});
 	$.extend( api.Values.prototype, api.Events );
-	/* =====================================================================
-	 * An observable value that syncs with an element.
+	/**
-	 *
+	 * Cast a string to a jQuery collection if it isn't already.
-	 * Handles inputs, selects, and textareas by default.
+	 *
-	 * ===================================================================== */
+	 * @param {string|jQuery collection} element
+	 */
 	api.ensure = function( element ) {
 		return typeof element == 'string' ? $( element ) : element;
 	};
+	/**
+	 * An observable value that syncs with an element.
+	 *
+	 * Handles inputs, selects, and textareas by default.
+	 *
+	 * @constuctor
+	 * @augments wp.customize.Value
+	 * @augments wp.customize.Class
+	 */
 	api.Element = api.Value.extend({
 		initialize: function( element, options ) {
 			var self = this,
 				synchronizer = api.Element.synchronizer.html,
 				type, update, refresh;
 				this.events += 'change';
 				synchronizer = api.Element.synchronizer.val;
 				if ( this.element.is('input') ) {
 					type = this.element.prop('type');
-					if ( api.Element.synchronizer[ type ] )
+					if ( api.Element.synchronizer[ type ] ) {
 						synchronizer = api.Element.synchronizer[ type ];
-					if ( 'text' === type || 'password' === type )
+					}
+					if ( 'text' === type || 'password' === type ) {
 						this.events += ' keyup';
+					} else if ( 'range' === type ) {
+						this.events += ' input propertychange';
+					}
 				} else if ( this.element.is('textarea') ) {
 					this.events += ' keyup';
 				}
 			}
 		update: function() {}
 	});
 	api.Element.synchronizer = {};
-	$.each( [ 'html', 'val' ], function( i, method ) {
+	$.each( [ 'html', 'val' ], function( index, method ) {
 		api.Element.synchronizer[ method ] = {
 			update: function( to ) {
 				this.element[ method ]( to );
 			},
 			refresh: function() {
 		refresh: function() {
 			return this.element.filter( ':checked' ).val();
 		}
 	};
-	/* =====================================================================
+	$.support.postMessage = !! window.postMessage;
+	/**
 	 * Messenger for postMessage.
-	 * ===================================================================== */
+	 *
+	 * @constuctor
-	$.support.postMessage = !! window.postMessage;
+	 * @augments wp.customize.Class
+	 * @mixes wp.customize.Events
+	 */
 	api.Messenger = api.Class.extend({
+		/**
+		 * Create a new Value.
+		 *
+		 * @param  {string} key     Unique identifier.
+		 * @param  {mixed}  initial Initial value.
+		 * @param  {mixed}  options Options hash. Optional.
+		 * @return {Value}          Class instance of the Value.
+		 */
 		add: function( key, initial, options ) {
 			return this[ key ] = new api.Value( initial, options );
 		},
 		/**
 			$.extend( this, options || {} );
 			this.add( 'channel', params.channel );
 			this.add( 'url', params.url || '' );
-			this.add( 'targetWindow', params.targetWindow || defaultTarget );
 			this.add( 'origin', this.url() ).link( this.url ).setter( function( to ) {
 				return to.replace( /([^:]+:\/\/[^\/]+).*/, '$1' );
 			});
+			// 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;
+				to = this._setter.apply( this, arguments );
+				to = this.validate( to );
+				if ( null === to || from === to ) {
+					return this;
+				}
+				this._value = to;
+				this._dirty = true;
+				this.callbacks.fireWith( this, [ to, from ] );
+				return this;
+			};
+			// 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.
 			//
 			// This will prevent every Messenger's receive function from being
 			// Check to make sure the origin is valid.
 			if ( this.origin() && event.origin !== this.origin() )
 				return;
+			// 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' )
 				return;
 	});
 	// Add the Events mixin to api.Messenger.
 	$.extend( api.Messenger.prototype, api.Events );
-	/* =====================================================================
+	// Core customize object.
-	 * Core customize object.
-	 * ===================================================================== */
 	api = $.extend( new api.Values(), api );
 	api.get = function() {
 		var result = {};
 		this.each( function( obj, key ) {
 		});
 		return result;
 	};
-	// Expose the API to the world.
+	// Expose the API publicly on window.wp.customize
 	exports.customize = api;
 })( wp, jQuery );

enmi-conf.org