prototype.js

电子商城

/*  Prototype JavaScript framework, version 1.4.0
 *  (c) 2005 Sam Stephenson <[e-mail]>
 *
 *  Prototype is freely distributable under the terms of an MIT-style license.
 *  For details, see the Prototype web site: http://prototype.conio.net/
 *
/*--------------------------------------------------------------------------*/
/* 
prototype-1.4.0注释版本 by http://www.x2blog.cn/supNate/

prototype框架最早是出于方便Ruby开发人员进行JavaScript开发所构建的，从这个版本上更加体现的淋漓尽致。
比起1.3.1版本，1.4.0中的编程思想和技巧更加令人拍案叫绝，对于开拓编程思路很有帮助。

该版本主要加入了迭代器思想，也是Ruby中的一个核心概念，从而使用此框架进行JavaScript开发几乎可以避免for循环的使用。
/*----------------------------------------------------------------------------------------------------*/


/*
定义prototype对象，告知版本信息，有利于程序的自动检测
ScriptFragment是正则表达式，用于捕获字符串中的<script>标记及其中的内容
emptyFunction:空函数
K：返回参数自身的函数，后面会有应用

在这里使用了直接定义对象的语法：
var obj={
	property1:value1,
	property2:value2,
	....
}
后面会经常用到
*/
var Prototype = {
  Version: '1.4.0',
  ScriptFragment: '(?:<script.*?>)((\n|\r|.)*?)(?:<\/script>)',

  emptyFunction: function() {},
  K: function(x) {return x}
}

/*
定义创建类的模式，使用此模式创建的类能够实现构造函数
其中initialize是一个抽象方法，apply使得能对其保持参数。
如果直接调用this.initialize(arguments)，则整个参数数组作为了一个参数。
*/
var Class = {
  create: function() {
    return function() {
      this.initialize.apply(this, arguments);
    }
  }
}

//表示命名空间或者抽象类的东西，使代码逻辑更加清楚
var Abstract = new Object();

/*
将source的所有属性复制到destination
例如：
var a={};
var b={p:1};
Object.extent(a,b);
alert(a.p);
可以看到a具有了属性p且值等于1。
如果属性相同则覆盖。
*/
Object.extend = function(destination, source) {
  for (property in source) {
    destination[property] = source[property];
  }
  return destination;
}
/*
相比prototype-1.3.1这里少了下面的函数：
Object.prototype.extend = function(object) {
  return Object.extend.apply(this, [this, object]);
}
所以原先基于1.3.1框架的js脚本升级到1.4.0时会产生兼容性问题。只要在1.4.0里加上上述函数即可。
去掉的原因大概因为为每个object都增加extend方法显的很浪费，毕竟95％的对象是不会用到的。
而且增加了extend方法也为反射枚举带来一定的麻烦，这从后面Hash对象的用法可以看到。
*/

/*
将对象转换为字符串，这里能够更详细一些，只要对象自定义了inspect函数。而不是原来对象的toString总是[object]。
例如后面对数组定义了inspect函数，使得
var arr=[1,2,3];
－》arr.inspect()=="[1,2,3]";
*/
Object.inspect = function(object) {
  try {
    if (object == undefined) return 'undefined';
    if (object == null) return 'null';
    return object.inspect ? object.inspect() : object.toString();
  } catch (e) {
    if (e instanceof RangeError) return '...';
    throw e;
  }
}

/*
一个很重要的方法，能够将函数绑定到某个对象运行
和1.3.1版本相比，原来不能在绑定的时候就添加参数，而现在可以。
例如：
var obj1={p:"obj1"};
var obj2={
	p:"obj2",
	method:function(arg){
		alert(arg+this.p);
	}
}
obj2.method("this is ");//显示“this is obj2”；
obj2.method.bind(obj1,"now this is ");//显示“now this is obj1”；
最后一句在1.3.1中必须写为：
obj2.method.bind(obj1)("now this is ");//显示“now this is obj1”；
*/
Function.prototype.bind = function() {
  var __method = this, args = $A(arguments), object = args.shift();
  return function() {
    return __method.apply(object, args.concat($A(arguments)));
  }
}
/*
将函数作为对象的事件监听器，这样可以产生独立而且通用的事件处理程序，例如要对单击事件进行处理：
function clickHandler(element){
	//处理element的单击事件
}

假设有节点node1，则：
node1.onclick=function(){
	clickHandler.bindAsEventListener(this)(event||window.event);
}
*/
Function.prototype.bindAsEventListener = function(object) {
  var __method = this;
  return function(event) {
    return __method.call(object, event || window.event);
  }
}

/*
所有的数字类型都是Number类的实例，下面就是给Number类定义一些方法
*/
Object.extend(Number.prototype, {
	/*
	将数字转换为颜色的形式
	*/
  toColorPart: function() {
    var digits = this.toString(16);
    if (this < 16) return '0' + digits;
    return digits;
  },
	//加1
  succ: function() {
    return this + 1;
  },
	/*
	执行指定次数的循环，例如获取10个随机数
	var ran=[]
	var c=10;
	c.times(function(){
		ran.push(Math.random());
	});
	$R是ObjectRange对象的快捷创建形式，后面会有介绍。
	*/
  times: function(iterator) {
    $R(0, this, true).each(iterator);
    return this;
  }
});

/*
Try对象，仅有一个方法these
*/
var Try = {
	/*
	根据参数指定的函数进行调用，返回第一个调用成功的值
	在后面跨浏览器建立XMLHttpRequest对象时就用到了。
	如果所有都不成功则返回undefined
	*/
  these: function() {
    var returnValue;

    for (var i = 0; i < arguments.length; i++) {
      var lambda = arguments[i];
      try {
        returnValue = lambda();
        break;
      } catch (e) {}
    }

    return returnValue;
  }
}

/*--------------------------------------------------------------------------*/


/*
定时器类，比起window.setInterval函数，该类能够使得回调函数不会被并发调用，见onTimerEvent的注释。
*/
var PeriodicalExecuter = Class.create();
PeriodicalExecuter.prototype = {
	/*
	构造函数，指定回调函数和执行频率，单位为秒
	*/
  initialize: function(callback, frequency) {
    this.callback = callback;
    this.frequency = frequency;
    this.currentlyExecuting = false;
    this.registerCallback();
  },
	/*
	开始执行定时器，一般不要显示调用，在构造函数中被调用
	注意这里写为：
	this.onTimerEvent.bind(this)
	如果写为：
	this.onTimerEvent
	则onTimerEvent中的函数的this指针将指向window对象，即setInterval的默认对象。
	*/
  registerCallback: function() {
    setInterval(this.onTimerEvent.bind(this), this.frequency * 1000);
  },
	/*
	相当于回调函数的一个代理。
	在传统的setInterval函数中，时间一到，便强制执行回调函数，而这里加入了currentlyExecuting属性判断，
	则如果callback函数的执行时间超过了一个时间片，则阻止其被重复执行。
	*/
  onTimerEvent: function() {
    if (!this.currentlyExecuting) {
      try {
        this.currentlyExecuting = true;
        this.callback();
      } finally {
        this.currentlyExecuting = false;
      }
    }
  }
}

/*--------------------------------------------------------------------------*/
/*
很方便的一个快速链接函数，能够获得参数所指定的页面节点，如果有多个参数则返回数组。
参数的形式既可以是节点的id值，也可以是节点的引用，即$($("someId"))和$("someId")是等价的;
*/
function $() {
  var elements = new Array();

  for (var i = 0; i < arguments.length; i++) {
    var element = arguments[i];
    if (typeof element == 'string')
      element = document.getElementById(element);

    if (arguments.length == 1)
      return element;

    elements.push(element);
  }

  return elements;
}

/*
为字符串对象添加方法，和前面为Number添加方法的原理相同
*/
Object.extend(String.prototype, {
	/*
	将Html转换为纯文本，例如：
	var s="<font color='red'>hello</font>";
	s.stripTags()将得到“hello”。
	*/
  stripTags: function() {
    return this.replace(/<\/?[^>]+>/gi, '');
  },

  stripScripts: function() {
    return this.replace(new RegExp(Prototype.ScriptFragment, 'img'), '');
  },
	//提取字符串中的脚本，返回所有脚本内容组成的数组
  extractScripts: function() {
    var matchAll = new RegExp(Prototype.ScriptFragment, 'img');//先找到所有包括的代码标记
    var matchOne = new RegExp(Prototype.ScriptFragment, 'im');	//再对每个脚本删除标记
    return (this.match(matchAll) || []).map(function(scriptTag) {
      return (scriptTag.match(matchOne) || ['', ''])[1];
    });
  },
	//先提取字符串中的脚本块，再执行这些脚本
  evalScripts: function() {
    return this.extractScripts().map(eval);
  },
	/*
	利用浏览器本身的机制对Html字符串进行编码，例如将<转换为&lt;
	*/
  escapeHTML: function() {
    var div = document.createElement('div');
    var text = document.createTextNode(this);
    div.appendChild(text);
    return div.innerHTML;
  },
	/*
	对Html进行解码
	*/
  unescapeHTML: function() {
    var div = document.createElement('div');
    div.innerHTML = this.stripTags();
    return div.childNodes[0] ? div.childNodes[0].nodeValue : '';
  },
	//获取查询字符串数组，例如通过document.location.toQueryParams()就可以得到由键和值组成的哈希表（用对象表示）。
  toQueryParams: function() {
    var pairs = this.match(/^\??(.*)$/)[1].split('&');
    return pairs.inject({}, function(params, pairString) {
      var pair = pairString.split('=');
      params[pair[0]] = pair[1];
      return params;
    });
  },
	//将字符串转换为字符数组
  toArray: function() {
    return this.split('');
  },
	/*
	将用"-"连接的字符串骆驼化。例如：
	var s="background-color";
	alert(s.camelize());
	将得到“backgroundColor”。
	*/
  camelize: function() {
    var oStringList = this.split('-');
    if (oStringList.length == 1) return oStringList[0];

    var camelizedString = this.indexOf('-') == 0
      ? oStringList[0].charAt(0).toUpperCase() + oStringList[0].substring(1)
      : oStringList[0];

    for (var i = 1, len = oStringList.length; i < len; i++) {
      var s = oStringList[i];
      camelizedString += s.charAt(0).toUpperCase() + s.substring(1);
    }

    return camelizedString;
  },
	/*
	inspect是观察的意思。这里大概就是将字符串转换为可观察的形式。这里将转义字符写成转义前的字符串形式，
	例如：
	var s="abc\ndef";

	alert(s);
	将得到两行字符串，上一行是abc,下一行是def
	而
	alert(s.inspect());
	将得到abc\ndef
	即给字符串赋值时的形式，这和数组的inspect作用类似。
	*/
  inspect: function() {
    return "'" + this.replace('\\', '\\\\').replace("'", '\\\'') + "'";
  }
});

//做一个名称链接
String.prototype.parseQuery = String.prototype.toQueryParams;

//定义了两个异常对象，主要用于迭代控制
var $break    = new Object();
var $continue = new Object();

/*
这是一个非常Ruby的机制，事实上可以将Enumerable看作一个枚举接口，
而_each是必须实现的方法，只要实现了此方法的类，都可以调用接口类中的其他成员。
例如后面Array就实现了此接口，也是最典型的应用
*/
var Enumerable = {
	/*
	对可枚举对象的每个成员调用iterator（迭代器）方法，
	如果迭代器方法抛出$continue异常，则继续执行，如果抛出$break异常，则不再继续迭代
	
	其中调用了_each这个抽象方法，
	_each是由具体的继承于Enumerable的类实现的

	index计数器的作用是用于告诉迭代器当前执行到第几个元素，是迭代器可选实现的。
	*/
  each: function(iterator) {
    var index = 0;
    try {
      this._each(function(value) {
        try {
          iterator(value, index++);
        } catch (e) {
          if (e != $continue) throw e;
        }
      });
    } catch (e) {
      if (e != $break) throw e;
    }
  },
	/*
	判断枚举对象中的所有元素是否都能使得迭代器返回true。如果没有指定迭代器，则判断所有元素是否都对应于布尔类型的true
	如果所有都满足，则返回true；否则返回false；
	注意这里就使用了$break异常，用于实现“逻辑与”操作的短路效果
	另外值得注意的一个技巧是使用了!!将一个变量强制转换为布尔类型，可以参考：http://www.x2blog.cn/supNate/?tid=4669
	*/
all: function(iterator) {
var result = true;
this.each(function(value, index) {
result = result && !!(iterator || Prototype.K)(value, index);
if (!result) throw $break;
});
return result;
},
	/*
	判断枚举对象中的所有元素是否有满足指定迭代器的值（返回true），如果有则返回true，否则返回false
	其原理和all方法类似

	如果数组为空，仍然返回true，这一点有点匪夷所思。
	*/
  any: function(iterator) {
    var result = true;
    this.each(function(value, index) {
      if (result = !!(iterator || Prototype.K)(value, index))
        throw $break;
    });
    return result;
  },
	/*
	返回所有枚举元素通过迭代器执行的结果，作为数组返回
	*/
  collect: function(iterator) {
    var results = [];
    this.each(function(value, index) {
      results.push(iterator(value, index));
    });
    return results;
  },
	/*
	返回第一个能够使得迭代器返回true的枚举元素的值，如果没有true，则返回"undefined",即result未被赋值