cookies.js

/**
@Name: sb.cookies
@Author: Paul Visco
@Version: 1.3 07/08/08
@Description: Used to handle cookies - which can set values between client visits
*/
sb.cookies ={

	path : '/',
	domain : '',
	onlog : '',
	
	/**
	@Name: sb.cookies.get
	@Description: Used to get cookie values
	@Param: String name The name of the cookie who's value you are trying to get
	@Return: String Returns the value stored for the cookie or false if the cookie is not found
	@Example:
	sb.cookies.get('myCookie', 'paul');
	*/
	get : function(name){
		
		var i,n, parts = document.cookie.split(';');
		
		for(i=0;i<parts.length;i++){
			n = parts[i].split('=');
			n[0] = n[0].replace(/ /, "");
			
			if(name==n[0]){
				return unescape(n[1]);
			} 
		}
		return false;
	},
	
	/**
	@Name: sb.cookies.set
	@Description: Used to make the clients computer set a value as a cookie
	@Param: String name The name (key) of the cookie which will hold the valuee
	@Param: String value The value the cookie holds, set cookies are limited to <4k
	@Param: Days number The number of days to rememeber the value for. If not set they become session cookies and expire when the user closes the browser
	@Example:
	sb.cookies.set('name', 'paul');
	sb.cookies.set('name', 'paul', 30);
	
	*/
	
	set : function(name, value, days){
        
        var ck, date = new Date();
        var exp = '';
    
        if(days){
            date.setTime(date.getTime()+(days*24*60*60*1000));
            exp = '; expires='+date.toGMTString();
        }
                     
        ck=name+'=' + escape(value) + exp + '; path=' + sb.cookies.path + ';' + ' host=' + sb.cookies.domain;
        
        document.cookie = ck;
                    
    },
	
	/**
	@Name: sb.cookies.forget
	@Description: Alias for sb.cookies.clear to maintain backwards compat
	@Param: String name The name (key) of the cookie which will be forgotten
	@Example:
	sb.cookies.forget('myCookie');
	*/
	forget : function(name){
		return this.clear(name);
	},
        
        /**
	@Name: sb.cookies.unset
	@Description: Alias for sb.cookies.clear to maintain backwards compat
	@Param: String name The name (key) of the cookie which will be forgotten
	@Example:
	sb.cookies.forget('myCookie');
	*/
        unset : function(name){
		return this.clear(name);
	},
	
	/**
	@Name: sb.cookies.clear
	@Description: Used to make the clients computer forget a cookie
	@Param: String name The name (key) of the cookie which will be forgotten
	@Example:
	sb.cookies.clear('myCookie');
	*/
	clear : function(name){
		this.set(name, "", -1);
	},
	
	/**
	@Name: sb.cookies.forgetAll
	@Description: Forgets all cookies stored for your domain
	@Example:
	sb.cookies.forgetAll();
	*/
	forgetAll : function(){
		return this.clearAll();
	},
	
	/**
	@Name: sb.cookies.clearAll
	@Description: Clears all cookies stored for your domain
	@Example:
	sb.cookies.clearAll();
	*/
	clearAll : function(){
		var n,i,deleted =[], parts = document.cookie.split(';');
		for(i=0;i<parts.length;i++){
			n = parts[i].split('=');
			
			if(n[0] !== undefined){
				deleted.push(n[0]);
				this.set(n[0], "", -1);
			}
		}
	},
	
	/**
	@Name: sb.cookies.listAll
	@Description: Used Internally
	*/
	listAll : function(){
		var i, c, list=[], parts = document.cookie.split(';');
		
		for(i=0;i<parts.length;i++){
			c = parts[i].split('=');
			list.push(c[0].replace(/ /, ""));
		}
		
		return list;
	},
	
	typeOf : function(){
		return 'sb.cookies';
	}
	
};