hash.cookie.md

一款开源强大的javascript控件

Class: Hash.Cookie {#Hash-Cookie}
=================================

使用Hash的操作方式来对Cookie进行管理


### 继承:

- [Hash][]

### 语法:

	var myHashCookie = new Hash.Cookie(name[, options]);

### 参数:

1. name    - (*string*) cookie的名称
2. options - (*object*) [Cookie][]的所有可选项, 以及如下可选项:

#### 可选项:

1. autoSave - (*boolean*: 默认为true) 是否每次操作后都对Cookie进行实际保存

### 返回值:

* (*object*) Hash.Cookie实例

### 示例:

	var fruits = new Hash.Cookie('myCookieName', {duration: 3600});
	fruits.extend({
		'lemon': 'yellow',
		'apple': 'red'
	});
	
	fruits.set('melon', 'green');
	fruits.get('lemon'); // 返回: yellow


	// ... 在另一个页面中 ... 已有的cookie值将自动装载:
	var fruits = new Hash.Cookie('myCookieName', {duration: 365});
	fruits.get('melon'); // 返回: green

	fruits.erase(); // 删除cookie

### 备注:

- Hash.Cookie中可访问Hash所提供的所有方法. 如果autoSave设为true, 则每个方法调用都将对cookie进行实际保存
- Cookies存在4kb的大小限制(4096 bytes). 因此请注意您的Hash大小
- 在Hash.Cookie上调用Hash的方法时, 通常返回值是Hash中该方法所定义的返回值; 除非当Cookie的大小超过了大小限制, 则返回值将是false.
- 如果打算使用比较大的Cookies, 则建议将autoSave设置为false, 并在每次调用save方法后自行检查它是否已保存成功
- 新建Hash.Cookie实例时, 将从浏览器中自动查找指定名称的Cookie, 并加载数据到Hash中

### 另参考:

- [Hash][]



Hash.Cookie 方法: save {#Hash-Cookie:save}
--------------------------------------------

将Hash数据保存到cookie中. 

如果Hash数据内容为空, 则将会把该cookie删掉.

###	语法:

	myHashCookie.save();

###	返回值:

* (*boolean*) 如果cookie内容大于4kb, 则返回值false; 否则返回true

###	示例:

	var login = new Hash.Cookie('userstatus', {autoSave: false});

	login.extend({
		'username': 'John',
		'credentials': [4, 7, 9]
	});
	login.set('last_message', 'User logged in!');

	login.save();



Hash.Cookie 方法: load {#Hash-Cookie:load}
--------------------------------------------

将浏览器中的cookie加载到Hash中

###	语法:

	myHashCookie.load();

###	返回值:

* (*object*) 主调Hash.Cookie实例

###	示例:

	var myHashCookie = new Hash.Cookie('myCookie');

	function(){
		myHashCookie.load();
		if(!myHashCookie.length) {
			alert('Cookie Monster must of eaten it!');
		}
	}.periodical(5000);



[Hash]: /Native/Hash/#Hash
[Cookie]: /Utilities/Cookie