cookie.md.svn-base

mooltools源码很不错的源码

Object: Cookie {#Cookie}
========================

提供浏览器cookies操作的功能类

### Credits:

- 基于Peter-Paul Koch [QuirksMode][]所写的函数

###	可选项: {#Cookie-options}

* domain   - (*string*: 默认为 false) Cookie所属的域
* path     - (*string*: 默认为 false) Cookie所属的路径
* duration - (*number*: 默认为 false) Cookie存活的天数. 如果设为false或0, 则该Cookie被视为会话Cookie,当浏览器关闭时将过期
* secure   - (*boolean*: 默认为 false) 存放的cookie信息只能在安全环境下才能访问

### 备注:

- 如果cookie要在不同的路径上共享, 则请设置[Cookie.options.domain][]



Cookie 方法: write {#Cookie:write}
--------------------------------

向浏览器中写入一个cookie

###	语法:

	var myCookie = Cookie.write(key, value[, options]);

###	参数:

1. key     - (*string*) cookie的键(或名字)
2. value   - (*string*) cookie的值. 不能含有分号";"
3. options - (*mixed*, 可选) 参看[Cookie][]

###	返回值:

* (*object*) 一个含有给出的可选项,键,值的对象(该对象可作为使用Cookie.remove删除cookie时的参数)

###	示例:

会话Cookie(未设置保存时间):

	var myCookie = Cookie.write('username', 'Harald');

Cookie存活1天:

	var myCookie  = Cookie.write('username', 'JackBauer', {duration: 1});



Cookie 方法: read {#Cookie:read}
--------------------------------

从Cookie中读取一个值


###	语法:

	var myCookie = Cookie.read(name);

###	参数:

1. name - (*string*) 要在Cookie读取的值的键名

###	返回值:

* (*mixed*) 如果找到对应的值,则返回该值;否则返回false

###	示例:

	Cookie.read("username");



Cookie 方法: dispose {#Cookie:dispose}
--------------------------------------

从浏览器中删除cookie

###	语法:

	var oldCookie = Cookie.dispose(cookie[, options]);

###	参数:

1. name  - (*string*) 要删除的cookie的名字; 或者是先前得到的Cookie对象实例
2. options - (*object*, 可选) 参看[Cookie][]的可选项

###	示例:

删除Cookie(根据名字):

	Cookie.dispose('username');

删除Cookie(根据Cookie对象实例):

	var myCookie = Cookie.write('username', 'Aaron', {domain: 'mootools.net'});
	
	if (Cookie.read('username') == 'Aaron') { 
		Cookie.dispose(myCookie); 
	}



[Cookie]: #Cookie
[Cookie.options]: #Cookie-options
[Cookie.options.domain]: #Cookie-options
[QuirksMode]: http://www.quirksmode.org